blob: be03e2b2787cc285885058f394a63ddacb746d41 [file] [log] [blame]
Dave Houlton51653902018-06-22 17:32:13 -06001/* Copyright (c) 2015-2018 The Khronos Group Inc.
2 * Copyright (c) 2015-2018 Valve Corporation
3 * Copyright (c) 2015-2018 LunarG, Inc.
4 * Copyright (C) 2015-2018 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
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060025#include "descriptor_sets.h"
John Zulaufd47d0612018-02-16 13:00:34 -070026#include "hash_vk_types.h"
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060027#include "vk_enum_string_helper.h"
28#include "vk_safe_struct.h"
Jeff Bolzfdf96072018-04-10 14:32:18 -050029#include "vk_typemap_helper.h"
Tobin Ehlisc8266452017-04-07 12:20:30 -060030#include "buffer_validation.h"
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060031#include <sstream>
Mark Lobodzinski2eee5d82016-12-02 15:33:18 -070032#include <algorithm>
John Zulauf1f8174b2018-02-16 12:58:37 -070033#include <memory>
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060034
Jeff Bolzfdf96072018-04-10 14:32:18 -050035// ExtendedBinding collects a VkDescriptorSetLayoutBinding and any extended
36// state that comes from a different array/structure so they can stay together
37// while being sorted by binding number.
38struct ExtendedBinding {
39 ExtendedBinding(const VkDescriptorSetLayoutBinding *l, VkDescriptorBindingFlagsEXT f) : layout_binding(l), binding_flags(f) {}
40
41 const VkDescriptorSetLayoutBinding *layout_binding;
42 VkDescriptorBindingFlagsEXT binding_flags;
43};
44
John Zulauf508d13a2018-01-05 15:10:34 -070045struct BindingNumCmp {
Jeff Bolzfdf96072018-04-10 14:32:18 -050046 bool operator()(const ExtendedBinding &a, const ExtendedBinding &b) const {
47 return a.layout_binding->binding < b.layout_binding->binding;
John Zulauf508d13a2018-01-05 15:10:34 -070048 }
49};
50
John Zulaufd47d0612018-02-16 13:00:34 -070051using DescriptorSetLayoutDef = cvdescriptorset::DescriptorSetLayoutDef;
52using DescriptorSetLayoutId = cvdescriptorset::DescriptorSetLayoutId;
53
John Zulauf34ebf272018-02-16 13:08:47 -070054// Canonical dictionary of DescriptorSetLayoutDef (without any handle/device specific information)
55cvdescriptorset::DescriptorSetLayoutDict descriptor_set_layout_dict;
John Zulaufd47d0612018-02-16 13:00:34 -070056
Shannon McPhersonc06c33d2018-06-28 17:21:12 -060057DescriptorSetLayoutId GetCanonicalId(const VkDescriptorSetLayoutCreateInfo *p_create_info) {
John Zulauf34ebf272018-02-16 13:08:47 -070058 return descriptor_set_layout_dict.look_up(DescriptorSetLayoutDef(p_create_info));
John Zulaufd47d0612018-02-16 13:00:34 -070059}
John Zulauf34ebf272018-02-16 13:08:47 -070060
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060061// Construct DescriptorSetLayout instance from given create info
John Zulauf48a6a702017-12-22 17:14:54 -070062// Proactively reserve and resize as possible, as the reallocation was visible in profiling
John Zulauf1f8174b2018-02-16 12:58:37 -070063cvdescriptorset::DescriptorSetLayoutDef::DescriptorSetLayoutDef(const VkDescriptorSetLayoutCreateInfo *p_create_info)
64 : flags_(p_create_info->flags), binding_count_(0), descriptor_count_(0), dynamic_descriptor_count_(0) {
Jeff Bolzfdf96072018-04-10 14:32:18 -050065 const auto *flags_create_info = lvl_find_in_chain<VkDescriptorSetLayoutBindingFlagsCreateInfoEXT>(p_create_info->pNext);
66
John Zulauf48a6a702017-12-22 17:14:54 -070067 binding_type_stats_ = {0, 0, 0};
Jeff Bolzfdf96072018-04-10 14:32:18 -050068 std::set<ExtendedBinding, BindingNumCmp> sorted_bindings;
John Zulauf508d13a2018-01-05 15:10:34 -070069 const uint32_t input_bindings_count = p_create_info->bindingCount;
70 // Sort the input bindings in binding number order, eliminating duplicates
71 for (uint32_t i = 0; i < input_bindings_count; i++) {
Jeff Bolzfdf96072018-04-10 14:32:18 -050072 VkDescriptorBindingFlagsEXT flags = 0;
73 if (flags_create_info && flags_create_info->bindingCount == p_create_info->bindingCount) {
74 flags = flags_create_info->pBindingFlags[i];
75 }
76 sorted_bindings.insert(ExtendedBinding(p_create_info->pBindings + i, flags));
John Zulaufb6d71202017-12-22 16:47:09 -070077 }
78
79 // Store the create info in the sorted order from above
Tobin Ehlisa3525e02016-11-17 10:50:52 -070080 std::map<uint32_t, uint32_t> binding_to_dyn_count;
John Zulauf508d13a2018-01-05 15:10:34 -070081 uint32_t index = 0;
82 binding_count_ = static_cast<uint32_t>(sorted_bindings.size());
83 bindings_.reserve(binding_count_);
Jeff Bolzfdf96072018-04-10 14:32:18 -050084 binding_flags_.reserve(binding_count_);
John Zulauf508d13a2018-01-05 15:10:34 -070085 binding_to_index_map_.reserve(binding_count_);
86 for (auto input_binding : sorted_bindings) {
87 // Add to binding and map, s.t. it is robust to invalid duplication of binding_num
Jeff Bolzfdf96072018-04-10 14:32:18 -050088 const auto binding_num = input_binding.layout_binding->binding;
John Zulauf508d13a2018-01-05 15:10:34 -070089 binding_to_index_map_[binding_num] = index++;
Jeff Bolzfdf96072018-04-10 14:32:18 -050090 bindings_.emplace_back(input_binding.layout_binding);
John Zulauf508d13a2018-01-05 15:10:34 -070091 auto &binding_info = bindings_.back();
Jeff Bolzfdf96072018-04-10 14:32:18 -050092 binding_flags_.emplace_back(input_binding.binding_flags);
John Zulauf508d13a2018-01-05 15:10:34 -070093
John Zulaufb6d71202017-12-22 16:47:09 -070094 descriptor_count_ += binding_info.descriptorCount;
95 if (binding_info.descriptorCount > 0) {
96 non_empty_bindings_.insert(binding_num);
Tobin Ehlis9637fb22016-12-12 15:59:34 -070097 }
John Zulaufb6d71202017-12-22 16:47:09 -070098
99 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
100 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC) {
101 binding_to_dyn_count[binding_num] = binding_info.descriptorCount;
102 dynamic_descriptor_count_ += binding_info.descriptorCount;
John Zulauf48a6a702017-12-22 17:14:54 -0700103 binding_type_stats_.dynamic_buffer_count++;
104 } else if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER) ||
105 (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER)) {
106 binding_type_stats_.non_dynamic_buffer_count++;
107 } else {
108 binding_type_stats_.image_sampler_count++;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600109 }
110 }
Tobin Ehlis9637fb22016-12-12 15:59:34 -0700111 assert(bindings_.size() == binding_count_);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500112 assert(binding_flags_.size() == binding_count_);
Tobin Ehlis9637fb22016-12-12 15:59:34 -0700113 uint32_t global_index = 0;
John Zulaufb6d71202017-12-22 16:47:09 -0700114 binding_to_global_index_range_map_.reserve(binding_count_);
115 // Vector order is finalized so create maps of bindings to descriptors and descriptors to indices
Tobin Ehlis9637fb22016-12-12 15:59:34 -0700116 for (uint32_t i = 0; i < binding_count_; ++i) {
117 auto binding_num = bindings_[i].binding;
John Zulaufc483f442017-12-15 14:02:06 -0700118 auto final_index = global_index + bindings_[i].descriptorCount;
119 binding_to_global_index_range_map_[binding_num] = IndexRange(global_index, final_index);
John Zulaufb6d71202017-12-22 16:47:09 -0700120 if (final_index != global_index) {
121 global_start_to_index_map_[global_index] = i;
122 }
John Zulaufc483f442017-12-15 14:02:06 -0700123 global_index = final_index;
Tobin Ehlis9637fb22016-12-12 15:59:34 -0700124 }
John Zulaufb6d71202017-12-22 16:47:09 -0700125
Tobin Ehlisa3525e02016-11-17 10:50:52 -0700126 // Now create dyn offset array mapping for any dynamic descriptors
127 uint32_t dyn_array_idx = 0;
John Zulaufb6d71202017-12-22 16:47:09 -0700128 binding_to_dynamic_array_idx_map_.reserve(binding_to_dyn_count.size());
Tobin Ehlisa3525e02016-11-17 10:50:52 -0700129 for (const auto &bc_pair : binding_to_dyn_count) {
130 binding_to_dynamic_array_idx_map_[bc_pair.first] = dyn_array_idx;
131 dyn_array_idx += bc_pair.second;
132 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600133}
Tobin Ehlis154c2692016-10-25 09:36:53 -0600134
John Zulaufd47d0612018-02-16 13:00:34 -0700135size_t cvdescriptorset::DescriptorSetLayoutDef::hash() const {
136 hash_util::HashCombiner hc;
137 hc << flags_;
138 hc.Combine(bindings_);
John Zulauf223b69d2018-11-09 16:00:59 -0700139 hc.Combine(binding_flags_);
John Zulaufd47d0612018-02-16 13:00:34 -0700140 return hc.Value();
141}
142//
143
John Zulauf1f8174b2018-02-16 12:58:37 -0700144// Return valid index or "end" i.e. binding_count_;
145// The asserts in "Get" are reduced to the set where no valid answer(like null or 0) could be given
146// Common code for all binding lookups.
147uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetIndexFromBinding(uint32_t binding) const {
148 const auto &bi_itr = binding_to_index_map_.find(binding);
149 if (bi_itr != binding_to_index_map_.cend()) return bi_itr->second;
150 return GetBindingCount();
151}
152VkDescriptorSetLayoutBinding const *cvdescriptorset::DescriptorSetLayoutDef::GetDescriptorSetLayoutBindingPtrFromIndex(
153 const uint32_t index) const {
154 if (index >= bindings_.size()) return nullptr;
155 return bindings_[index].ptr();
156}
157// Return descriptorCount for given index, 0 if index is unavailable
158uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetDescriptorCountFromIndex(const uint32_t index) const {
159 if (index >= bindings_.size()) return 0;
160 return bindings_[index].descriptorCount;
161}
162// For the given index, return descriptorType
163VkDescriptorType cvdescriptorset::DescriptorSetLayoutDef::GetTypeFromIndex(const uint32_t index) const {
164 assert(index < bindings_.size());
165 if (index < bindings_.size()) return bindings_[index].descriptorType;
166 return VK_DESCRIPTOR_TYPE_MAX_ENUM;
167}
168// For the given index, return stageFlags
169VkShaderStageFlags cvdescriptorset::DescriptorSetLayoutDef::GetStageFlagsFromIndex(const uint32_t index) const {
170 assert(index < bindings_.size());
171 if (index < bindings_.size()) return bindings_[index].stageFlags;
172 return VkShaderStageFlags(0);
173}
Jeff Bolzfdf96072018-04-10 14:32:18 -0500174// Return binding flags for given index, 0 if index is unavailable
175VkDescriptorBindingFlagsEXT cvdescriptorset::DescriptorSetLayoutDef::GetDescriptorBindingFlagsFromIndex(
176 const uint32_t index) const {
177 if (index >= binding_flags_.size()) return 0;
178 return binding_flags_[index];
179}
John Zulauf1f8174b2018-02-16 12:58:37 -0700180
181// For the given global index, return index
182uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetIndexFromGlobalIndex(const uint32_t global_index) const {
183 auto start_it = global_start_to_index_map_.upper_bound(global_index);
184 uint32_t index = binding_count_;
185 assert(start_it != global_start_to_index_map_.cbegin());
186 if (start_it != global_start_to_index_map_.cbegin()) {
187 --start_it;
188 index = start_it->second;
189#ifndef NDEBUG
190 const auto &range = GetGlobalIndexRangeFromBinding(bindings_[index].binding);
191 assert(range.start <= global_index && global_index < range.end);
192#endif
193 }
194 return index;
195}
196
197// For the given binding, return the global index range
198// As start and end are often needed in pairs, get both with a single hash lookup.
199const cvdescriptorset::IndexRange &cvdescriptorset::DescriptorSetLayoutDef::GetGlobalIndexRangeFromBinding(
200 const uint32_t binding) const {
201 assert(binding_to_global_index_range_map_.count(binding));
202 // In error case max uint32_t so index is out of bounds to break ASAP
203 const static IndexRange kInvalidRange = {0xFFFFFFFF, 0xFFFFFFFF};
204 const auto &range_it = binding_to_global_index_range_map_.find(binding);
205 if (range_it != binding_to_global_index_range_map_.end()) {
206 return range_it->second;
207 }
208 return kInvalidRange;
209}
210
211// For given binding, return ptr to ImmutableSampler array
212VkSampler const *cvdescriptorset::DescriptorSetLayoutDef::GetImmutableSamplerPtrFromBinding(const uint32_t binding) const {
213 const auto &bi_itr = binding_to_index_map_.find(binding);
214 if (bi_itr != binding_to_index_map_.end()) {
215 return bindings_[bi_itr->second].pImmutableSamplers;
216 }
217 return nullptr;
218}
219// Move to next valid binding having a non-zero binding count
220uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetNextValidBinding(const uint32_t binding) const {
221 auto it = non_empty_bindings_.upper_bound(binding);
222 assert(it != non_empty_bindings_.cend());
223 if (it != non_empty_bindings_.cend()) return *it;
224 return GetMaxBinding() + 1;
225}
226// For given index, return ptr to ImmutableSampler array
227VkSampler const *cvdescriptorset::DescriptorSetLayoutDef::GetImmutableSamplerPtrFromIndex(const uint32_t index) const {
228 if (index < bindings_.size()) {
229 return bindings_[index].pImmutableSamplers;
230 }
231 return nullptr;
232}
233// If our layout is compatible with rh_ds_layout, return true,
234// else return false and fill in error_msg will description of what causes incompatibility
235bool cvdescriptorset::DescriptorSetLayout::IsCompatible(DescriptorSetLayout const *const rh_ds_layout,
236 std::string *error_msg) const {
237 // Trivial case
238 if (layout_ == rh_ds_layout->GetDescriptorSetLayout()) return true;
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600239 if (GetLayoutDef() == rh_ds_layout->GetLayoutDef()) return true;
John Zulaufd47d0612018-02-16 13:00:34 -0700240 bool detailed_compat_check =
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600241 GetLayoutDef()->IsCompatible(layout_, rh_ds_layout->GetDescriptorSetLayout(), rh_ds_layout->GetLayoutDef(), error_msg);
John Zulaufd47d0612018-02-16 13:00:34 -0700242 // The detailed check should never tell us mismatching DSL are compatible
243 assert(!detailed_compat_check);
244 return detailed_compat_check;
John Zulauf1f8174b2018-02-16 12:58:37 -0700245}
246
John Zulaufdf3c5c12018-03-06 16:44:43 -0700247// Do a detailed compatibility check of this def (referenced by ds_layout), vs. the rhs (layout and def)
248// Should only be called if trivial accept has failed, and in that context should return false.
John Zulauf1f8174b2018-02-16 12:58:37 -0700249bool cvdescriptorset::DescriptorSetLayoutDef::IsCompatible(VkDescriptorSetLayout ds_layout, VkDescriptorSetLayout rh_ds_layout,
250 DescriptorSetLayoutDef const *const rh_ds_layout_def,
251 std::string *error_msg) const {
252 if (descriptor_count_ != rh_ds_layout_def->descriptor_count_) {
253 std::stringstream error_str;
254 error_str << "DescriptorSetLayout " << ds_layout << " has " << descriptor_count_ << " descriptors, but DescriptorSetLayout "
255 << rh_ds_layout << ", which comes from pipelineLayout, has " << rh_ds_layout_def->descriptor_count_
256 << " descriptors.";
257 *error_msg = error_str.str();
258 return false; // trivial fail case
259 }
John Zulaufd47d0612018-02-16 13:00:34 -0700260
John Zulauf1f8174b2018-02-16 12:58:37 -0700261 // Descriptor counts match so need to go through bindings one-by-one
262 // and verify that type and stageFlags match
263 for (auto binding : bindings_) {
264 // TODO : Do we also need to check immutable samplers?
265 // VkDescriptorSetLayoutBinding *rh_binding;
266 if (binding.descriptorCount != rh_ds_layout_def->GetDescriptorCountFromBinding(binding.binding)) {
267 std::stringstream error_str;
268 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << ds_layout << " has a descriptorCount of "
269 << binding.descriptorCount << " but binding " << binding.binding << " for DescriptorSetLayout "
270 << rh_ds_layout << ", which comes from pipelineLayout, has a descriptorCount of "
271 << rh_ds_layout_def->GetDescriptorCountFromBinding(binding.binding);
272 *error_msg = error_str.str();
273 return false;
274 } else if (binding.descriptorType != rh_ds_layout_def->GetTypeFromBinding(binding.binding)) {
275 std::stringstream error_str;
276 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << ds_layout << " is type '"
277 << string_VkDescriptorType(binding.descriptorType) << "' but binding " << binding.binding
278 << " for DescriptorSetLayout " << rh_ds_layout << ", which comes from pipelineLayout, is type '"
279 << string_VkDescriptorType(rh_ds_layout_def->GetTypeFromBinding(binding.binding)) << "'";
280 *error_msg = error_str.str();
281 return false;
282 } else if (binding.stageFlags != rh_ds_layout_def->GetStageFlagsFromBinding(binding.binding)) {
283 std::stringstream error_str;
284 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << ds_layout << " has stageFlags "
285 << binding.stageFlags << " but binding " << binding.binding << " for DescriptorSetLayout " << rh_ds_layout
286 << ", which comes from pipelineLayout, has stageFlags "
287 << rh_ds_layout_def->GetStageFlagsFromBinding(binding.binding);
288 *error_msg = error_str.str();
289 return false;
290 }
291 }
292 return true;
293}
294
295bool cvdescriptorset::DescriptorSetLayoutDef::IsNextBindingConsistent(const uint32_t binding) const {
296 if (!binding_to_index_map_.count(binding + 1)) return false;
297 auto const &bi_itr = binding_to_index_map_.find(binding);
298 if (bi_itr != binding_to_index_map_.end()) {
299 const auto &next_bi_itr = binding_to_index_map_.find(binding + 1);
300 if (next_bi_itr != binding_to_index_map_.end()) {
301 auto type = bindings_[bi_itr->second].descriptorType;
302 auto stage_flags = bindings_[bi_itr->second].stageFlags;
303 auto immut_samp = bindings_[bi_itr->second].pImmutableSamplers ? true : false;
Jeff Bolzfdf96072018-04-10 14:32:18 -0500304 auto flags = binding_flags_[bi_itr->second];
John Zulauf1f8174b2018-02-16 12:58:37 -0700305 if ((type != bindings_[next_bi_itr->second].descriptorType) ||
306 (stage_flags != bindings_[next_bi_itr->second].stageFlags) ||
Jeff Bolzfdf96072018-04-10 14:32:18 -0500307 (immut_samp != (bindings_[next_bi_itr->second].pImmutableSamplers ? true : false)) ||
308 (flags != binding_flags_[next_bi_itr->second])) {
John Zulauf1f8174b2018-02-16 12:58:37 -0700309 return false;
310 }
311 return true;
312 }
313 }
314 return false;
315}
316// Starting at offset descriptor of given binding, parse over update_count
317// descriptor updates and verify that for any binding boundaries that are crossed, the next binding(s) are all consistent
318// Consistency means that their type, stage flags, and whether or not they use immutable samplers matches
319// If so, return true. If not, fill in error_msg and return false
320bool cvdescriptorset::DescriptorSetLayoutDef::VerifyUpdateConsistency(uint32_t current_binding, uint32_t offset,
321 uint32_t update_count, const char *type,
322 const VkDescriptorSet set, std::string *error_msg) const {
323 // Verify consecutive bindings match (if needed)
324 auto orig_binding = current_binding;
325 // Track count of descriptors in the current_bindings that are remaining to be updated
326 auto binding_remaining = GetDescriptorCountFromBinding(current_binding);
327 // First, it's legal to offset beyond your own binding so handle that case
328 // Really this is just searching for the binding in which the update begins and adjusting offset accordingly
329 while (offset >= binding_remaining) {
330 // Advance to next binding, decrement offset by binding size
331 offset -= binding_remaining;
332 binding_remaining = GetDescriptorCountFromBinding(++current_binding);
333 }
334 binding_remaining -= offset;
335 while (update_count > binding_remaining) { // While our updates overstep current binding
336 // Verify next consecutive binding matches type, stage flags & immutable sampler use
337 if (!IsNextBindingConsistent(current_binding++)) {
338 std::stringstream error_str;
John Zulauf4e7bcb52018-11-02 10:46:30 -0600339 error_str << "Attempting " << type;
340 if (IsPushDescriptor()) {
341 error_str << " push descriptors";
342 } else {
343 error_str << " descriptor set " << set;
344 }
345 error_str << " binding #" << orig_binding << " with #" << update_count
John Zulauf1f8174b2018-02-16 12:58:37 -0700346 << " descriptors being updated but this update oversteps the bounds of this binding and the next binding is "
347 "not consistent with current binding so this update is invalid.";
348 *error_msg = error_str.str();
349 return false;
350 }
351 // For sake of this check consider the bindings updated and grab count for next binding
352 update_count -= binding_remaining;
353 binding_remaining = GetDescriptorCountFromBinding(current_binding);
354 }
355 return true;
356}
357
358// The DescriptorSetLayout stores the per handle data for a descriptor set layout, and references the common defintion for the
359// handle invariant portion
360cvdescriptorset::DescriptorSetLayout::DescriptorSetLayout(const VkDescriptorSetLayoutCreateInfo *p_create_info,
361 const VkDescriptorSetLayout layout)
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600362 : layout_(layout), layout_destroyed_(false), layout_id_(GetCanonicalId(p_create_info)) {}
John Zulauf1f8174b2018-02-16 12:58:37 -0700363
Tobin Ehlis154c2692016-10-25 09:36:53 -0600364// Validate descriptor set layout create info
Jeff Bolzfdf96072018-04-10 14:32:18 -0500365bool cvdescriptorset::DescriptorSetLayout::ValidateCreateInfo(
366 const debug_report_data *report_data, const VkDescriptorSetLayoutCreateInfo *create_info, const bool push_descriptor_ext,
367 const uint32_t max_push_descriptors, const bool descriptor_indexing_ext,
Jeff Bolze54ae892018-09-08 12:16:29 -0500368 const VkPhysicalDeviceDescriptorIndexingFeaturesEXT *descriptor_indexing_features,
369 const VkPhysicalDeviceInlineUniformBlockFeaturesEXT *inline_uniform_block_features,
370 const VkPhysicalDeviceInlineUniformBlockPropertiesEXT *inline_uniform_block_props) {
Tobin Ehlis154c2692016-10-25 09:36:53 -0600371 bool skip = false;
372 std::unordered_set<uint32_t> bindings;
John Zulauf0fdeab32018-01-23 11:27:35 -0700373 uint64_t total_descriptors = 0;
374
Jeff Bolzfdf96072018-04-10 14:32:18 -0500375 const auto *flags_create_info = lvl_find_in_chain<VkDescriptorSetLayoutBindingFlagsCreateInfoEXT>(create_info->pNext);
376
377 const bool push_descriptor_set = !!(create_info->flags & VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR);
John Zulauf0fdeab32018-01-23 11:27:35 -0700378 if (push_descriptor_set && !push_descriptor_ext) {
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 Houlton51653902018-06-22 17:32:13 -0600380 kVUID_Core_DrawState_ExtensionNotEnabled,
Mark Lobodzinskifb5a3e62018-04-13 10:46:48 -0600381 "Attempted to use %s in %s but its required extension %s has not been enabled.\n",
John Zulauf0fdeab32018-01-23 11:27:35 -0700382 "VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR", "VkDescriptorSetLayoutCreateInfo::flags",
383 VK_KHR_PUSH_DESCRIPTOR_EXTENSION_NAME);
384 }
385
Jeff Bolzfdf96072018-04-10 14:32:18 -0500386 const bool update_after_bind_set = !!(create_info->flags & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT);
387 if (update_after_bind_set && !descriptor_indexing_ext) {
388 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 -0600389 kVUID_Core_DrawState_ExtensionNotEnabled,
Jeff Bolzfdf96072018-04-10 14:32:18 -0500390 "Attemped to use %s in %s but its required extension %s has not been enabled.\n",
391 "VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT", "VkDescriptorSetLayoutCreateInfo::flags",
392 VK_EXT_DESCRIPTOR_INDEXING_EXTENSION_NAME);
393 }
394
John Zulauf0fdeab32018-01-23 11:27:35 -0700395 auto valid_type = [push_descriptor_set](const VkDescriptorType type) {
396 return !push_descriptor_set ||
Dave Houlton142c4cb2018-10-17 15:04:41 -0600397 ((type != VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC) && (type != VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC) &&
Jeff Bolze54ae892018-09-08 12:16:29 -0500398 (type != VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT));
John Zulauf0fdeab32018-01-23 11:27:35 -0700399 };
400
Jeff Bolzfdf96072018-04-10 14:32:18 -0500401 uint32_t max_binding = 0;
402
Tobin Ehlis154c2692016-10-25 09:36:53 -0600403 for (uint32_t i = 0; i < create_info->bindingCount; ++i) {
John Zulauf0fdeab32018-01-23 11:27:35 -0700404 const auto &binding_info = create_info->pBindings[i];
Jeff Bolzfdf96072018-04-10 14:32:18 -0500405 max_binding = std::max(max_binding, binding_info.binding);
406
John Zulauf0fdeab32018-01-23 11:27:35 -0700407 if (!bindings.insert(binding_info.binding).second) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600408 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 -0600409 "VUID-VkDescriptorSetLayoutCreateInfo-binding-00279",
410 "duplicated binding number in VkDescriptorSetLayoutBinding.");
Tobin Ehlis154c2692016-10-25 09:36:53 -0600411 }
John Zulauf0fdeab32018-01-23 11:27:35 -0700412 if (!valid_type(binding_info.descriptorType)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600413 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 -0600414 (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT)
415 ? "VUID-VkDescriptorSetLayoutCreateInfo-flags-02208"
416 : "VUID-VkDescriptorSetLayoutCreateInfo-flags-00280",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600417 "invalid type %s ,for push descriptors in VkDescriptorSetLayoutBinding entry %" PRIu32 ".",
418 string_VkDescriptorType(binding_info.descriptorType), i);
John Zulauf0fdeab32018-01-23 11:27:35 -0700419 }
Jeff Bolze54ae892018-09-08 12:16:29 -0500420
421 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT) {
422 if ((binding_info.descriptorCount % 4) != 0) {
423 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
424 "VUID-VkDescriptorSetLayoutBinding-descriptorType-02209",
Dave Houlton142c4cb2018-10-17 15:04:41 -0600425 "descriptorCount =(%" PRIu32 ") must be a multiple of 4", binding_info.descriptorCount);
Jeff Bolze54ae892018-09-08 12:16:29 -0500426 }
427 if (binding_info.descriptorCount > inline_uniform_block_props->maxInlineUniformBlockSize) {
428 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
429 "VUID-VkDescriptorSetLayoutBinding-descriptorType-02210",
430 "descriptorCount =(%" PRIu32 ") must be less than or equal to maxInlineUniformBlockSize",
431 binding_info.descriptorCount);
432 }
433 }
434
John Zulauf0fdeab32018-01-23 11:27:35 -0700435 total_descriptors += binding_info.descriptorCount;
Tobin Ehlis154c2692016-10-25 09:36:53 -0600436 }
John Zulauf0fdeab32018-01-23 11:27:35 -0700437
Jeff Bolzfdf96072018-04-10 14:32:18 -0500438 if (flags_create_info) {
439 if (flags_create_info->bindingCount != 0 && flags_create_info->bindingCount != create_info->bindingCount) {
440 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 -0600441 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-bindingCount-03002",
Jeff Bolzfdf96072018-04-10 14:32:18 -0500442 "VkDescriptorSetLayoutCreateInfo::bindingCount (%d) != "
443 "VkDescriptorSetLayoutBindingFlagsCreateInfoEXT::bindingCount (%d)",
444 create_info->bindingCount, flags_create_info->bindingCount);
445 }
446
447 if (flags_create_info->bindingCount == create_info->bindingCount) {
448 for (uint32_t i = 0; i < create_info->bindingCount; ++i) {
449 const auto &binding_info = create_info->pBindings[i];
450
451 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT) {
452 if (!update_after_bind_set) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600453 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
454 "VUID-VkDescriptorSetLayoutCreateInfo-flags-03000",
455 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500456 }
457
458 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER &&
459 !descriptor_indexing_features->descriptorBindingUniformBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600460 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
461 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
462 "descriptorBindingUniformBufferUpdateAfterBind-03005",
463 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500464 }
465 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_SAMPLER ||
466 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER ||
467 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE) &&
468 !descriptor_indexing_features->descriptorBindingSampledImageUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600469 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
470 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
471 "descriptorBindingSampledImageUpdateAfterBind-03006",
472 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500473 }
474 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_IMAGE &&
475 !descriptor_indexing_features->descriptorBindingStorageImageUpdateAfterBind) {
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-"
478 "descriptorBindingStorageImageUpdateAfterBind-03007",
479 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500480 }
481 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER &&
482 !descriptor_indexing_features->descriptorBindingStorageBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600483 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
484 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
485 "descriptorBindingStorageBufferUpdateAfterBind-03008",
486 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500487 }
488 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER &&
489 !descriptor_indexing_features->descriptorBindingUniformTexelBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600490 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
491 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
492 "descriptorBindingUniformTexelBufferUpdateAfterBind-03009",
493 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500494 }
495 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER &&
496 !descriptor_indexing_features->descriptorBindingStorageTexelBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600497 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
498 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
499 "descriptorBindingStorageTexelBufferUpdateAfterBind-03010",
500 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500501 }
502 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT ||
503 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
504 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600505 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
506 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-None-03011",
507 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500508 }
Jeff Bolze54ae892018-09-08 12:16:29 -0500509
510 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT &&
511 !inline_uniform_block_features->descriptorBindingInlineUniformBlockUpdateAfterBind) {
512 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 -0600513 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
514 "descriptorBindingInlineUniformBlockUpdateAfterBind-02211",
515 "Invalid flags (VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT) for "
516 "VkDescriptorSetLayoutBinding entry %" PRIu32
517 " with descriptorBindingInlineUniformBlockUpdateAfterBind not enabled",
518 i);
Jeff Bolze54ae892018-09-08 12:16:29 -0500519 }
Jeff Bolzfdf96072018-04-10 14:32:18 -0500520 }
521
522 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT) {
523 if (!descriptor_indexing_features->descriptorBindingUpdateUnusedWhilePending) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600524 skip |= log_msg(
525 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
526 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-descriptorBindingUpdateUnusedWhilePending-03012",
527 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500528 }
529 }
530
531 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT) {
532 if (!descriptor_indexing_features->descriptorBindingPartiallyBound) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600533 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
534 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-descriptorBindingPartiallyBound-03013",
535 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500536 }
537 }
538
539 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT_EXT) {
540 if (binding_info.binding != max_binding) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600541 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
542 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-pBindingFlags-03004",
543 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500544 }
545
546 if (!descriptor_indexing_features->descriptorBindingVariableDescriptorCount) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600547 skip |= log_msg(
548 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
549 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-descriptorBindingVariableDescriptorCount-03014",
550 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500551 }
552 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
553 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600554 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
555 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-pBindingFlags-03015",
556 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500557 }
558 }
559
560 if (push_descriptor_set &&
561 (flags_create_info->pBindingFlags[i] &
562 (VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT |
563 VK_DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT_EXT))) {
564 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 -0600565 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-flags-03003",
566 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500567 }
568 }
569 }
570 }
571
John Zulauf0fdeab32018-01-23 11:27:35 -0700572 if ((push_descriptor_set) && (total_descriptors > max_push_descriptors)) {
573 const char *undefined = push_descriptor_ext ? "" : " -- undefined";
Dave Houltond8ed0212018-05-16 17:18:24 -0600574 skip |=
575 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
576 "VUID-VkDescriptorSetLayoutCreateInfo-flags-00281",
577 "for push descriptor, total descriptor count in layout (%" PRIu64
578 ") must not be greater than VkPhysicalDevicePushDescriptorPropertiesKHR::maxPushDescriptors (%" PRIu32 "%s).",
579 total_descriptors, max_push_descriptors, undefined);
John Zulauf0fdeab32018-01-23 11:27:35 -0700580 }
581
Tobin Ehlis154c2692016-10-25 09:36:53 -0600582 return skip;
583}
584
Tobin Ehlis68d0adf2016-06-01 11:33:50 -0600585cvdescriptorset::AllocateDescriptorSetsData::AllocateDescriptorSetsData(uint32_t count)
586 : required_descriptors_by_type{}, layout_nodes(count, nullptr) {}
587
Tobin Ehlis93f22372016-10-12 14:34:12 -0600588cvdescriptorset::DescriptorSet::DescriptorSet(const VkDescriptorSet set, const VkDescriptorPool pool,
Jeff Bolzfdf96072018-04-10 14:32:18 -0500589 const std::shared_ptr<DescriptorSetLayout const> &layout, uint32_t variable_count,
590 layer_data *dev_data)
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -0700591 : some_update_(false),
592 set_(set),
593 pool_state_(nullptr),
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600594 p_layout_(layout),
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -0700595 device_data_(dev_data),
Jeff Bolzfdf96072018-04-10 14:32:18 -0500596 limits_(GetPhysDevProperties(dev_data)->properties.limits),
597 variable_count_(variable_count) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700598 pool_state_ = GetDescriptorPoolState(dev_data, pool);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600599 // Foreach binding, create default descriptors of given type
John Zulaufb6d71202017-12-22 16:47:09 -0700600 descriptors_.reserve(p_layout_->GetTotalDescriptorCount());
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600601 for (uint32_t i = 0; i < p_layout_->GetBindingCount(); ++i) {
602 auto type = p_layout_->GetTypeFromIndex(i);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600603 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700604 case VK_DESCRIPTOR_TYPE_SAMPLER: {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600605 auto immut_sampler = p_layout_->GetImmutableSamplerPtrFromIndex(i);
606 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
Tobin Ehlis082c7512017-05-08 11:24:57 -0600607 if (immut_sampler) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700608 descriptors_.emplace_back(new SamplerDescriptor(immut_sampler + di));
Tobin Ehlis082c7512017-05-08 11:24:57 -0600609 some_update_ = true; // Immutable samplers are updated at creation
610 } else
Chris Forbes9f340852017-05-09 08:51:38 -0700611 descriptors_.emplace_back(new SamplerDescriptor(nullptr));
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700612 }
613 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600614 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700615 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600616 auto immut = p_layout_->GetImmutableSamplerPtrFromIndex(i);
617 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
Tobin Ehlis082c7512017-05-08 11:24:57 -0600618 if (immut) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700619 descriptors_.emplace_back(new ImageSamplerDescriptor(immut + di));
Tobin Ehlis082c7512017-05-08 11:24:57 -0600620 some_update_ = true; // Immutable samplers are updated at creation
621 } else
Chris Forbes9f340852017-05-09 08:51:38 -0700622 descriptors_.emplace_back(new ImageSamplerDescriptor(nullptr));
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700623 }
624 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600625 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700626 // ImageDescriptors
627 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
628 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
629 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600630 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700631 descriptors_.emplace_back(new ImageDescriptor(type));
632 break;
633 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
634 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600635 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700636 descriptors_.emplace_back(new TexelDescriptor(type));
637 break;
638 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
639 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
640 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
641 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600642 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700643 descriptors_.emplace_back(new BufferDescriptor(type));
644 break;
Jeff Bolze54ae892018-09-08 12:16:29 -0500645 case VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT:
646 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
647 descriptors_.emplace_back(new InlineUniformDescriptor(type));
648 break;
Eric Werness30127fd2018-10-31 21:01:03 -0700649 case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV:
Jeff Bolzfbe51582018-09-13 10:01:35 -0500650 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
651 descriptors_.emplace_back(new AccelerationStructureDescriptor(type));
652 break;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700653 default:
654 assert(0); // Bad descriptor type specified
655 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600656 }
657 }
658}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600659
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700660cvdescriptorset::DescriptorSet::~DescriptorSet() { InvalidateBoundCmdBuffers(); }
Chris Forbes57989132016-07-26 17:06:10 +1200661
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600662static std::string StringDescriptorReqViewType(descriptor_req req) {
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700663 std::string result("");
Chris Forbes57989132016-07-26 17:06:10 +1200664 for (unsigned i = 0; i <= VK_IMAGE_VIEW_TYPE_END_RANGE; i++) {
665 if (req & (1 << i)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700666 if (result.size()) result += ", ";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700667 result += string_VkImageViewType(VkImageViewType(i));
Chris Forbes57989132016-07-26 17:06:10 +1200668 }
669 }
670
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700671 if (!result.size()) result = "(none)";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700672
673 return result;
Chris Forbes57989132016-07-26 17:06:10 +1200674}
675
Chris Forbesda01e8d2018-08-27 15:36:57 -0700676static char const *StringDescriptorReqComponentType(descriptor_req req) {
677 if (req & DESCRIPTOR_REQ_COMPONENT_TYPE_SINT) return "SINT";
678 if (req & DESCRIPTOR_REQ_COMPONENT_TYPE_UINT) return "UINT";
679 if (req & DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT) return "FLOAT";
680 return "(none)";
681}
682
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600683// Is this sets underlying layout compatible with passed in layout according to "Pipeline Layout Compatibility" in spec?
Tobin Ehlis6dc57dd2017-06-21 10:08:52 -0600684bool cvdescriptorset::DescriptorSet::IsCompatible(DescriptorSetLayout const *const layout, std::string *error) const {
685 return layout->IsCompatible(p_layout_.get(), error);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600686}
Chris Forbes57989132016-07-26 17:06:10 +1200687
Chris Forbesda01e8d2018-08-27 15:36:57 -0700688static unsigned DescriptorRequirementsBitsFromFormat(VkFormat fmt) {
689 if (FormatIsSInt(fmt)) return DESCRIPTOR_REQ_COMPONENT_TYPE_SINT;
690 if (FormatIsUInt(fmt)) return DESCRIPTOR_REQ_COMPONENT_TYPE_UINT;
691 if (FormatIsDepthAndStencil(fmt)) return DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT | DESCRIPTOR_REQ_COMPONENT_TYPE_UINT;
692 if (fmt == VK_FORMAT_UNDEFINED) return 0;
693 // everything else -- UNORM/SNORM/FLOAT/USCALED/SSCALED is all float in the shader.
694 return DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT;
695}
696
Tobin Ehlis3066db62016-08-22 08:12:23 -0600697// 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 -0600698// This includes validating that all descriptors in the given bindings are updated,
699// that any update buffers are valid, and that any dynamic offsets are within the bounds of their buffers.
700// Return true if state is acceptable, or false and write an error message into error string
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600701bool cvdescriptorset::DescriptorSet::ValidateDrawState(const std::map<uint32_t, descriptor_req> &bindings,
John Zulauf48a6a702017-12-22 17:14:54 -0700702 const std::vector<uint32_t> &dynamic_offsets, GLOBAL_CB_NODE *cb_node,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600703 const char *caller, std::string *error) const {
Chris Forbesc7090a82016-07-25 18:10:41 +1200704 for (auto binding_pair : bindings) {
705 auto binding = binding_pair.first;
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600706 if (!p_layout_->HasBinding(binding)) {
Tobin Ehlis58c59582016-06-21 12:34:33 -0600707 std::stringstream error_str;
708 error_str << "Attempting to validate DrawState for binding #" << binding
709 << " which is an invalid binding for this descriptor set.";
710 *error = error_str.str();
711 return false;
712 }
John Zulaufc483f442017-12-15 14:02:06 -0700713 IndexRange index_range = p_layout_->GetGlobalIndexRangeFromBinding(binding);
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700714 auto array_idx = 0; // Track array idx if we're dealing with array descriptors
Jeff Bolzfdf96072018-04-10 14:32:18 -0500715
716 if (IsVariableDescriptorCount(binding)) {
717 // Only validate the first N descriptors if it uses variable_count
718 index_range.end = index_range.start + GetVariableDescriptorCount();
719 }
720
John Zulaufc483f442017-12-15 14:02:06 -0700721 for (uint32_t i = index_range.start; i < index_range.end; ++i, ++array_idx) {
Tobin Ehlisda77de72018-12-13 08:53:28 -0700722 if ((p_layout_->GetDescriptorBindingFlagsFromBinding(binding) &
723 (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT)) ||
Jeff Bolze54ae892018-09-08 12:16:29 -0500724 descriptors_[i]->GetClass() == InlineUniform) {
Jeff Bolzfdf96072018-04-10 14:32:18 -0500725 // Can't validate the descriptor because it may not have been updated,
726 // or the view could have been destroyed
727 continue;
728 } else if (!descriptors_[i]->updated) {
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700729 std::stringstream error_str;
730 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
731 << " is being used in draw but has not been updated.";
732 *error = error_str.str();
733 return false;
734 } else {
735 auto descriptor_class = descriptors_[i]->GetClass();
736 if (descriptor_class == GeneralBuffer) {
737 // Verify that buffers are valid
738 auto buffer = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetBuffer();
739 auto buffer_node = GetBufferState(device_data_, buffer);
740 if (!buffer_node) {
741 std::stringstream error_str;
742 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
743 << " references invalid buffer " << buffer << ".";
744 *error = error_str.str();
745 return false;
John Zulauf48a6a702017-12-22 17:14:54 -0700746 } else if (!buffer_node->sparse) {
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700747 for (auto mem_binding : buffer_node->GetBoundMemory()) {
748 if (!GetMemObjInfo(device_data_, mem_binding)) {
749 std::stringstream error_str;
750 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
751 << " uses buffer " << buffer << " that references invalid memory " << mem_binding << ".";
752 *error = error_str.str();
Tobin Ehlisc8266452017-04-07 12:20:30 -0600753 return false;
754 }
755 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700756 }
757 if (descriptors_[i]->IsDynamic()) {
758 // Validate that dynamic offsets are within the buffer
759 auto buffer_size = buffer_node->createInfo.size;
760 auto range = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetRange();
761 auto desc_offset = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetOffset();
762 auto dyn_offset = dynamic_offsets[GetDynamicOffsetIndexFromBinding(binding) + array_idx];
763 if (VK_WHOLE_SIZE == range) {
764 if ((dyn_offset + desc_offset) > buffer_size) {
765 std::stringstream error_str;
766 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
767 << " uses buffer " << buffer << " with update range of VK_WHOLE_SIZE has dynamic offset "
768 << dyn_offset << " combined with offset " << desc_offset
769 << " that oversteps the buffer size of " << buffer_size << ".";
770 *error = error_str.str();
771 return false;
772 }
773 } else {
774 if ((dyn_offset + desc_offset + range) > buffer_size) {
775 std::stringstream error_str;
776 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
777 << " uses buffer " << buffer << " with dynamic offset " << dyn_offset
778 << " combined with offset " << desc_offset << " and range " << range
779 << " that oversteps the buffer size of " << buffer_size << ".";
780 *error = error_str.str();
781 return false;
782 }
783 }
784 }
785 } else if (descriptor_class == ImageSampler || descriptor_class == Image) {
786 VkImageView image_view;
787 VkImageLayout image_layout;
788 if (descriptor_class == ImageSampler) {
789 image_view = static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetImageView();
790 image_layout = static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetImageLayout();
791 } else {
792 image_view = static_cast<ImageDescriptor *>(descriptors_[i].get())->GetImageView();
793 image_layout = static_cast<ImageDescriptor *>(descriptors_[i].get())->GetImageLayout();
794 }
795 auto reqs = binding_pair.second;
796
797 auto image_view_state = GetImageViewState(device_data_, image_view);
Tobin Ehlis836a1372017-07-14 11:25:21 -0600798 if (nullptr == image_view_state) {
799 // Image view must have been destroyed since initial update. Could potentially flag the descriptor
800 // as "invalid" (updated = false) at DestroyImageView() time and detect this error at bind time
801 std::stringstream error_str;
802 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
803 << " is using imageView " << image_view << " that has been destroyed.";
804 *error = error_str.str();
805 return false;
806 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700807 auto image_view_ci = image_view_state->create_info;
808
809 if ((reqs & DESCRIPTOR_REQ_ALL_VIEW_TYPE_BITS) && (~reqs & (1 << image_view_ci.viewType))) {
810 // bad view type
811 std::stringstream error_str;
812 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600813 << " requires an image view of type " << StringDescriptorReqViewType(reqs) << " but got "
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700814 << string_VkImageViewType(image_view_ci.viewType) << ".";
815 *error = error_str.str();
816 return false;
817 }
818
Chris Forbesda01e8d2018-08-27 15:36:57 -0700819 auto format_bits = DescriptorRequirementsBitsFromFormat(image_view_ci.format);
820 if (!(reqs & format_bits)) {
821 // bad component type
822 std::stringstream error_str;
823 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i << " requires "
824 << StringDescriptorReqComponentType(reqs) << " component type, but bound descriptor format is "
825 << string_VkFormat(image_view_ci.format) << ".";
826 *error = error_str.str();
827 return false;
828 }
829
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700830 auto image_node = GetImageState(device_data_, image_view_ci.image);
831 assert(image_node);
832 // Verify Image Layout
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700833 // Copy first mip level into sub_layers and loop over each mip level to verify layout
834 VkImageSubresourceLayers sub_layers;
835 sub_layers.aspectMask = image_view_ci.subresourceRange.aspectMask;
836 sub_layers.baseArrayLayer = image_view_ci.subresourceRange.baseArrayLayer;
837 sub_layers.layerCount = image_view_ci.subresourceRange.layerCount;
838 bool hit_error = false;
839 for (auto cur_level = image_view_ci.subresourceRange.baseMipLevel;
840 cur_level < image_view_ci.subresourceRange.levelCount; ++cur_level) {
841 sub_layers.mipLevel = cur_level;
Cort Stratton7df30962018-05-17 19:45:57 -0700842 // No "invalid layout" VUID required for this call, since the optimal_layout parameter is UNDEFINED.
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700843 VerifyImageLayout(device_data_, cb_node, image_node, sub_layers, image_layout, VK_IMAGE_LAYOUT_UNDEFINED,
Cort Stratton7df30962018-05-17 19:45:57 -0700844 caller, kVUIDUndefined, "VUID-VkDescriptorImageInfo-imageLayout-00344", &hit_error);
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700845 if (hit_error) {
846 *error =
John Zulauf1d27e0a2018-11-05 10:12:48 -0700847 "Image layout specified at vkUpdateDescriptorSet* or vkCmdPushDescriptorSet* time "
John Zulaufb45fdc32018-10-12 15:14:17 -0600848 "doesn't match actual image layout at time descriptor is used. See previous error callback for "
849 "specific details.";
Chris Forbes57989132016-07-26 17:06:10 +1200850 return false;
851 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700852 }
853 // Verify Sample counts
854 if ((reqs & DESCRIPTOR_REQ_SINGLE_SAMPLE) && image_node->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
855 std::stringstream error_str;
856 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
857 << " requires bound image to have VK_SAMPLE_COUNT_1_BIT but got "
858 << string_VkSampleCountFlagBits(image_node->createInfo.samples) << ".";
859 *error = error_str.str();
860 return false;
861 }
862 if ((reqs & DESCRIPTOR_REQ_MULTI_SAMPLE) && image_node->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
863 std::stringstream error_str;
864 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
865 << " requires bound image to have multiple samples, but got VK_SAMPLE_COUNT_1_BIT.";
866 *error = error_str.str();
867 return false;
Chris Forbes57989132016-07-26 17:06:10 +1200868 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600869 }
Tobin Ehlisb1a2e4b2018-03-16 07:54:24 -0600870 if (descriptor_class == ImageSampler || descriptor_class == PlainSampler) {
871 // Verify Sampler still valid
872 VkSampler sampler;
873 if (descriptor_class == ImageSampler) {
874 sampler = static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetSampler();
875 } else {
876 sampler = static_cast<SamplerDescriptor *>(descriptors_[i].get())->GetSampler();
877 }
878 if (!ValidateSampler(sampler, device_data_)) {
879 std::stringstream error_str;
880 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
881 << " is using sampler " << sampler << " that has been destroyed.";
882 *error = error_str.str();
883 return false;
884 }
885 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600886 }
887 }
888 }
889 return true;
890}
Chris Forbes57989132016-07-26 17:06:10 +1200891
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600892// For given bindings, place any update buffers or images into the passed-in unordered_sets
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600893uint32_t cvdescriptorset::DescriptorSet::GetStorageUpdates(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600894 std::unordered_set<VkBuffer> *buffer_set,
895 std::unordered_set<VkImageView> *image_set) const {
896 auto num_updates = 0;
Chris Forbesc7090a82016-07-25 18:10:41 +1200897 for (auto binding_pair : bindings) {
898 auto binding = binding_pair.first;
Tobin Ehlis58c59582016-06-21 12:34:33 -0600899 // If a binding doesn't exist, skip it
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600900 if (!p_layout_->HasBinding(binding)) {
Tobin Ehlis58c59582016-06-21 12:34:33 -0600901 continue;
902 }
John Zulaufc483f442017-12-15 14:02:06 -0700903 uint32_t start_idx = p_layout_->GetGlobalIndexRangeFromBinding(binding).start;
Tobin Ehlis81f17852016-05-05 09:04:33 -0600904 if (descriptors_[start_idx]->IsStorage()) {
905 if (Image == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600906 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600907 if (descriptors_[start_idx + i]->updated) {
908 image_set->insert(static_cast<ImageDescriptor *>(descriptors_[start_idx + i].get())->GetImageView());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600909 num_updates++;
910 }
911 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600912 } else if (TexelBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600913 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600914 if (descriptors_[start_idx + i]->updated) {
915 auto bufferview = static_cast<TexelDescriptor *>(descriptors_[start_idx + i].get())->GetBufferView();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700916 auto bv_state = GetBufferViewState(device_data_, bufferview);
Tobin Ehlis8b872462016-09-14 08:12:08 -0600917 if (bv_state) {
918 buffer_set->insert(bv_state->create_info.buffer);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600919 num_updates++;
920 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600921 }
922 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600923 } else if (GeneralBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600924 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600925 if (descriptors_[start_idx + i]->updated) {
926 buffer_set->insert(static_cast<BufferDescriptor *>(descriptors_[start_idx + i].get())->GetBuffer());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600927 num_updates++;
928 }
929 }
930 }
931 }
932 }
933 return num_updates;
934}
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600935// Set is being deleted or updates so invalidate all bound cmd buffers
936void cvdescriptorset::DescriptorSet::InvalidateBoundCmdBuffers() {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600937 core_validation::InvalidateCommandBuffers(device_data_, cb_bindings, {HandleToUint64(set_), kVulkanObjectTypeDescriptorSet});
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600938}
John Zulauf1d27e0a2018-11-05 10:12:48 -0700939
940// Loop through the write updates to do for a push descriptor set, ignoring dstSet
941void cvdescriptorset::DescriptorSet::PerformPushDescriptorsUpdate(uint32_t write_count, const VkWriteDescriptorSet *p_wds) {
942 assert(IsPushDescriptor());
943 for (uint32_t i = 0; i < write_count; i++) {
944 PerformWriteUpdate(&p_wds[i]);
945 }
946}
947
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600948// Perform write update in given update struct
Tobin Ehlis300888c2016-05-18 13:43:26 -0600949void cvdescriptorset::DescriptorSet::PerformWriteUpdate(const VkWriteDescriptorSet *update) {
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700950 // Perform update on a per-binding basis as consecutive updates roll over to next binding
951 auto descriptors_remaining = update->descriptorCount;
952 auto binding_being_updated = update->dstBinding;
953 auto offset = update->dstArrayElement;
Tobin Ehlise16805c2017-08-09 09:10:37 -0600954 uint32_t update_index = 0;
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700955 while (descriptors_remaining) {
956 uint32_t update_count = std::min(descriptors_remaining, GetDescriptorCountFromBinding(binding_being_updated));
John Zulaufc483f442017-12-15 14:02:06 -0700957 auto global_idx = p_layout_->GetGlobalIndexRangeFromBinding(binding_being_updated).start + offset;
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700958 // Loop over the updates for a single binding at a time
Tobin Ehlise16805c2017-08-09 09:10:37 -0600959 for (uint32_t di = 0; di < update_count; ++di, ++update_index) {
960 descriptors_[global_idx + di]->WriteUpdate(update, update_index);
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700961 }
962 // Roll over to next binding in case of consecutive update
963 descriptors_remaining -= update_count;
964 offset = 0;
965 binding_being_updated++;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600966 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700967 if (update->descriptorCount) some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600968
Jeff Bolzfdf96072018-04-10 14:32:18 -0500969 if (!(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
970 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
971 InvalidateBoundCmdBuffers();
972 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600973}
Tobin Ehlis300888c2016-05-18 13:43:26 -0600974// Validate Copy update
975bool cvdescriptorset::DescriptorSet::ValidateCopyUpdate(const debug_report_data *report_data, const VkCopyDescriptorSet *update,
John Zulaufb45fdc32018-10-12 15:14:17 -0600976 const DescriptorSet *src_set, const char *func_name,
977 std::string *error_code, std::string *error_msg) {
John Zulauf5dfd45c2018-01-17 11:06:34 -0700978 // Verify dst layout still valid
979 if (p_layout_->IsDestroyed()) {
Dave Houlton00c154e2018-05-24 13:20:50 -0600980 *error_code = "VUID-VkCopyDescriptorSet-dstSet-parameter";
John Zulauf5dfd45c2018-01-17 11:06:34 -0700981 string_sprintf(error_msg,
John Zulaufb45fdc32018-10-12 15:14:17 -0600982 "Cannot call %s to perform copy update on descriptor set dstSet 0x%" PRIxLEAST64
John Zulauf5dfd45c2018-01-17 11:06:34 -0700983 " created with destroyed VkDescriptorSetLayout 0x%" PRIxLEAST64,
John Zulaufb45fdc32018-10-12 15:14:17 -0600984 func_name, HandleToUint64(set_), HandleToUint64(p_layout_->GetDescriptorSetLayout()));
John Zulauf5dfd45c2018-01-17 11:06:34 -0700985 return false;
986 }
987
988 // Verify src layout still valid
989 if (src_set->p_layout_->IsDestroyed()) {
Dave Houlton00c154e2018-05-24 13:20:50 -0600990 *error_code = "VUID-VkCopyDescriptorSet-srcSet-parameter";
John Zulaufb45fdc32018-10-12 15:14:17 -0600991 string_sprintf(error_msg,
992 "Cannot call %s to perform copy update of dstSet 0x%" PRIxLEAST64
993 " from descriptor set srcSet 0x%" PRIxLEAST64
994 " created with destroyed VkDescriptorSetLayout 0x%" PRIxLEAST64,
995 func_name, HandleToUint64(set_), HandleToUint64(src_set->set_),
996 HandleToUint64(src_set->p_layout_->GetDescriptorSetLayout()));
John Zulauf5dfd45c2018-01-17 11:06:34 -0700997 return false;
998 }
999
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001000 if (!p_layout_->HasBinding(update->dstBinding)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001001 *error_code = "VUID-VkCopyDescriptorSet-dstBinding-00347";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001002 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001003 error_str << "DescriptorSet " << set_ << " does not have copy update dest binding of " << update->dstBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001004 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001005 return false;
1006 }
1007 if (!src_set->HasBinding(update->srcBinding)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001008 *error_code = "VUID-VkCopyDescriptorSet-srcBinding-00345";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001009 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001010 error_str << "DescriptorSet " << set_ << " does not have copy update src binding of " << update->srcBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001011 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001012 return false;
1013 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05001014 // Verify idle ds
1015 if (in_use.load() &&
1016 !(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
1017 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
1018 // TODO : Re-using Free Idle error code, need copy update idle error code
Dave Houlton00c154e2018-05-24 13:20:50 -06001019 *error_code = "VUID-vkFreeDescriptorSets-pDescriptorSets-00309";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001020 std::stringstream error_str;
John Zulaufb45fdc32018-10-12 15:14:17 -06001021 error_str << "Cannot call " << func_name << " to perform copy update on descriptor set " << set_
Jeff Bolzfdf96072018-04-10 14:32:18 -05001022 << " that is in use by a command buffer";
1023 *error_msg = error_str.str();
1024 return false;
1025 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001026 // src & dst set bindings are valid
1027 // Check bounds of src & dst
John Zulaufc483f442017-12-15 14:02:06 -07001028 auto src_start_idx = src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start + update->srcArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001029 if ((src_start_idx + update->descriptorCount) > src_set->GetTotalDescriptorCount()) {
1030 // SRC update out of bounds
Dave Houlton00c154e2018-05-24 13:20:50 -06001031 *error_code = "VUID-VkCopyDescriptorSet-srcArrayElement-00346";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001032 std::stringstream error_str;
1033 error_str << "Attempting copy update from descriptorSet " << update->srcSet << " binding#" << update->srcBinding
John Zulaufc483f442017-12-15 14:02:06 -07001034 << " with offset index of " << src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001035 << " plus update array offset of " << update->srcArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001036 << " descriptors oversteps total number of descriptors in set: " << src_set->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001037 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001038 return false;
1039 }
John Zulaufc483f442017-12-15 14:02:06 -07001040 auto dst_start_idx = p_layout_->GetGlobalIndexRangeFromBinding(update->dstBinding).start + update->dstArrayElement;
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001041 if ((dst_start_idx + update->descriptorCount) > p_layout_->GetTotalDescriptorCount()) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001042 // DST update out of bounds
Dave Houlton00c154e2018-05-24 13:20:50 -06001043 *error_code = "VUID-VkCopyDescriptorSet-dstArrayElement-00348";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001044 std::stringstream error_str;
1045 error_str << "Attempting copy update to descriptorSet " << set_ << " binding#" << update->dstBinding
John Zulaufc483f442017-12-15 14:02:06 -07001046 << " with offset index of " << p_layout_->GetGlobalIndexRangeFromBinding(update->dstBinding).start
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001047 << " plus update array offset of " << update->dstArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001048 << " descriptors oversteps total number of descriptors in set: " << p_layout_->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001049 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001050 return false;
1051 }
1052 // Check that types match
Dave Houltond8ed0212018-05-16 17:18:24 -06001053 // TODO : Base default error case going from here is "VUID-VkAcquireNextImageInfoKHR-semaphore-parameter"2ba which covers all
1054 // consistency issues, need more fine-grained error codes
Dave Houlton00c154e2018-05-24 13:20:50 -06001055 *error_code = "VUID-VkCopyDescriptorSet-srcSet-00349";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001056 auto src_type = src_set->GetTypeFromBinding(update->srcBinding);
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001057 auto dst_type = p_layout_->GetTypeFromBinding(update->dstBinding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001058 if (src_type != dst_type) {
1059 std::stringstream error_str;
1060 error_str << "Attempting copy update to descriptorSet " << set_ << " binding #" << update->dstBinding << " with type "
1061 << string_VkDescriptorType(dst_type) << " from descriptorSet " << src_set->GetSet() << " binding #"
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001062 << update->srcBinding << " with type " << string_VkDescriptorType(src_type) << ". Types do not match";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001063 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001064 return false;
1065 }
1066 // Verify consistency of src & dst bindings if update crosses binding boundaries
Tobin Ehlis1f946f82016-05-05 12:03:44 -06001067 if ((!src_set->GetLayout()->VerifyUpdateConsistency(update->srcBinding, update->srcArrayElement, update->descriptorCount,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001068 "copy update from", src_set->GetSet(), error_msg)) ||
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001069 (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "copy update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001070 set_, error_msg))) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001071 return false;
1072 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05001073
1074 if ((src_set->GetLayout()->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT) &&
1075 !(GetLayout()->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001076 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01918";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001077 std::stringstream error_str;
1078 error_str << "If pname:srcSet's (" << update->srcSet
1079 << ") layout was created with the "
1080 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag "
1081 "set, then pname:dstSet's ("
1082 << update->dstSet
1083 << ") layout must: also have been created with the "
1084 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag set";
1085 *error_msg = error_str.str();
1086 return false;
1087 }
1088
1089 if (!(src_set->GetLayout()->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT) &&
1090 (GetLayout()->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001091 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01919";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001092 std::stringstream error_str;
1093 error_str << "If pname:srcSet's (" << update->srcSet
1094 << ") layout was created without the "
1095 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag "
1096 "set, then pname:dstSet's ("
1097 << update->dstSet
1098 << ") layout must: also have been created without the "
1099 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag set";
1100 *error_msg = error_str.str();
1101 return false;
1102 }
1103
1104 if ((src_set->GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT) &&
1105 !(GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001106 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01920";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001107 std::stringstream error_str;
1108 error_str << "If the descriptor pool from which pname:srcSet (" << update->srcSet
1109 << ") was allocated was created "
1110 "with the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag "
1111 "set, then the descriptor pool from which pname:dstSet ("
1112 << update->dstSet
1113 << ") was allocated must: "
1114 "also have been created with the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag set";
1115 *error_msg = error_str.str();
1116 return false;
1117 }
1118
1119 if (!(src_set->GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT) &&
1120 (GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001121 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01921";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001122 std::stringstream error_str;
1123 error_str << "If the descriptor pool from which pname:srcSet (" << update->srcSet
1124 << ") was allocated was created "
1125 "without the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag "
1126 "set, then the descriptor pool from which pname:dstSet ("
1127 << update->dstSet
1128 << ") was allocated must: "
1129 "also have been created without the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag set";
1130 *error_msg = error_str.str();
1131 return false;
1132 }
1133
Jeff Bolze54ae892018-09-08 12:16:29 -05001134 if (src_type == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT) {
1135 if ((update->srcArrayElement % 4) != 0) {
1136 *error_code = "VUID-VkCopyDescriptorSet-srcBinding-02223";
1137 std::stringstream error_str;
1138 error_str << "Attempting copy update to VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT binding with "
1139 << "srcArrayElement " << update->srcArrayElement << " not a multiple of 4";
1140 *error_msg = error_str.str();
1141 return false;
1142 }
1143 if ((update->dstArrayElement % 4) != 0) {
1144 *error_code = "VUID-VkCopyDescriptorSet-dstBinding-02224";
1145 std::stringstream error_str;
1146 error_str << "Attempting copy update to VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT binding with "
1147 << "dstArrayElement " << update->dstArrayElement << " not a multiple of 4";
1148 *error_msg = error_str.str();
1149 return false;
1150 }
1151 if ((update->descriptorCount % 4) != 0) {
1152 *error_code = "VUID-VkCopyDescriptorSet-srcBinding-02225";
1153 std::stringstream error_str;
1154 error_str << "Attempting copy update to VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT binding with "
1155 << "descriptorCount " << update->descriptorCount << " not a multiple of 4";
1156 *error_msg = error_str.str();
1157 return false;
1158 }
1159 }
1160
Tobin Ehlisd41e7b62016-05-19 07:56:18 -06001161 // Update parameters all look good and descriptor updated so verify update contents
John Zulaufb45fdc32018-10-12 15:14:17 -06001162 if (!VerifyCopyUpdateContents(update, src_set, src_type, src_start_idx, func_name, error_code, error_msg)) return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001163
1164 // All checks passed so update is good
1165 return true;
1166}
1167// Perform Copy update
1168void cvdescriptorset::DescriptorSet::PerformCopyUpdate(const VkCopyDescriptorSet *update, const DescriptorSet *src_set) {
John Zulaufc483f442017-12-15 14:02:06 -07001169 auto src_start_idx = src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start + update->srcArrayElement;
1170 auto dst_start_idx = p_layout_->GetGlobalIndexRangeFromBinding(update->dstBinding).start + update->dstArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001171 // Update parameters all look good so perform update
1172 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02001173 auto src = src_set->descriptors_[src_start_idx + di].get();
1174 auto dst = descriptors_[dst_start_idx + di].get();
1175 if (src->updated) {
1176 dst->CopyUpdate(src);
1177 some_update_ = true;
1178 } else {
1179 dst->updated = false;
1180 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001181 }
Tobin Ehlis56a30942016-05-19 08:00:00 -06001182
Jeff Bolzfdf96072018-04-10 14:32:18 -05001183 if (!(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
1184 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
1185 InvalidateBoundCmdBuffers();
1186 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001187}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001188
John Zulauf6f3d2bd2018-10-29 17:08:42 -06001189// Update the drawing state for the affected descriptors.
1190// Set cb_node to this set and this set to cb_node.
1191// Add the bindings of the descriptor
1192// Set the layout based on the current descriptor layout (will mask subsequent layer mismatch errors)
1193// TODO: Modify the UpdateDrawState virtural functions to *only* set initial layout and not change layouts
Tobin Ehlisf9519102016-08-17 09:49:13 -06001194// Prereq: This should be called for a set that has been confirmed to be active for the given cb_node, meaning it's going
1195// to be used in a draw by the given cb_node
John Zulauf6f3d2bd2018-10-29 17:08:42 -06001196void cvdescriptorset::DescriptorSet::UpdateDrawState(GLOBAL_CB_NODE *cb_node,
1197 const std::map<uint32_t, descriptor_req> &binding_req_map) {
Tobin Ehlis9252c2b2016-07-21 14:40:22 -06001198 // bind cb to this descriptor set
1199 cb_bindings.insert(cb_node);
Tobin Ehlis7ca20be2016-10-12 15:09:16 -06001200 // Add bindings for descriptor set, the set's pool, and individual objects in the set
Petr Krausbc7f5442017-05-14 23:43:38 +02001201 cb_node->object_bindings.insert({HandleToUint64(set_), kVulkanObjectTypeDescriptorSet});
Tobin Ehlis7ca20be2016-10-12 15:09:16 -06001202 pool_state_->cb_bindings.insert(cb_node);
Petr Krausbc7f5442017-05-14 23:43:38 +02001203 cb_node->object_bindings.insert({HandleToUint64(pool_state_->pool), kVulkanObjectTypeDescriptorPool});
Tobin Ehlisf9519102016-08-17 09:49:13 -06001204 // For the active slots, use set# to look up descriptorSet from boundDescriptorSets, and bind all of that descriptor set's
1205 // resources
Tobin Ehlis022528b2016-12-29 12:22:32 -07001206 for (auto binding_req_pair : binding_req_map) {
1207 auto binding = binding_req_pair.first;
Tony-LunarG62c5dba2018-12-20 14:27:23 -07001208 // We aren't validating descriptors created with PARTIALLY_BOUND or UPDATE_AFTER_BIND, so don't record state
1209 if (p_layout_->GetDescriptorBindingFlagsFromBinding(binding) &
1210 (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT)) {
1211 continue;
1212 }
John Zulaufc483f442017-12-15 14:02:06 -07001213 auto range = p_layout_->GetGlobalIndexRangeFromBinding(binding);
1214 for (uint32_t i = range.start; i < range.end; ++i) {
John Zulauf6f3d2bd2018-10-29 17:08:42 -06001215 descriptors_[i]->UpdateDrawState(device_data_, cb_node);
Mark Lobodzinski2872f4a2018-09-03 17:00:53 -06001216 }
1217 }
1218}
1219
John Zulauf48a6a702017-12-22 17:14:54 -07001220void cvdescriptorset::DescriptorSet::FilterAndTrackOneBindingReq(const BindingReqMap::value_type &binding_req_pair,
1221 const BindingReqMap &in_req, BindingReqMap *out_req,
1222 TrackedBindings *bindings) {
1223 assert(out_req);
1224 assert(bindings);
1225 const auto binding = binding_req_pair.first;
1226 // Use insert and look at the boolean ("was inserted") in the returned pair to see if this is a new set member.
1227 // Saves one hash lookup vs. find ... compare w/ end ... insert.
1228 const auto it_bool_pair = bindings->insert(binding);
1229 if (it_bool_pair.second) {
1230 out_req->emplace(binding_req_pair);
1231 }
1232}
Mark Lobodzinski2872f4a2018-09-03 17:00:53 -06001233
John Zulauf48a6a702017-12-22 17:14:54 -07001234void cvdescriptorset::DescriptorSet::FilterAndTrackOneBindingReq(const BindingReqMap::value_type &binding_req_pair,
1235 const BindingReqMap &in_req, BindingReqMap *out_req,
1236 TrackedBindings *bindings, uint32_t limit) {
1237 if (bindings->size() < limit) FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, bindings);
1238}
1239
1240void cvdescriptorset::DescriptorSet::FilterAndTrackBindingReqs(GLOBAL_CB_NODE *cb_state, const BindingReqMap &in_req,
1241 BindingReqMap *out_req) {
1242 TrackedBindings &bound = cached_validation_[cb_state].command_binding_and_usage;
1243 if (bound.size() == GetBindingCount()) {
1244 return; // All bindings are bound, out req is empty
1245 }
1246 for (const auto &binding_req_pair : in_req) {
1247 const auto binding = binding_req_pair.first;
1248 // If a binding doesn't exist, or has already been bound, skip it
1249 if (p_layout_->HasBinding(binding)) {
1250 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, &bound);
1251 }
1252 }
1253}
1254
1255void cvdescriptorset::DescriptorSet::FilterAndTrackBindingReqs(GLOBAL_CB_NODE *cb_state, PIPELINE_STATE *pipeline,
1256 const BindingReqMap &in_req, BindingReqMap *out_req) {
1257 auto &validated = cached_validation_[cb_state];
1258 auto &image_sample_val = validated.image_samplers[pipeline];
1259 auto *const dynamic_buffers = &validated.dynamic_buffers;
1260 auto *const non_dynamic_buffers = &validated.non_dynamic_buffers;
1261 const auto &stats = p_layout_->GetBindingTypeStats();
1262 for (const auto &binding_req_pair : in_req) {
1263 auto binding = binding_req_pair.first;
1264 VkDescriptorSetLayoutBinding const *layout_binding = p_layout_->GetDescriptorSetLayoutBindingPtrFromBinding(binding);
1265 if (!layout_binding) {
1266 continue;
1267 }
1268 // Caching criteria differs per type.
1269 // If image_layout have changed , the image descriptors need to be validated against them.
1270 if ((layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC) ||
1271 (layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
1272 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, dynamic_buffers, stats.dynamic_buffer_count);
1273 } else if ((layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER) ||
1274 (layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER)) {
1275 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, non_dynamic_buffers, stats.non_dynamic_buffer_count);
1276 } else {
1277 // This is rather crude, as the changed layouts may not impact the bound descriptors,
1278 // but the simple "versioning" is a simple "dirt" test.
1279 auto &version = image_sample_val[binding]; // Take advantage of default construtor zero initialzing new entries
1280 if (version != cb_state->image_layout_change_count) {
1281 version = cb_state->image_layout_change_count;
1282 out_req->emplace(binding_req_pair);
1283 }
1284 }
1285 }
1286}
Tobin Ehlis9252c2b2016-07-21 14:40:22 -06001287
Tobin Ehlis300888c2016-05-18 13:43:26 -06001288cvdescriptorset::SamplerDescriptor::SamplerDescriptor(const VkSampler *immut) : sampler_(VK_NULL_HANDLE), immutable_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001289 updated = false;
1290 descriptor_class = PlainSampler;
1291 if (immut) {
1292 sampler_ = *immut;
1293 immutable_ = true;
1294 updated = true;
1295 }
1296}
Tobin Ehlise2f80292016-06-02 10:08:53 -06001297// Validate given sampler. Currently this only checks to make sure it exists in the samplerMap
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001298bool cvdescriptorset::ValidateSampler(const VkSampler sampler, const layer_data *dev_data) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001299 return (GetSamplerState(dev_data, sampler) != nullptr);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001300}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001301
Tobin Ehlis554bf382016-05-24 11:14:43 -06001302bool cvdescriptorset::ValidateImageUpdate(VkImageView image_view, VkImageLayout image_layout, VkDescriptorType type,
John Zulaufb45fdc32018-10-12 15:14:17 -06001303 const layer_data *dev_data, const char *func_name, std::string *error_code,
1304 std::string *error_msg) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001305 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00326";
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001306 auto iv_state = GetImageViewState(dev_data, image_view);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001307 if (!iv_state) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001308 std::stringstream error_str;
1309 error_str << "Invalid VkImageView: " << image_view;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001310 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001311 return false;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001312 }
Tobin Ehlis81280962016-07-20 14:04:20 -06001313 // 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 -06001314 // Validate that imageLayout is compatible with aspect_mask and image format
1315 // and validate that image usage bits are correct for given usage
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001316 VkImageAspectFlags aspect_mask = iv_state->create_info.subresourceRange.aspectMask;
1317 VkImage image = iv_state->create_info.image;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001318 VkFormat format = VK_FORMAT_MAX_ENUM;
1319 VkImageUsageFlags usage = 0;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001320 auto image_node = GetImageState(dev_data, image);
Tobin Ehlis1c9c55f2016-06-02 11:49:22 -06001321 if (image_node) {
1322 format = image_node->createInfo.format;
1323 usage = image_node->createInfo.usage;
Tobin Ehlis029d2fe2016-09-21 09:19:15 -06001324 // Validate that memory is bound to image
Tobin Ehlis2cb8eb22017-01-03 14:09:57 -07001325 // TODO: This should have its own valid usage id apart from 2524 which is from CreateImageView case. The only
1326 // the error here occurs is if memory bound to a created imageView has been freed.
John Zulaufb45fdc32018-10-12 15:14:17 -06001327 if (ValidateMemoryIsBoundToImage(dev_data, image_node, func_name, "VUID-VkImageViewCreateInfo-image-01020")) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001328 *error_code = "VUID-VkImageViewCreateInfo-image-01020";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001329 *error_msg = "No memory bound to image.";
Tobin Ehlis029d2fe2016-09-21 09:19:15 -06001330 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001331 }
Chris Forbes67757ff2017-07-21 13:59:01 -07001332
1333 // KHR_maintenance1 allows rendering into 2D or 2DArray views which slice a 3D image,
1334 // but not binding them to descriptor sets.
1335 if (image_node->createInfo.imageType == VK_IMAGE_TYPE_3D &&
1336 (iv_state->create_info.viewType == VK_IMAGE_VIEW_TYPE_2D ||
1337 iv_state->create_info.viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001338 *error_code = "VUID-VkDescriptorImageInfo-imageView-00343";
Chris Forbes67757ff2017-07-21 13:59:01 -07001339 *error_msg = "ImageView must not be a 2D or 2DArray view of a 3D image";
1340 return false;
1341 }
Tobin Ehlis1809f912016-05-25 09:24:36 -06001342 }
1343 // First validate that format and layout are compatible
1344 if (format == VK_FORMAT_MAX_ENUM) {
1345 std::stringstream error_str;
1346 error_str << "Invalid image (" << image << ") in imageView (" << image_view << ").";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001347 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001348 return false;
1349 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001350 // TODO : The various image aspect and format checks here are based on general spec language in 11.5 Image Views section under
1351 // vkCreateImageView(). What's the best way to create unique id for these cases?
Dave Houlton1d2022c2017-03-29 11:43:58 -06001352 bool ds = FormatIsDepthOrStencil(format);
Tobin Ehlis1809f912016-05-25 09:24:36 -06001353 switch (image_layout) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001354 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
1355 // Only Color bit must be set
1356 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobin Ehlis1809f912016-05-25 09:24:36 -06001357 std::stringstream error_str;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001358 error_str
1359 << "ImageView (" << image_view
1360 << ") 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 -06001361 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001362 return false;
1363 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001364 // format must NOT be DS
1365 if (ds) {
1366 std::stringstream error_str;
1367 error_str << "ImageView (" << image_view
1368 << ") uses layout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL but the image format is "
1369 << string_VkFormat(format) << " which is not a color format.";
1370 *error_msg = error_str.str();
1371 return false;
1372 }
1373 break;
1374 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
1375 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
1376 // Depth or stencil bit must be set, but both must NOT be set
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001377 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
1378 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
1379 // both must NOT be set
1380 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001381 error_str << "ImageView (" << image_view << ") has both STENCIL and DEPTH aspects set";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001382 *error_msg = error_str.str();
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001383 return false;
1384 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001385 } else if (!(aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
1386 // Neither were set
1387 std::stringstream error_str;
1388 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1389 << " but does not have STENCIL or DEPTH aspects set";
1390 *error_msg = error_str.str();
1391 return false;
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001392 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001393 // format must be DS
1394 if (!ds) {
1395 std::stringstream error_str;
1396 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1397 << " but the image format is " << string_VkFormat(format) << " which is not a depth/stencil format.";
1398 *error_msg = error_str.str();
1399 return false;
1400 }
1401 break;
1402 default:
1403 // For other layouts if the source is depth/stencil image, both aspect bits must not be set
1404 if (ds) {
1405 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
1406 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
1407 // both must NOT be set
1408 std::stringstream error_str;
1409 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1410 << " and is using depth/stencil image of format " << string_VkFormat(format)
1411 << " but it has both STENCIL and DEPTH aspects set, which is illegal. When using a depth/stencil "
1412 "image in a descriptor set, please only set either VK_IMAGE_ASPECT_DEPTH_BIT or "
1413 "VK_IMAGE_ASPECT_STENCIL_BIT depending on whether it will be used for depth reads or stencil "
1414 "reads respectively.";
1415 *error_msg = error_str.str();
1416 return false;
1417 }
1418 }
1419 }
1420 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001421 }
1422 // Now validate that usage flags are correctly set for given type of update
Tobin Ehlisfb4cf712016-10-10 14:02:48 -06001423 // 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 -06001424 // TODO : The various image usage bit requirements are in general spec language for VkImageUsageFlags bit block in 11.3 Images
1425 // under vkCreateImage()
Dave Houltond8ed0212018-05-16 17:18:24 -06001426 // TODO : Need to also validate case "VUID-VkWriteDescriptorSet-descriptorType-00336" where STORAGE_IMAGE & INPUT_ATTACH types
1427 // must have been created with identify swizzle
Tobin Ehlis1809f912016-05-25 09:24:36 -06001428 std::string error_usage_bit;
1429 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001430 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1431 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
1432 if (!(usage & VK_IMAGE_USAGE_SAMPLED_BIT)) {
1433 error_usage_bit = "VK_IMAGE_USAGE_SAMPLED_BIT";
1434 }
1435 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001436 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001437 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
1438 if (!(usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
1439 error_usage_bit = "VK_IMAGE_USAGE_STORAGE_BIT";
1440 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
1441 std::stringstream error_str;
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001442 // TODO : Need to create custom enum error codes for these cases
1443 if (image_node->shared_presentable) {
1444 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != image_layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001445 error_str << "ImageView (" << image_view
1446 << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type with a front-buffered image is being updated with "
1447 "layout "
1448 << string_VkImageLayout(image_layout)
1449 << " but according to spec section 13.1 Descriptor Types, 'Front-buffered images that report "
1450 "support for VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT must be in the "
1451 "VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR layout.'";
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001452 *error_msg = error_str.str();
1453 return false;
1454 }
1455 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001456 error_str << "ImageView (" << image_view
1457 << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type is being updated with layout "
1458 << string_VkImageLayout(image_layout)
1459 << " but according to spec section 13.1 Descriptor Types, 'Load and store operations on storage "
1460 "images can only be done on images in VK_IMAGE_LAYOUT_GENERAL layout.'";
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001461 *error_msg = error_str.str();
1462 return false;
1463 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001464 }
1465 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001466 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001467 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT: {
1468 if (!(usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) {
1469 error_usage_bit = "VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT";
1470 }
1471 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001472 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001473 default:
1474 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001475 }
1476 if (!error_usage_bit.empty()) {
1477 std::stringstream error_str;
1478 error_str << "ImageView (" << image_view << ") with usage mask 0x" << usage
1479 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
1480 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001481 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001482 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001483 }
1484 return true;
1485}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001486
Tobin Ehlis300888c2016-05-18 13:43:26 -06001487void cvdescriptorset::SamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Chris Forbesfea2c542018-04-13 09:34:15 -07001488 if (!immutable_) {
1489 sampler_ = update->pImageInfo[index].sampler;
1490 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001491 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001492}
1493
Tobin Ehlis300888c2016-05-18 13:43:26 -06001494void cvdescriptorset::SamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001495 if (!immutable_) {
1496 auto update_sampler = static_cast<const SamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001497 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001498 }
1499 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001500}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001501
John Zulauf6f3d2bd2018-10-29 17:08:42 -06001502void cvdescriptorset::SamplerDescriptor::UpdateDrawState(layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001503 if (!immutable_) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001504 auto sampler_state = GetSamplerState(dev_data, sampler_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001505 if (sampler_state) core_validation::AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001506 }
1507}
1508
Tobin Ehlis300888c2016-05-18 13:43:26 -06001509cvdescriptorset::ImageSamplerDescriptor::ImageSamplerDescriptor(const VkSampler *immut)
Chris Forbes9f340852017-05-09 08:51:38 -07001510 : sampler_(VK_NULL_HANDLE), immutable_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001511 updated = false;
1512 descriptor_class = ImageSampler;
1513 if (immut) {
1514 sampler_ = *immut;
1515 immutable_ = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001516 }
1517}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001518
Tobin Ehlis300888c2016-05-18 13:43:26 -06001519void cvdescriptorset::ImageSamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001520 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001521 const auto &image_info = update->pImageInfo[index];
Chris Forbesfea2c542018-04-13 09:34:15 -07001522 if (!immutable_) {
1523 sampler_ = image_info.sampler;
1524 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001525 image_view_ = image_info.imageView;
1526 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001527}
1528
Tobin Ehlis300888c2016-05-18 13:43:26 -06001529void cvdescriptorset::ImageSamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001530 if (!immutable_) {
1531 auto update_sampler = static_cast<const ImageSamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001532 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001533 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001534 auto image_view = static_cast<const ImageSamplerDescriptor *>(src)->image_view_;
1535 auto image_layout = static_cast<const ImageSamplerDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001536 updated = true;
1537 image_view_ = image_view;
1538 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001539}
1540
John Zulauf6f3d2bd2018-10-29 17:08:42 -06001541void cvdescriptorset::ImageSamplerDescriptor::UpdateDrawState(layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -06001542 // First add binding for any non-immutable sampler
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001543 if (!immutable_) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001544 auto sampler_state = GetSamplerState(dev_data, sampler_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001545 if (sampler_state) core_validation::AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001546 }
Tobin Ehlis81e46372016-08-17 13:33:44 -06001547 // Add binding for image
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001548 auto iv_state = GetImageViewState(dev_data, image_view_);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001549 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -06001550 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001551 }
John Zulauf6f3d2bd2018-10-29 17:08:42 -06001552 SetImageViewLayout(dev_data, cb_node, image_view_, image_layout_);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001553}
1554
Tobin Ehlis300888c2016-05-18 13:43:26 -06001555cvdescriptorset::ImageDescriptor::ImageDescriptor(const VkDescriptorType type)
1556 : storage_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001557 updated = false;
1558 descriptor_class = Image;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001559 if (VK_DESCRIPTOR_TYPE_STORAGE_IMAGE == type) storage_ = true;
Petr Kraus13c98a62017-12-09 00:22:39 +01001560}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001561
Tobin Ehlis300888c2016-05-18 13:43:26 -06001562void cvdescriptorset::ImageDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001563 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001564 const auto &image_info = update->pImageInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001565 image_view_ = image_info.imageView;
1566 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001567}
1568
Tobin Ehlis300888c2016-05-18 13:43:26 -06001569void cvdescriptorset::ImageDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001570 auto image_view = static_cast<const ImageDescriptor *>(src)->image_view_;
1571 auto image_layout = static_cast<const ImageDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001572 updated = true;
1573 image_view_ = image_view;
1574 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001575}
1576
John Zulauf6f3d2bd2018-10-29 17:08:42 -06001577void cvdescriptorset::ImageDescriptor::UpdateDrawState(layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -06001578 // Add binding for image
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001579 auto iv_state = GetImageViewState(dev_data, image_view_);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001580 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -06001581 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001582 }
John Zulauf6f3d2bd2018-10-29 17:08:42 -06001583 SetImageViewLayout(dev_data, cb_node, image_view_, image_layout_);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001584}
1585
Tobin Ehlis300888c2016-05-18 13:43:26 -06001586cvdescriptorset::BufferDescriptor::BufferDescriptor(const VkDescriptorType type)
1587 : storage_(false), dynamic_(false), buffer_(VK_NULL_HANDLE), offset_(0), range_(0) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001588 updated = false;
1589 descriptor_class = GeneralBuffer;
1590 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
1591 dynamic_ = true;
1592 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type) {
1593 storage_ = true;
1594 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
1595 dynamic_ = true;
1596 storage_ = true;
1597 }
1598}
Tobin Ehlis300888c2016-05-18 13:43:26 -06001599void cvdescriptorset::BufferDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001600 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001601 const auto &buffer_info = update->pBufferInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001602 buffer_ = buffer_info.buffer;
1603 offset_ = buffer_info.offset;
1604 range_ = buffer_info.range;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001605}
1606
Tobin Ehlis300888c2016-05-18 13:43:26 -06001607void cvdescriptorset::BufferDescriptor::CopyUpdate(const Descriptor *src) {
1608 auto buff_desc = static_cast<const BufferDescriptor *>(src);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001609 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001610 buffer_ = buff_desc->buffer_;
1611 offset_ = buff_desc->offset_;
1612 range_ = buff_desc->range_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001613}
1614
John Zulauf6f3d2bd2018-10-29 17:08:42 -06001615void cvdescriptorset::BufferDescriptor::UpdateDrawState(layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001616 auto buffer_node = GetBufferState(dev_data, buffer_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001617 if (buffer_node) core_validation::AddCommandBufferBindingBuffer(dev_data, cb_node, buffer_node);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001618}
1619
Tobin Ehlis300888c2016-05-18 13:43:26 -06001620cvdescriptorset::TexelDescriptor::TexelDescriptor(const VkDescriptorType type) : buffer_view_(VK_NULL_HANDLE), storage_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001621 updated = false;
1622 descriptor_class = TexelBuffer;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001623 if (VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER == type) storage_ = true;
Petr Kraus13c98a62017-12-09 00:22:39 +01001624}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001625
Tobin Ehlis300888c2016-05-18 13:43:26 -06001626void cvdescriptorset::TexelDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001627 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001628 buffer_view_ = update->pTexelBufferView[index];
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001629}
1630
Tobin Ehlis300888c2016-05-18 13:43:26 -06001631void cvdescriptorset::TexelDescriptor::CopyUpdate(const Descriptor *src) {
1632 updated = true;
1633 buffer_view_ = static_cast<const TexelDescriptor *>(src)->buffer_view_;
1634}
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001635
John Zulauf6f3d2bd2018-10-29 17:08:42 -06001636void cvdescriptorset::TexelDescriptor::UpdateDrawState(layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001637 auto bv_state = GetBufferViewState(dev_data, buffer_view_);
Tobin Ehlis8b872462016-09-14 08:12:08 -06001638 if (bv_state) {
Tobin Ehlis2515c0e2016-09-28 07:12:28 -06001639 core_validation::AddCommandBufferBindingBufferView(dev_data, cb_node, bv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001640 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001641}
1642
Tobin Ehlis300888c2016-05-18 13:43:26 -06001643// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1644// sets, and then calls their respective Validate[Write|Copy]Update functions.
1645// If the update hits an issue for which the callback returns "true", meaning that the call down the chain should
1646// be skipped, then true is returned.
1647// If there is no issue with the update, then false is returned.
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001648bool cvdescriptorset::ValidateUpdateDescriptorSets(const debug_report_data *report_data, const layer_data *dev_data,
1649 uint32_t write_count, const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
John Zulaufb45fdc32018-10-12 15:14:17 -06001650 const VkCopyDescriptorSet *p_cds, const char *func_name) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001651 bool skip = false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001652 // Validate Write updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001653 for (uint32_t i = 0; i < write_count; i++) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001654 auto dest_set = p_wds[i].dstSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001655 auto set_node = core_validation::GetSetNode(dev_data, dest_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001656 if (!set_node) {
John Zulaufb45fdc32018-10-12 15:14:17 -06001657 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
1658 HandleToUint64(dest_set), kVUID_Core_DrawState_InvalidDescriptorSet,
1659 "Cannot call %s on descriptor set 0x%" PRIxLEAST64 " that has not been allocated.", func_name,
1660 HandleToUint64(dest_set));
Tobin Ehlis300888c2016-05-18 13:43:26 -06001661 } else {
Dave Houltond8ed0212018-05-16 17:18:24 -06001662 std::string error_code;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001663 std::string error_str;
John Zulaufb45fdc32018-10-12 15:14:17 -06001664 if (!set_node->ValidateWriteUpdate(report_data, &p_wds[i], func_name, &error_code, &error_str)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001665 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 -06001666 HandleToUint64(dest_set), error_code,
John Zulaufb45fdc32018-10-12 15:14:17 -06001667 "%s failed write update validation for Descriptor Set 0x%" PRIx64 " with error: %s.", func_name,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001668 HandleToUint64(dest_set), error_str.c_str());
Tobin Ehlis300888c2016-05-18 13:43:26 -06001669 }
1670 }
1671 }
1672 // Now validate copy updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001673 for (uint32_t i = 0; i < copy_count; ++i) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001674 auto dst_set = p_cds[i].dstSet;
1675 auto src_set = p_cds[i].srcSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001676 auto src_node = core_validation::GetSetNode(dev_data, src_set);
1677 auto dst_node = core_validation::GetSetNode(dev_data, dst_set);
Tobin Ehlisa1712752017-01-04 09:41:47 -07001678 // Object_tracker verifies that src & dest descriptor set are valid
1679 assert(src_node);
1680 assert(dst_node);
Dave Houltond8ed0212018-05-16 17:18:24 -06001681 std::string error_code;
Tobin Ehlisa1712752017-01-04 09:41:47 -07001682 std::string error_str;
John Zulaufb45fdc32018-10-12 15:14:17 -06001683 if (!dst_node->ValidateCopyUpdate(report_data, &p_cds[i], src_node, func_name, &error_code, &error_str)) {
1684 skip |=
1685 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
1686 HandleToUint64(dst_set), error_code,
1687 "%s failed copy update from Descriptor Set 0x%" PRIx64 " to Descriptor Set 0x%" PRIx64 " with error: %s.",
1688 func_name, HandleToUint64(src_set), HandleToUint64(dst_set), error_str.c_str());
Tobin Ehlis300888c2016-05-18 13:43:26 -06001689 }
1690 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001691 return skip;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001692}
1693// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1694// sets, and then calls their respective Perform[Write|Copy]Update functions.
1695// Prerequisite : ValidateUpdateDescriptorSets() should be called and return "false" prior to calling PerformUpdateDescriptorSets()
1696// with the same set of updates.
1697// This is split from the validate code to allow validation prior to calling down the chain, and then update after
1698// calling down the chain.
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001699void cvdescriptorset::PerformUpdateDescriptorSets(const layer_data *dev_data, uint32_t write_count,
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001700 const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
1701 const VkCopyDescriptorSet *p_cds) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001702 // Write updates first
1703 uint32_t i = 0;
1704 for (i = 0; i < write_count; ++i) {
1705 auto dest_set = p_wds[i].dstSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001706 auto set_node = core_validation::GetSetNode(dev_data, dest_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001707 if (set_node) {
1708 set_node->PerformWriteUpdate(&p_wds[i]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001709 }
1710 }
1711 // Now copy updates
1712 for (i = 0; i < copy_count; ++i) {
1713 auto dst_set = p_cds[i].dstSet;
1714 auto src_set = p_cds[i].srcSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001715 auto src_node = core_validation::GetSetNode(dev_data, src_set);
1716 auto dst_node = core_validation::GetSetNode(dev_data, dst_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001717 if (src_node && dst_node) {
1718 dst_node->PerformCopyUpdate(&p_cds[i], src_node);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001719 }
1720 }
1721}
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001722
John Zulaufb845eb22018-10-12 11:41:06 -06001723cvdescriptorset::DecodedTemplateUpdate::DecodedTemplateUpdate(layer_data *device_data, VkDescriptorSet descriptorSet,
John Zulauf1d27e0a2018-11-05 10:12:48 -07001724 const TEMPLATE_STATE *template_state, const void *pData,
1725 VkDescriptorSetLayout push_layout) {
John Zulaufb845eb22018-10-12 11:41:06 -06001726 auto const &create_info = template_state->create_info;
1727 inline_infos.resize(create_info.descriptorUpdateEntryCount); // Make sure we have one if we need it
1728 desc_writes.reserve(create_info.descriptorUpdateEntryCount); // emplaced, so reserved without initialization
John Zulauf1d27e0a2018-11-05 10:12:48 -07001729 VkDescriptorSetLayout effective_dsl = create_info.templateType == VK_DESCRIPTOR_UPDATE_TEMPLATE_TYPE_DESCRIPTOR_SET
1730 ? create_info.descriptorSetLayout
1731 : push_layout;
1732 auto layout_obj = GetDescriptorSetLayout(device_data, effective_dsl);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001733
1734 // Create a WriteDescriptorSet struct for each template update entry
1735 for (uint32_t i = 0; i < create_info.descriptorUpdateEntryCount; i++) {
1736 auto binding_count = layout_obj->GetDescriptorCountFromBinding(create_info.pDescriptorUpdateEntries[i].dstBinding);
1737 auto binding_being_updated = create_info.pDescriptorUpdateEntries[i].dstBinding;
1738 auto dst_array_element = create_info.pDescriptorUpdateEntries[i].dstArrayElement;
1739
John Zulaufb6d71202017-12-22 16:47:09 -07001740 desc_writes.reserve(desc_writes.size() + create_info.pDescriptorUpdateEntries[i].descriptorCount);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001741 for (uint32_t j = 0; j < create_info.pDescriptorUpdateEntries[i].descriptorCount; j++) {
1742 desc_writes.emplace_back();
1743 auto &write_entry = desc_writes.back();
1744
1745 size_t offset = create_info.pDescriptorUpdateEntries[i].offset + j * create_info.pDescriptorUpdateEntries[i].stride;
1746 char *update_entry = (char *)(pData) + offset;
1747
1748 if (dst_array_element >= binding_count) {
1749 dst_array_element = 0;
Mark Lobodzinski4aa479d2017-03-10 09:14:00 -07001750 binding_being_updated = layout_obj->GetNextValidBinding(binding_being_updated);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001751 }
1752
1753 write_entry.sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
1754 write_entry.pNext = NULL;
1755 write_entry.dstSet = descriptorSet;
1756 write_entry.dstBinding = binding_being_updated;
1757 write_entry.dstArrayElement = dst_array_element;
1758 write_entry.descriptorCount = 1;
1759 write_entry.descriptorType = create_info.pDescriptorUpdateEntries[i].descriptorType;
1760
1761 switch (create_info.pDescriptorUpdateEntries[i].descriptorType) {
1762 case VK_DESCRIPTOR_TYPE_SAMPLER:
1763 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
1764 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1765 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
1766 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
1767 write_entry.pImageInfo = reinterpret_cast<VkDescriptorImageInfo *>(update_entry);
1768 break;
1769
1770 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1771 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1772 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1773 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1774 write_entry.pBufferInfo = reinterpret_cast<VkDescriptorBufferInfo *>(update_entry);
1775 break;
1776
1777 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1778 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1779 write_entry.pTexelBufferView = reinterpret_cast<VkBufferView *>(update_entry);
1780 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -06001781 case VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT: {
1782 VkWriteDescriptorSetInlineUniformBlockEXT *inline_info = &inline_infos[i];
1783 inline_info->sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_INLINE_UNIFORM_BLOCK_EXT;
1784 inline_info->pNext = nullptr;
1785 inline_info->dataSize = create_info.pDescriptorUpdateEntries[i].descriptorCount;
1786 inline_info->pData = update_entry;
1787 write_entry.pNext = inline_info;
1788 // skip the rest of the array, they just represent bytes in the update
1789 j = create_info.pDescriptorUpdateEntries[i].descriptorCount;
1790 break;
1791 }
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001792 default:
1793 assert(0);
1794 break;
1795 }
1796 dst_array_element++;
1797 }
1798 }
John Zulaufb845eb22018-10-12 11:41:06 -06001799}
John Zulaufb45fdc32018-10-12 15:14:17 -06001800// These helper functions carry out the validate and record descriptor updates peformed via update templates. They decode
1801// the templatized data and leverage the non-template UpdateDescriptor helper functions.
1802bool cvdescriptorset::ValidateUpdateDescriptorSetsWithTemplateKHR(layer_data *device_data, VkDescriptorSet descriptorSet,
1803 const TEMPLATE_STATE *template_state, const void *pData) {
1804 // Translate the templated update into a normal update for validation...
1805 DecodedTemplateUpdate decoded_update(device_data, descriptorSet, template_state, pData);
1806 return ValidateUpdateDescriptorSets(GetReportData(device_data), device_data,
1807 static_cast<uint32_t>(decoded_update.desc_writes.size()), decoded_update.desc_writes.data(),
1808 0, NULL, "vkUpdateDescriptorSetWithTemplate()");
1809}
John Zulaufb845eb22018-10-12 11:41:06 -06001810
John Zulaufb845eb22018-10-12 11:41:06 -06001811void cvdescriptorset::PerformUpdateDescriptorSetsWithTemplateKHR(layer_data *device_data, VkDescriptorSet descriptorSet,
John Zulaufb45fdc32018-10-12 15:14:17 -06001812 const TEMPLATE_STATE *template_state, const void *pData) {
1813 // Translate the templated update into a normal update for validation...
1814 DecodedTemplateUpdate decoded_update(device_data, descriptorSet, template_state, pData);
John Zulaufb845eb22018-10-12 11:41:06 -06001815 PerformUpdateDescriptorSets(device_data, static_cast<uint32_t>(decoded_update.desc_writes.size()),
1816 decoded_update.desc_writes.data(), 0, NULL);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001817}
John Zulauf4e7bcb52018-11-02 10:46:30 -06001818
1819std::string cvdescriptorset::DescriptorSet::StringifySetAndLayout() const {
1820 std::string out;
1821 uint64_t layout_handle = HandleToUint64(p_layout_->GetDescriptorSetLayout());
1822 if (IsPushDescriptor()) {
1823 string_sprintf(&out, "Push Descriptors defined with VkDescriptorSetLayout 0x%" PRIxLEAST64, layout_handle);
John Zulauf4e7bcb52018-11-02 10:46:30 -06001824 } else {
1825 string_sprintf(&out, "VkDescriptorSet 0x%" PRIxLEAST64 "allocated with VkDescriptorSetLayout 0x%" PRIxLEAST64,
1826 HandleToUint64(set_), layout_handle);
1827 }
1828 return out;
1829};
1830
John Zulauf1d27e0a2018-11-05 10:12:48 -07001831// Loop through the write updates to validate for a push descriptor set, ignoring dstSet
1832bool cvdescriptorset::DescriptorSet::ValidatePushDescriptorsUpdate(const debug_report_data *report_data, uint32_t write_count,
1833 const VkWriteDescriptorSet *p_wds, const char *func_name) {
1834 assert(IsPushDescriptor());
1835 bool skip = false;
1836 for (uint32_t i = 0; i < write_count; i++) {
1837 std::string error_code;
1838 std::string error_str;
1839 if (!ValidateWriteUpdate(report_data, &p_wds[i], func_name, &error_code, &error_str)) {
1840 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT,
1841 HandleToUint64(p_layout_->GetDescriptorSetLayout()), error_code, "%s failed update validation: %s.",
1842 func_name, error_str.c_str());
1843 }
1844 }
1845 return skip;
1846}
1847
Tobin Ehlis300888c2016-05-18 13:43:26 -06001848// Validate the state for a given write update but don't actually perform the update
1849// If an error would occur for this update, return false and fill in details in error_msg string
1850bool cvdescriptorset::DescriptorSet::ValidateWriteUpdate(const debug_report_data *report_data, const VkWriteDescriptorSet *update,
John Zulaufb45fdc32018-10-12 15:14:17 -06001851 const char *func_name, std::string *error_code, std::string *error_msg) {
John Zulauf5dfd45c2018-01-17 11:06:34 -07001852 // Verify dst layout still valid
1853 if (p_layout_->IsDestroyed()) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001854 *error_code = "VUID-VkWriteDescriptorSet-dstSet-00320";
John Zulauf4e7bcb52018-11-02 10:46:30 -06001855 string_sprintf(error_msg, "Cannot call %s to perform write update on %s which has been destroyed", func_name,
1856 StringifySetAndLayout().c_str());
John Zulauf5dfd45c2018-01-17 11:06:34 -07001857 return false;
1858 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001859 // Verify dst binding exists
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001860 if (!p_layout_->HasBinding(update->dstBinding)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001861 *error_code = "VUID-VkWriteDescriptorSet-dstBinding-00315";
Tobin Ehlis300888c2016-05-18 13:43:26 -06001862 std::stringstream error_str;
John Zulauf4e7bcb52018-11-02 10:46:30 -06001863 error_str << StringifySetAndLayout() << " does not have binding " << update->dstBinding;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001864 *error_msg = error_str.str();
1865 return false;
Tobin Ehlis59a5efc2016-11-21 09:41:57 -07001866 } else {
1867 // Make sure binding isn't empty
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001868 if (0 == p_layout_->GetDescriptorCountFromBinding(update->dstBinding)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001869 *error_code = "VUID-VkWriteDescriptorSet-dstBinding-00316";
Tobin Ehlis59a5efc2016-11-21 09:41:57 -07001870 std::stringstream error_str;
John Zulauf4e7bcb52018-11-02 10:46:30 -06001871 error_str << StringifySetAndLayout() << " cannot updated binding " << update->dstBinding << " that has 0 descriptors";
Tobin Ehlis59a5efc2016-11-21 09:41:57 -07001872 *error_msg = error_str.str();
1873 return false;
1874 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001875 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05001876 // Verify idle ds
1877 if (in_use.load() &&
1878 !(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
1879 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
1880 // TODO : Re-using Free Idle error code, need write update idle error code
Dave Houlton00c154e2018-05-24 13:20:50 -06001881 *error_code = "VUID-vkFreeDescriptorSets-pDescriptorSets-00309";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001882 std::stringstream error_str;
John Zulauf4e7bcb52018-11-02 10:46:30 -06001883 error_str << "Cannot call " << func_name << " to perform write update on " << StringifySetAndLayout()
Jeff Bolzfdf96072018-04-10 14:32:18 -05001884 << " that is in use by a command buffer";
1885 *error_msg = error_str.str();
1886 return false;
1887 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001888 // We know that binding is valid, verify update and do update on each descriptor
John Zulaufc483f442017-12-15 14:02:06 -07001889 auto start_idx = p_layout_->GetGlobalIndexRangeFromBinding(update->dstBinding).start + update->dstArrayElement;
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001890 auto type = p_layout_->GetTypeFromBinding(update->dstBinding);
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001891 if (type != update->descriptorType) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001892 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00319";
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001893 std::stringstream error_str;
John Zulauf4e7bcb52018-11-02 10:46:30 -06001894 error_str << "Attempting write update to " << StringifySetAndLayout() << " binding #" << update->dstBinding << " with type "
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001895 << string_VkDescriptorType(type) << " but update type is " << string_VkDescriptorType(update->descriptorType);
1896 *error_msg = error_str.str();
1897 return false;
1898 }
Tobin Ehlis7b402352016-12-15 07:51:20 -07001899 if (update->descriptorCount > (descriptors_.size() - start_idx)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001900 *error_code = "VUID-VkWriteDescriptorSet-dstArrayElement-00321";
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001901 std::stringstream error_str;
John Zulauf4e7bcb52018-11-02 10:46:30 -06001902 error_str << "Attempting write update to " << StringifySetAndLayout() << " binding #" << update->dstBinding << " with "
Tobin Ehlis7b402352016-12-15 07:51:20 -07001903 << descriptors_.size() - start_idx
Tobin Ehlisf922ef82016-11-30 10:19:14 -07001904 << " descriptors in that binding and all successive bindings of the set, but update of "
1905 << update->descriptorCount << " descriptors combined with update array element offset of "
1906 << update->dstArrayElement << " oversteps the available number of consecutive descriptors";
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001907 *error_msg = error_str.str();
1908 return false;
1909 }
Jeff Bolze54ae892018-09-08 12:16:29 -05001910 if (type == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT) {
1911 if ((update->dstArrayElement % 4) != 0) {
1912 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-02219";
1913 std::stringstream error_str;
John Zulauf4e7bcb52018-11-02 10:46:30 -06001914 error_str << "Attempting write update to " << StringifySetAndLayout() << " binding #" << update->dstBinding << " with "
Jeff Bolze54ae892018-09-08 12:16:29 -05001915 << "dstArrayElement " << update->dstArrayElement << " not a multiple of 4";
1916 *error_msg = error_str.str();
1917 return false;
1918 }
1919 if ((update->descriptorCount % 4) != 0) {
1920 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-02220";
1921 std::stringstream error_str;
John Zulauf4e7bcb52018-11-02 10:46:30 -06001922 error_str << "Attempting write update to " << StringifySetAndLayout() << " binding #" << update->dstBinding << " with "
Jeff Bolze54ae892018-09-08 12:16:29 -05001923 << "descriptorCount " << update->descriptorCount << " not a multiple of 4";
1924 *error_msg = error_str.str();
1925 return false;
1926 }
1927 const auto *write_inline_info = lvl_find_in_chain<VkWriteDescriptorSetInlineUniformBlockEXT>(update->pNext);
1928 if (!write_inline_info || write_inline_info->dataSize != update->descriptorCount) {
1929 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-02221";
1930 std::stringstream error_str;
1931 if (!write_inline_info) {
John Zulauf4e7bcb52018-11-02 10:46:30 -06001932 error_str << "Attempting write update to " << StringifySetAndLayout() << " binding #" << update->dstBinding
1933 << " with "
Jeff Bolze54ae892018-09-08 12:16:29 -05001934 << "VkWriteDescriptorSetInlineUniformBlockEXT missing";
1935 } else {
John Zulauf4e7bcb52018-11-02 10:46:30 -06001936 error_str << "Attempting write update to " << StringifySetAndLayout() << " binding #" << update->dstBinding
1937 << " with "
Dave Houlton142c4cb2018-10-17 15:04:41 -06001938 << "VkWriteDescriptorSetInlineUniformBlockEXT dataSize " << write_inline_info->dataSize
1939 << " not equal to "
Jeff Bolze54ae892018-09-08 12:16:29 -05001940 << "VkWriteDescriptorSet descriptorCount " << update->descriptorCount;
1941 }
1942 *error_msg = error_str.str();
1943 return false;
1944 }
1945 // This error is probably unreachable due to the previous two errors
1946 if (write_inline_info && (write_inline_info->dataSize % 4) != 0) {
1947 *error_code = "VUID-VkWriteDescriptorSetInlineUniformBlockEXT-dataSize-02222";
1948 std::stringstream error_str;
John Zulauf4e7bcb52018-11-02 10:46:30 -06001949 error_str << "Attempting write update to " << StringifySetAndLayout() << " binding #" << update->dstBinding << " with "
Dave Houlton142c4cb2018-10-17 15:04:41 -06001950 << "VkWriteDescriptorSetInlineUniformBlockEXT dataSize " << write_inline_info->dataSize
1951 << " not a multiple of 4";
Jeff Bolze54ae892018-09-08 12:16:29 -05001952 *error_msg = error_str.str();
1953 return false;
1954 }
1955 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001956 // Verify consecutive bindings match (if needed)
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001957 if (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "write update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001958 set_, error_msg)) {
Tobin Ehlis48fbd692017-01-04 09:17:01 -07001959 // TODO : Should break out "consecutive binding updates" language into valid usage statements
Dave Houlton00c154e2018-05-24 13:20:50 -06001960 *error_code = "VUID-VkWriteDescriptorSet-dstArrayElement-00321";
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001961 return false;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001962 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001963 // Update is within bounds and consistent so last step is to validate update contents
John Zulaufb45fdc32018-10-12 15:14:17 -06001964 if (!VerifyWriteUpdateContents(update, start_idx, func_name, error_code, error_msg)) {
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001965 std::stringstream error_str;
John Zulauf4e7bcb52018-11-02 10:46:30 -06001966 error_str << "Write update to " << StringifySetAndLayout() << " binding #" << update->dstBinding
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001967 << " failed with error message: " << error_msg->c_str();
1968 *error_msg = error_str.str();
1969 return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001970 }
1971 // All checks passed, update is clean
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001972 return true;
Tobin Ehlis03d61de2016-05-17 08:31:46 -06001973}
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001974// For the given buffer, verify that its creation parameters are appropriate for the given type
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001975// If there's an error, update the error_msg string with details and return false, else return true
Tobin Ehlis4668dce2016-11-16 09:30:23 -07001976bool cvdescriptorset::DescriptorSet::ValidateBufferUsage(BUFFER_STATE const *buffer_node, VkDescriptorType type,
Dave Houlton00c154e2018-05-24 13:20:50 -06001977 std::string *error_code, std::string *error_msg) const {
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001978 // Verify that usage bits set correctly for given type
Tobin Ehlis94bc5d22016-06-02 07:46:52 -06001979 auto usage = buffer_node->createInfo.usage;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001980 std::string error_usage_bit;
1981 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001982 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1983 if (!(usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001984 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00334";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001985 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT";
1986 }
1987 break;
1988 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1989 if (!(usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001990 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00335";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001991 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT";
1992 }
1993 break;
1994 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1995 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1996 if (!(usage & VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001997 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00330";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001998 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT";
1999 }
2000 break;
2001 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
2002 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
2003 if (!(usage & VK_BUFFER_USAGE_STORAGE_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002004 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00331";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002005 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_BUFFER_BIT";
2006 }
2007 break;
2008 default:
2009 break;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06002010 }
2011 if (!error_usage_bit.empty()) {
2012 std::stringstream error_str;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002013 error_str << "Buffer (" << buffer_node->buffer << ") with usage mask 0x" << usage
2014 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
2015 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002016 *error_msg = error_str.str();
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06002017 return false;
2018 }
2019 return true;
2020}
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002021// For buffer descriptor updates, verify the buffer usage and VkDescriptorBufferInfo struct which includes:
2022// 1. buffer is valid
2023// 2. buffer was created with correct usage flags
2024// 3. offset is less than buffer size
2025// 4. range is either VK_WHOLE_SIZE or falls in (0, (buffer size - offset)]
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002026// 5. range and offset are within the device's limits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002027// If there's an error, update the error_msg string with details and return false, else return true
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002028bool cvdescriptorset::DescriptorSet::ValidateBufferUpdate(VkDescriptorBufferInfo const *buffer_info, VkDescriptorType type,
John Zulaufb45fdc32018-10-12 15:14:17 -06002029 const char *func_name, std::string *error_code,
2030 std::string *error_msg) const {
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002031 // First make sure that buffer is valid
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002032 auto buffer_node = GetBufferState(device_data_, buffer_info->buffer);
Tobin Ehlisfa8b6182016-12-22 13:40:45 -07002033 // Any invalid buffer should already be caught by object_tracker
2034 assert(buffer_node);
John Zulaufb45fdc32018-10-12 15:14:17 -06002035 if (ValidateMemoryIsBoundToBuffer(device_data_, buffer_node, func_name, "VUID-VkWriteDescriptorSet-descriptorType-00329")) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002036 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00329";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002037 *error_msg = "No memory bound to buffer.";
Tobin Ehlis81280962016-07-20 14:04:20 -06002038 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06002039 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002040 // Verify usage bits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002041 if (!ValidateBufferUsage(buffer_node, type, error_code, error_msg)) {
2042 // error_msg will have been updated by ValidateBufferUsage()
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002043 return false;
2044 }
2045 // offset must be less than buffer size
Jeremy Hayesd1a6a822017-03-09 14:39:45 -07002046 if (buffer_info->offset >= buffer_node->createInfo.size) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002047 *error_code = "VUID-VkDescriptorBufferInfo-offset-00340";
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002048 std::stringstream error_str;
Jeremy Hayesd1a6a822017-03-09 14:39:45 -07002049 error_str << "VkDescriptorBufferInfo offset of " << buffer_info->offset << " is greater than or equal to buffer "
2050 << buffer_node->buffer << " size of " << buffer_node->createInfo.size;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002051 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002052 return false;
2053 }
2054 if (buffer_info->range != VK_WHOLE_SIZE) {
2055 // Range must be VK_WHOLE_SIZE or > 0
2056 if (!buffer_info->range) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002057 *error_code = "VUID-VkDescriptorBufferInfo-range-00341";
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002058 std::stringstream error_str;
2059 error_str << "VkDescriptorBufferInfo range is not VK_WHOLE_SIZE and is zero, which is not allowed.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002060 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002061 return false;
2062 }
2063 // Range must be VK_WHOLE_SIZE or <= (buffer size - offset)
2064 if (buffer_info->range > (buffer_node->createInfo.size - buffer_info->offset)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002065 *error_code = "VUID-VkDescriptorBufferInfo-range-00342";
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002066 std::stringstream error_str;
2067 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range << " which is greater than buffer size ("
2068 << buffer_node->createInfo.size << ") minus requested offset of " << buffer_info->offset;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002069 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002070 return false;
2071 }
2072 }
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002073 // Check buffer update sizes against device limits
2074 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER == type || VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
2075 auto max_ub_range = limits_.maxUniformBufferRange;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002076 if (buffer_info->range != VK_WHOLE_SIZE && buffer_info->range > max_ub_range) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002077 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00332";
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002078 std::stringstream error_str;
2079 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range
2080 << " which is greater than this device's maxUniformBufferRange (" << max_ub_range << ")";
2081 *error_msg = error_str.str();
2082 return false;
Peter Kohaut2794a292018-07-13 11:13:47 +02002083 } else if (buffer_info->range == VK_WHOLE_SIZE && (buffer_node->createInfo.size - buffer_info->offset) > max_ub_range) {
2084 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00332";
2085 std::stringstream error_str;
Peter Kohaut18f413d2018-07-16 13:15:42 +02002086 error_str << "VkDescriptorBufferInfo range is VK_WHOLE_SIZE but effective range "
2087 << "(" << (buffer_node->createInfo.size - buffer_info->offset) << ") is greater than this device's "
Peter Kohaut2794a292018-07-13 11:13:47 +02002088 << "maxUniformBufferRange (" << max_ub_range << ")";
2089 *error_msg = error_str.str();
2090 return false;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002091 }
2092 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type || VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
2093 auto max_sb_range = limits_.maxStorageBufferRange;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002094 if (buffer_info->range != VK_WHOLE_SIZE && buffer_info->range > max_sb_range) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002095 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00333";
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002096 std::stringstream error_str;
2097 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range
2098 << " which is greater than this device's maxStorageBufferRange (" << max_sb_range << ")";
2099 *error_msg = error_str.str();
2100 return false;
Peter Kohaut2794a292018-07-13 11:13:47 +02002101 } else if (buffer_info->range == VK_WHOLE_SIZE && (buffer_node->createInfo.size - buffer_info->offset) > max_sb_range) {
2102 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00333";
2103 std::stringstream error_str;
Peter Kohaut18f413d2018-07-16 13:15:42 +02002104 error_str << "VkDescriptorBufferInfo range is VK_WHOLE_SIZE but effective range "
2105 << "(" << (buffer_node->createInfo.size - buffer_info->offset) << ") is greater than this device's "
Peter Kohaut2794a292018-07-13 11:13:47 +02002106 << "maxStorageBufferRange (" << max_sb_range << ")";
2107 *error_msg = error_str.str();
2108 return false;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002109 }
2110 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002111 return true;
2112}
2113
Tobin Ehlis300888c2016-05-18 13:43:26 -06002114// Verify that the contents of the update are ok, but don't perform actual update
2115bool cvdescriptorset::DescriptorSet::VerifyWriteUpdateContents(const VkWriteDescriptorSet *update, const uint32_t index,
John Zulaufb45fdc32018-10-12 15:14:17 -06002116 const char *func_name, std::string *error_code,
2117 std::string *error_msg) const {
Tobin Ehlis300888c2016-05-18 13:43:26 -06002118 switch (update->descriptorType) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002119 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
2120 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
2121 // Validate image
2122 auto image_view = update->pImageInfo[di].imageView;
2123 auto image_layout = update->pImageInfo[di].imageLayout;
John Zulaufb45fdc32018-10-12 15:14:17 -06002124 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, func_name, error_code,
2125 error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06002126 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002127 error_str << "Attempted write update to combined image sampler descriptor failed due to: "
2128 << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002129 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06002130 return false;
2131 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002132 }
2133 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002134 // fall through
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002135 case VK_DESCRIPTOR_TYPE_SAMPLER: {
2136 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
2137 if (!descriptors_[index + di].get()->IsImmutableSampler()) {
2138 if (!ValidateSampler(update->pImageInfo[di].sampler, device_data_)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002139 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00325";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002140 std::stringstream error_str;
2141 error_str << "Attempted write update to sampler descriptor with invalid sampler: "
2142 << update->pImageInfo[di].sampler << ".";
2143 *error_msg = error_str.str();
2144 return false;
2145 }
2146 } else {
2147 // TODO : Warn here
2148 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002149 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002150 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002151 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002152 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
2153 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
2154 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
2155 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
2156 auto image_view = update->pImageInfo[di].imageView;
2157 auto image_layout = update->pImageInfo[di].imageLayout;
John Zulaufb45fdc32018-10-12 15:14:17 -06002158 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, func_name, error_code,
2159 error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002160 std::stringstream error_str;
2161 error_str << "Attempted write update to image descriptor failed due to: " << error_msg->c_str();
2162 *error_msg = error_str.str();
2163 return false;
2164 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002165 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002166 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002167 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002168 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
2169 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER: {
2170 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
2171 auto buffer_view = update->pTexelBufferView[di];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002172 auto bv_state = GetBufferViewState(device_data_, buffer_view);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002173 if (!bv_state) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002174 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00323";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002175 std::stringstream error_str;
2176 error_str << "Attempted write update to texel buffer descriptor with invalid buffer view: " << buffer_view;
2177 *error_msg = error_str.str();
2178 return false;
2179 }
2180 auto buffer = bv_state->create_info.buffer;
Tobin Ehlisdf0d62a2017-10-11 08:48:00 -06002181 auto buffer_state = GetBufferState(device_data_, buffer);
2182 // Verify that buffer underlying the view hasn't been destroyed prematurely
2183 if (!buffer_state) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002184 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00323";
Tobin Ehlisdf0d62a2017-10-11 08:48:00 -06002185 std::stringstream error_str;
2186 error_str << "Attempted write update to texel buffer descriptor failed because underlying buffer (" << buffer
2187 << ") has been destroyed: " << error_msg->c_str();
2188 *error_msg = error_str.str();
2189 return false;
2190 } else if (!ValidateBufferUsage(buffer_state, update->descriptorType, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002191 std::stringstream error_str;
2192 error_str << "Attempted write update to texel buffer descriptor failed due to: " << error_msg->c_str();
2193 *error_msg = error_str.str();
2194 return false;
2195 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002196 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002197 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002198 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002199 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
2200 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
2201 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
2202 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC: {
2203 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
John Zulaufb45fdc32018-10-12 15:14:17 -06002204 if (!ValidateBufferUpdate(update->pBufferInfo + di, update->descriptorType, func_name, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002205 std::stringstream error_str;
2206 error_str << "Attempted write update to buffer descriptor failed due to: " << error_msg->c_str();
2207 *error_msg = error_str.str();
2208 return false;
2209 }
2210 }
2211 break;
2212 }
Jeff Bolze54ae892018-09-08 12:16:29 -05002213 case VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT:
2214 break;
Eric Werness30127fd2018-10-31 21:01:03 -07002215 case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV:
Jeff Bolzfbe51582018-09-13 10:01:35 -05002216 // XXX TODO
2217 break;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002218 default:
2219 assert(0); // We've already verified update type so should never get here
2220 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002221 }
2222 // All checks passed so update contents are good
2223 return true;
2224}
2225// Verify that the contents of the update are ok, but don't perform actual update
2226bool cvdescriptorset::DescriptorSet::VerifyCopyUpdateContents(const VkCopyDescriptorSet *update, const DescriptorSet *src_set,
John Zulaufb45fdc32018-10-12 15:14:17 -06002227 VkDescriptorType type, uint32_t index, const char *func_name,
2228 std::string *error_code, std::string *error_msg) const {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002229 // Note : Repurposing some Write update error codes here as specific details aren't called out for copy updates like they are
2230 // for write updates
Tobin Ehlis300888c2016-05-18 13:43:26 -06002231 switch (src_set->descriptors_[index]->descriptor_class) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002232 case PlainSampler: {
2233 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02002234 const auto src_desc = src_set->descriptors_[index + di].get();
2235 if (!src_desc->updated) continue;
2236 if (!src_desc->IsImmutableSampler()) {
2237 auto update_sampler = static_cast<SamplerDescriptor *>(src_desc)->GetSampler();
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002238 if (!ValidateSampler(update_sampler, device_data_)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002239 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00325";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002240 std::stringstream error_str;
2241 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
2242 *error_msg = error_str.str();
2243 return false;
2244 }
2245 } else {
2246 // TODO : Warn here
2247 }
2248 }
2249 break;
2250 }
2251 case ImageSampler: {
2252 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02002253 const auto src_desc = src_set->descriptors_[index + di].get();
2254 if (!src_desc->updated) continue;
2255 auto img_samp_desc = static_cast<const ImageSamplerDescriptor *>(src_desc);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002256 // First validate sampler
2257 if (!img_samp_desc->IsImmutableSampler()) {
2258 auto update_sampler = img_samp_desc->GetSampler();
2259 if (!ValidateSampler(update_sampler, device_data_)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002260 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00325";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002261 std::stringstream error_str;
2262 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
2263 *error_msg = error_str.str();
2264 return false;
2265 }
2266 } else {
2267 // TODO : Warn here
2268 }
2269 // Validate image
2270 auto image_view = img_samp_desc->GetImageView();
2271 auto image_layout = img_samp_desc->GetImageLayout();
John Zulaufb45fdc32018-10-12 15:14:17 -06002272 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, func_name, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06002273 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002274 error_str << "Attempted copy update to combined image sampler descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002275 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06002276 return false;
2277 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002278 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002279 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002280 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002281 case Image: {
2282 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02002283 const auto src_desc = src_set->descriptors_[index + di].get();
2284 if (!src_desc->updated) continue;
2285 auto img_desc = static_cast<const ImageDescriptor *>(src_desc);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002286 auto image_view = img_desc->GetImageView();
2287 auto image_layout = img_desc->GetImageLayout();
John Zulaufb45fdc32018-10-12 15:14:17 -06002288 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, func_name, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06002289 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002290 error_str << "Attempted copy update to image descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002291 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06002292 return false;
2293 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002294 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002295 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002296 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002297 case TexelBuffer: {
2298 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02002299 const auto src_desc = src_set->descriptors_[index + di].get();
2300 if (!src_desc->updated) continue;
2301 auto buffer_view = static_cast<TexelDescriptor *>(src_desc)->GetBufferView();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002302 auto bv_state = GetBufferViewState(device_data_, buffer_view);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002303 if (!bv_state) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002304 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00323";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002305 std::stringstream error_str;
2306 error_str << "Attempted copy update to texel buffer descriptor with invalid buffer view: " << buffer_view;
2307 *error_msg = error_str.str();
2308 return false;
2309 }
2310 auto buffer = bv_state->create_info.buffer;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002311 if (!ValidateBufferUsage(GetBufferState(device_data_, buffer), type, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002312 std::stringstream error_str;
2313 error_str << "Attempted copy update to texel buffer descriptor failed due to: " << error_msg->c_str();
2314 *error_msg = error_str.str();
2315 return false;
2316 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002317 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002318 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002319 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002320 case GeneralBuffer: {
2321 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02002322 const auto src_desc = src_set->descriptors_[index + di].get();
2323 if (!src_desc->updated) continue;
2324 auto buffer = static_cast<BufferDescriptor *>(src_desc)->GetBuffer();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002325 if (!ValidateBufferUsage(GetBufferState(device_data_, buffer), type, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002326 std::stringstream error_str;
2327 error_str << "Attempted copy update to buffer descriptor failed due to: " << error_msg->c_str();
2328 *error_msg = error_str.str();
2329 return false;
2330 }
Tobin Ehliscbcf2342016-05-24 13:07:12 -06002331 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002332 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002333 }
Jeff Bolze54ae892018-09-08 12:16:29 -05002334 case InlineUniform:
Jeff Bolzfbe51582018-09-13 10:01:35 -05002335 case AccelerationStructure:
Jeff Bolze54ae892018-09-08 12:16:29 -05002336 break;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002337 default:
2338 assert(0); // We've already verified update type so should never get here
2339 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002340 }
2341 // All checks passed so update contents are good
2342 return true;
Chris Forbesb4e0bdb2016-05-31 16:34:40 +12002343}
Tobin Ehlisf320b192017-03-14 11:22:50 -06002344// Update the common AllocateDescriptorSetsData
2345void cvdescriptorset::UpdateAllocateDescriptorSetsData(const layer_data *dev_data, const VkDescriptorSetAllocateInfo *p_alloc_info,
2346 AllocateDescriptorSetsData *ds_data) {
2347 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
2348 auto layout = GetDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
2349 if (layout) {
2350 ds_data->layout_nodes[i] = layout;
2351 // Count total descriptors required per type
2352 for (uint32_t j = 0; j < layout->GetBindingCount(); ++j) {
2353 const auto &binding_layout = layout->GetDescriptorSetLayoutBindingPtrFromIndex(j);
2354 uint32_t typeIndex = static_cast<uint32_t>(binding_layout->descriptorType);
2355 ds_data->required_descriptors_by_type[typeIndex] += binding_layout->descriptorCount;
2356 }
2357 }
2358 // Any unknown layouts will be flagged as errors during ValidateAllocateDescriptorSets() call
2359 }
Petr Kraus13c98a62017-12-09 00:22:39 +01002360}
Tobin Ehlisee471462016-05-26 11:21:59 -06002361// Verify that the state at allocate time is correct, but don't actually allocate the sets yet
Tobin Ehlisf320b192017-03-14 11:22:50 -06002362bool cvdescriptorset::ValidateAllocateDescriptorSets(const core_validation::layer_data *dev_data,
2363 const VkDescriptorSetAllocateInfo *p_alloc_info,
2364 const AllocateDescriptorSetsData *ds_data) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002365 bool skip = false;
Tobin Ehlisf320b192017-03-14 11:22:50 -06002366 auto report_data = core_validation::GetReportData(dev_data);
Jeff Bolzfdf96072018-04-10 14:32:18 -05002367 auto pool_state = GetDescriptorPoolState(dev_data, p_alloc_info->descriptorPool);
Tobin Ehlisee471462016-05-26 11:21:59 -06002368
2369 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002370 auto layout = GetDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
John Zulauf5562d062018-01-24 11:54:05 -07002371 if (layout) { // nullptr layout indicates no valid layout handle for this device, validated/logged in object_tracker
John Zulauf1d27e0a2018-11-05 10:12:48 -07002372 if (layout->IsPushDescriptor()) {
John Zulauf5562d062018-01-24 11:54:05 -07002373 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 -06002374 HandleToUint64(p_alloc_info->pSetLayouts[i]), "VUID-VkDescriptorSetAllocateInfo-pSetLayouts-00308",
John Zulauf5562d062018-01-24 11:54:05 -07002375 "Layout 0x%" PRIxLEAST64 " specified at pSetLayouts[%" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002376 "] in vkAllocateDescriptorSets() was created with invalid flag %s set.",
John Zulauf5562d062018-01-24 11:54:05 -07002377 HandleToUint64(p_alloc_info->pSetLayouts[i]), i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002378 "VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR");
John Zulauf5562d062018-01-24 11:54:05 -07002379 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05002380 if (layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT &&
2381 !(pool_state->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
2382 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 -06002383 0, "VUID-VkDescriptorSetAllocateInfo-pSetLayouts-03044",
Jeff Bolzfdf96072018-04-10 14:32:18 -05002384 "Descriptor set layout create flags and pool create flags mismatch for index (%d)", i);
2385 }
Tobin Ehlisee471462016-05-26 11:21:59 -06002386 }
2387 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002388 if (!GetDeviceExtensions(dev_data)->vk_khr_maintenance1) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002389 // Track number of descriptorSets allowable in this pool
2390 if (pool_state->availableSets < p_alloc_info->descriptorSetCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002391 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 -06002392 HandleToUint64(pool_state->pool), "VUID-VkDescriptorSetAllocateInfo-descriptorSetCount-00306",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002393 "Unable to allocate %u descriptorSets from pool 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002394 ". This pool only has %d descriptorSets remaining.",
2395 p_alloc_info->descriptorSetCount, HandleToUint64(pool_state->pool), pool_state->availableSets);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002396 }
2397 // Determine whether descriptor counts are satisfiable
Jeff Bolze54ae892018-09-08 12:16:29 -05002398 for (auto it = ds_data->required_descriptors_by_type.begin(); it != ds_data->required_descriptors_by_type.end(); ++it) {
2399 if (ds_data->required_descriptors_by_type.at(it->first) > pool_state->availableDescriptorTypeCount[it->first]) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002400 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 -06002401 HandleToUint64(pool_state->pool), "VUID-VkDescriptorSetAllocateInfo-descriptorPool-00307",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002402 "Unable to allocate %u descriptors of type %s from pool 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002403 ". This pool only has %d descriptors of this type remaining.",
Dave Houlton142c4cb2018-10-17 15:04:41 -06002404 ds_data->required_descriptors_by_type.at(it->first),
2405 string_VkDescriptorType(VkDescriptorType(it->first)), HandleToUint64(pool_state->pool),
2406 pool_state->availableDescriptorTypeCount[it->first]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002407 }
Tobin Ehlisee471462016-05-26 11:21:59 -06002408 }
2409 }
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06002410
Jeff Bolzfdf96072018-04-10 14:32:18 -05002411 const auto *count_allocate_info = lvl_find_in_chain<VkDescriptorSetVariableDescriptorCountAllocateInfoEXT>(p_alloc_info->pNext);
2412
2413 if (count_allocate_info) {
2414 if (count_allocate_info->descriptorSetCount != 0 &&
2415 count_allocate_info->descriptorSetCount != p_alloc_info->descriptorSetCount) {
2416 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 -06002417 "VUID-VkDescriptorSetVariableDescriptorCountAllocateInfoEXT-descriptorSetCount-03045",
Jeff Bolzfdf96072018-04-10 14:32:18 -05002418 "VkDescriptorSetAllocateInfo::descriptorSetCount (%d) != "
2419 "VkDescriptorSetVariableDescriptorCountAllocateInfoEXT::descriptorSetCount (%d)",
2420 p_alloc_info->descriptorSetCount, count_allocate_info->descriptorSetCount);
2421 }
2422 if (count_allocate_info->descriptorSetCount == p_alloc_info->descriptorSetCount) {
2423 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
2424 auto layout = GetDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
2425 if (count_allocate_info->pDescriptorCounts[i] > layout->GetDescriptorCountFromBinding(layout->GetMaxBinding())) {
2426 skip |= log_msg(
2427 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 -06002428 "VUID-VkDescriptorSetVariableDescriptorCountAllocateInfoEXT-pSetLayouts-03046",
2429 "pDescriptorCounts[%d] = (%d), binding's descriptorCount = (%d)", i,
Jeff Bolzfdf96072018-04-10 14:32:18 -05002430 count_allocate_info->pDescriptorCounts[i], layout->GetDescriptorCountFromBinding(layout->GetMaxBinding()));
2431 }
2432 }
2433 }
2434 }
2435
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002436 return skip;
Tobin Ehlisee471462016-05-26 11:21:59 -06002437}
2438// Decrement allocated sets from the pool and insert new sets into set_map
Tobin Ehlis4e380592016-06-02 12:41:47 -06002439void cvdescriptorset::PerformAllocateDescriptorSets(const VkDescriptorSetAllocateInfo *p_alloc_info,
2440 const VkDescriptorSet *descriptor_sets,
2441 const AllocateDescriptorSetsData *ds_data,
Tobin Ehlisbd711bd2016-10-12 14:27:30 -06002442 std::unordered_map<VkDescriptorPool, DESCRIPTOR_POOL_STATE *> *pool_map,
Tobin Ehlis4e380592016-06-02 12:41:47 -06002443 std::unordered_map<VkDescriptorSet, cvdescriptorset::DescriptorSet *> *set_map,
John Zulauf48a6a702017-12-22 17:14:54 -07002444 layer_data *dev_data) {
Tobin Ehlisee471462016-05-26 11:21:59 -06002445 auto pool_state = (*pool_map)[p_alloc_info->descriptorPool];
Mark Lobodzinskic9430182017-06-13 13:00:05 -06002446 // Account for sets and individual descriptors allocated from pool
Tobin Ehlisee471462016-05-26 11:21:59 -06002447 pool_state->availableSets -= p_alloc_info->descriptorSetCount;
Jeff Bolze54ae892018-09-08 12:16:29 -05002448 for (auto it = ds_data->required_descriptors_by_type.begin(); it != ds_data->required_descriptors_by_type.end(); ++it) {
2449 pool_state->availableDescriptorTypeCount[it->first] -= ds_data->required_descriptors_by_type.at(it->first);
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06002450 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05002451
2452 const auto *variable_count_info = lvl_find_in_chain<VkDescriptorSetVariableDescriptorCountAllocateInfoEXT>(p_alloc_info->pNext);
2453 bool variable_count_valid = variable_count_info && variable_count_info->descriptorSetCount == p_alloc_info->descriptorSetCount;
2454
Mark Lobodzinskic9430182017-06-13 13:00:05 -06002455 // Create tracking object for each descriptor set; insert into global map and the pool's set.
Tobin Ehlisee471462016-05-26 11:21:59 -06002456 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Jeff Bolzfdf96072018-04-10 14:32:18 -05002457 uint32_t variable_count = variable_count_valid ? variable_count_info->pDescriptorCounts[i] : 0;
2458
Tobin Ehlis93f22372016-10-12 14:34:12 -06002459 auto new_ds = new cvdescriptorset::DescriptorSet(descriptor_sets[i], p_alloc_info->descriptorPool, ds_data->layout_nodes[i],
Jeff Bolzfdf96072018-04-10 14:32:18 -05002460 variable_count, dev_data);
Tobin Ehlisee471462016-05-26 11:21:59 -06002461
2462 pool_state->sets.insert(new_ds);
2463 new_ds->in_use.store(0);
2464 (*set_map)[descriptor_sets[i]] = new_ds;
2465 }
2466}
John Zulauf48a6a702017-12-22 17:14:54 -07002467
2468cvdescriptorset::PrefilterBindRequestMap::PrefilterBindRequestMap(cvdescriptorset::DescriptorSet &ds, const BindingReqMap &in_map,
2469 GLOBAL_CB_NODE *cb_state)
2470 : filtered_map_(), orig_map_(in_map) {
2471 if (ds.GetTotalDescriptorCount() > kManyDescriptors_) {
2472 filtered_map_.reset(new std::map<uint32_t, descriptor_req>());
2473 ds.FilterAndTrackBindingReqs(cb_state, orig_map_, filtered_map_.get());
2474 }
2475}
2476cvdescriptorset::PrefilterBindRequestMap::PrefilterBindRequestMap(cvdescriptorset::DescriptorSet &ds, const BindingReqMap &in_map,
2477 GLOBAL_CB_NODE *cb_state, PIPELINE_STATE *pipeline)
2478 : filtered_map_(), orig_map_(in_map) {
2479 if (ds.GetTotalDescriptorCount() > kManyDescriptors_) {
2480 filtered_map_.reset(new std::map<uint32_t, descriptor_req>());
2481 ds.FilterAndTrackBindingReqs(cb_state, pipeline, orig_map_, filtered_map_.get());
2482 }
Artem Kharytoniuk2456f992018-01-12 14:17:41 +01002483}