blob: c63013f3bcb3ff5d122cdcbf57d87734dee492b9 [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
John Zulauf34ebf272018-02-16 13:08:47 -070057DescriptorSetLayoutId get_canonical_id(const VkDescriptorSetLayoutCreateInfo *p_create_info) {
58 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_);
139 return hc.Value();
140}
141//
142
John Zulauf1f8174b2018-02-16 12:58:37 -0700143// Return valid index or "end" i.e. binding_count_;
144// The asserts in "Get" are reduced to the set where no valid answer(like null or 0) could be given
145// Common code for all binding lookups.
146uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetIndexFromBinding(uint32_t binding) const {
147 const auto &bi_itr = binding_to_index_map_.find(binding);
148 if (bi_itr != binding_to_index_map_.cend()) return bi_itr->second;
149 return GetBindingCount();
150}
151VkDescriptorSetLayoutBinding const *cvdescriptorset::DescriptorSetLayoutDef::GetDescriptorSetLayoutBindingPtrFromIndex(
152 const uint32_t index) const {
153 if (index >= bindings_.size()) return nullptr;
154 return bindings_[index].ptr();
155}
156// Return descriptorCount for given index, 0 if index is unavailable
157uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetDescriptorCountFromIndex(const uint32_t index) const {
158 if (index >= bindings_.size()) return 0;
159 return bindings_[index].descriptorCount;
160}
161// For the given index, return descriptorType
162VkDescriptorType cvdescriptorset::DescriptorSetLayoutDef::GetTypeFromIndex(const uint32_t index) const {
163 assert(index < bindings_.size());
164 if (index < bindings_.size()) return bindings_[index].descriptorType;
165 return VK_DESCRIPTOR_TYPE_MAX_ENUM;
166}
167// For the given index, return stageFlags
168VkShaderStageFlags cvdescriptorset::DescriptorSetLayoutDef::GetStageFlagsFromIndex(const uint32_t index) const {
169 assert(index < bindings_.size());
170 if (index < bindings_.size()) return bindings_[index].stageFlags;
171 return VkShaderStageFlags(0);
172}
Jeff Bolzfdf96072018-04-10 14:32:18 -0500173// Return binding flags for given index, 0 if index is unavailable
174VkDescriptorBindingFlagsEXT cvdescriptorset::DescriptorSetLayoutDef::GetDescriptorBindingFlagsFromIndex(
175 const uint32_t index) const {
176 if (index >= binding_flags_.size()) return 0;
177 return binding_flags_[index];
178}
John Zulauf1f8174b2018-02-16 12:58:37 -0700179
180// For the given global index, return index
181uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetIndexFromGlobalIndex(const uint32_t global_index) const {
182 auto start_it = global_start_to_index_map_.upper_bound(global_index);
183 uint32_t index = binding_count_;
184 assert(start_it != global_start_to_index_map_.cbegin());
185 if (start_it != global_start_to_index_map_.cbegin()) {
186 --start_it;
187 index = start_it->second;
188#ifndef NDEBUG
189 const auto &range = GetGlobalIndexRangeFromBinding(bindings_[index].binding);
190 assert(range.start <= global_index && global_index < range.end);
191#endif
192 }
193 return index;
194}
195
196// For the given binding, return the global index range
197// As start and end are often needed in pairs, get both with a single hash lookup.
198const cvdescriptorset::IndexRange &cvdescriptorset::DescriptorSetLayoutDef::GetGlobalIndexRangeFromBinding(
199 const uint32_t binding) const {
200 assert(binding_to_global_index_range_map_.count(binding));
201 // In error case max uint32_t so index is out of bounds to break ASAP
202 const static IndexRange kInvalidRange = {0xFFFFFFFF, 0xFFFFFFFF};
203 const auto &range_it = binding_to_global_index_range_map_.find(binding);
204 if (range_it != binding_to_global_index_range_map_.end()) {
205 return range_it->second;
206 }
207 return kInvalidRange;
208}
209
210// For given binding, return ptr to ImmutableSampler array
211VkSampler const *cvdescriptorset::DescriptorSetLayoutDef::GetImmutableSamplerPtrFromBinding(const uint32_t binding) const {
212 const auto &bi_itr = binding_to_index_map_.find(binding);
213 if (bi_itr != binding_to_index_map_.end()) {
214 return bindings_[bi_itr->second].pImmutableSamplers;
215 }
216 return nullptr;
217}
218// Move to next valid binding having a non-zero binding count
219uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetNextValidBinding(const uint32_t binding) const {
220 auto it = non_empty_bindings_.upper_bound(binding);
221 assert(it != non_empty_bindings_.cend());
222 if (it != non_empty_bindings_.cend()) return *it;
223 return GetMaxBinding() + 1;
224}
225// For given index, return ptr to ImmutableSampler array
226VkSampler const *cvdescriptorset::DescriptorSetLayoutDef::GetImmutableSamplerPtrFromIndex(const uint32_t index) const {
227 if (index < bindings_.size()) {
228 return bindings_[index].pImmutableSamplers;
229 }
230 return nullptr;
231}
232// If our layout is compatible with rh_ds_layout, return true,
233// else return false and fill in error_msg will description of what causes incompatibility
234bool cvdescriptorset::DescriptorSetLayout::IsCompatible(DescriptorSetLayout const *const rh_ds_layout,
235 std::string *error_msg) const {
236 // Trivial case
237 if (layout_ == rh_ds_layout->GetDescriptorSetLayout()) return true;
John Zulaufd47d0612018-02-16 13:00:34 -0700238 if (get_layout_def() == rh_ds_layout->get_layout_def()) return true;
239 bool detailed_compat_check =
240 get_layout_def()->IsCompatible(layout_, rh_ds_layout->GetDescriptorSetLayout(), rh_ds_layout->get_layout_def(), error_msg);
241 // The detailed check should never tell us mismatching DSL are compatible
242 assert(!detailed_compat_check);
243 return detailed_compat_check;
John Zulauf1f8174b2018-02-16 12:58:37 -0700244}
245
John Zulaufdf3c5c12018-03-06 16:44:43 -0700246// Do a detailed compatibility check of this def (referenced by ds_layout), vs. the rhs (layout and def)
247// Should only be called if trivial accept has failed, and in that context should return false.
John Zulauf1f8174b2018-02-16 12:58:37 -0700248bool cvdescriptorset::DescriptorSetLayoutDef::IsCompatible(VkDescriptorSetLayout ds_layout, VkDescriptorSetLayout rh_ds_layout,
249 DescriptorSetLayoutDef const *const rh_ds_layout_def,
250 std::string *error_msg) const {
251 if (descriptor_count_ != rh_ds_layout_def->descriptor_count_) {
252 std::stringstream error_str;
253 error_str << "DescriptorSetLayout " << ds_layout << " has " << descriptor_count_ << " descriptors, but DescriptorSetLayout "
254 << rh_ds_layout << ", which comes from pipelineLayout, has " << rh_ds_layout_def->descriptor_count_
255 << " descriptors.";
256 *error_msg = error_str.str();
257 return false; // trivial fail case
258 }
John Zulaufd47d0612018-02-16 13:00:34 -0700259
John Zulauf1f8174b2018-02-16 12:58:37 -0700260 // Descriptor counts match so need to go through bindings one-by-one
261 // and verify that type and stageFlags match
262 for (auto binding : bindings_) {
263 // TODO : Do we also need to check immutable samplers?
264 // VkDescriptorSetLayoutBinding *rh_binding;
265 if (binding.descriptorCount != rh_ds_layout_def->GetDescriptorCountFromBinding(binding.binding)) {
266 std::stringstream error_str;
267 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << ds_layout << " has a descriptorCount of "
268 << binding.descriptorCount << " but binding " << binding.binding << " for DescriptorSetLayout "
269 << rh_ds_layout << ", which comes from pipelineLayout, has a descriptorCount of "
270 << rh_ds_layout_def->GetDescriptorCountFromBinding(binding.binding);
271 *error_msg = error_str.str();
272 return false;
273 } else if (binding.descriptorType != rh_ds_layout_def->GetTypeFromBinding(binding.binding)) {
274 std::stringstream error_str;
275 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << ds_layout << " is type '"
276 << string_VkDescriptorType(binding.descriptorType) << "' but binding " << binding.binding
277 << " for DescriptorSetLayout " << rh_ds_layout << ", which comes from pipelineLayout, is type '"
278 << string_VkDescriptorType(rh_ds_layout_def->GetTypeFromBinding(binding.binding)) << "'";
279 *error_msg = error_str.str();
280 return false;
281 } else if (binding.stageFlags != rh_ds_layout_def->GetStageFlagsFromBinding(binding.binding)) {
282 std::stringstream error_str;
283 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << ds_layout << " has stageFlags "
284 << binding.stageFlags << " but binding " << binding.binding << " for DescriptorSetLayout " << rh_ds_layout
285 << ", which comes from pipelineLayout, has stageFlags "
286 << rh_ds_layout_def->GetStageFlagsFromBinding(binding.binding);
287 *error_msg = error_str.str();
288 return false;
289 }
290 }
291 return true;
292}
293
294bool cvdescriptorset::DescriptorSetLayoutDef::IsNextBindingConsistent(const uint32_t binding) const {
295 if (!binding_to_index_map_.count(binding + 1)) return false;
296 auto const &bi_itr = binding_to_index_map_.find(binding);
297 if (bi_itr != binding_to_index_map_.end()) {
298 const auto &next_bi_itr = binding_to_index_map_.find(binding + 1);
299 if (next_bi_itr != binding_to_index_map_.end()) {
300 auto type = bindings_[bi_itr->second].descriptorType;
301 auto stage_flags = bindings_[bi_itr->second].stageFlags;
302 auto immut_samp = bindings_[bi_itr->second].pImmutableSamplers ? true : false;
Jeff Bolzfdf96072018-04-10 14:32:18 -0500303 auto flags = binding_flags_[bi_itr->second];
John Zulauf1f8174b2018-02-16 12:58:37 -0700304 if ((type != bindings_[next_bi_itr->second].descriptorType) ||
305 (stage_flags != bindings_[next_bi_itr->second].stageFlags) ||
Jeff Bolzfdf96072018-04-10 14:32:18 -0500306 (immut_samp != (bindings_[next_bi_itr->second].pImmutableSamplers ? true : false)) ||
307 (flags != binding_flags_[next_bi_itr->second])) {
John Zulauf1f8174b2018-02-16 12:58:37 -0700308 return false;
309 }
310 return true;
311 }
312 }
313 return false;
314}
315// Starting at offset descriptor of given binding, parse over update_count
316// descriptor updates and verify that for any binding boundaries that are crossed, the next binding(s) are all consistent
317// Consistency means that their type, stage flags, and whether or not they use immutable samplers matches
318// If so, return true. If not, fill in error_msg and return false
319bool cvdescriptorset::DescriptorSetLayoutDef::VerifyUpdateConsistency(uint32_t current_binding, uint32_t offset,
320 uint32_t update_count, const char *type,
321 const VkDescriptorSet set, std::string *error_msg) const {
322 // Verify consecutive bindings match (if needed)
323 auto orig_binding = current_binding;
324 // Track count of descriptors in the current_bindings that are remaining to be updated
325 auto binding_remaining = GetDescriptorCountFromBinding(current_binding);
326 // First, it's legal to offset beyond your own binding so handle that case
327 // Really this is just searching for the binding in which the update begins and adjusting offset accordingly
328 while (offset >= binding_remaining) {
329 // Advance to next binding, decrement offset by binding size
330 offset -= binding_remaining;
331 binding_remaining = GetDescriptorCountFromBinding(++current_binding);
332 }
333 binding_remaining -= offset;
334 while (update_count > binding_remaining) { // While our updates overstep current binding
335 // Verify next consecutive binding matches type, stage flags & immutable sampler use
336 if (!IsNextBindingConsistent(current_binding++)) {
337 std::stringstream error_str;
338 error_str << "Attempting " << type << " descriptor set " << set << " binding #" << orig_binding << " with #"
339 << update_count
340 << " descriptors being updated but this update oversteps the bounds of this binding and the next binding is "
341 "not consistent with current binding so this update is invalid.";
342 *error_msg = error_str.str();
343 return false;
344 }
345 // For sake of this check consider the bindings updated and grab count for next binding
346 update_count -= binding_remaining;
347 binding_remaining = GetDescriptorCountFromBinding(current_binding);
348 }
349 return true;
350}
351
352// The DescriptorSetLayout stores the per handle data for a descriptor set layout, and references the common defintion for the
353// handle invariant portion
354cvdescriptorset::DescriptorSetLayout::DescriptorSetLayout(const VkDescriptorSetLayoutCreateInfo *p_create_info,
355 const VkDescriptorSetLayout layout)
John Zulauf34ebf272018-02-16 13:08:47 -0700356 : layout_(layout), layout_destroyed_(false), layout_id_(get_canonical_id(p_create_info)) {}
John Zulauf1f8174b2018-02-16 12:58:37 -0700357
Tobin Ehlis154c2692016-10-25 09:36:53 -0600358// Validate descriptor set layout create info
Jeff Bolzfdf96072018-04-10 14:32:18 -0500359bool cvdescriptorset::DescriptorSetLayout::ValidateCreateInfo(
360 const debug_report_data *report_data, const VkDescriptorSetLayoutCreateInfo *create_info, const bool push_descriptor_ext,
361 const uint32_t max_push_descriptors, const bool descriptor_indexing_ext,
362 const VkPhysicalDeviceDescriptorIndexingFeaturesEXT *descriptor_indexing_features) {
Tobin Ehlis154c2692016-10-25 09:36:53 -0600363 bool skip = false;
364 std::unordered_set<uint32_t> bindings;
John Zulauf0fdeab32018-01-23 11:27:35 -0700365 uint64_t total_descriptors = 0;
366
Jeff Bolzfdf96072018-04-10 14:32:18 -0500367 const auto *flags_create_info = lvl_find_in_chain<VkDescriptorSetLayoutBindingFlagsCreateInfoEXT>(create_info->pNext);
368
369 const bool push_descriptor_set = !!(create_info->flags & VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR);
John Zulauf0fdeab32018-01-23 11:27:35 -0700370 if (push_descriptor_set && !push_descriptor_ext) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600371 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 -0600372 kVUID_Core_DrawState_ExtensionNotEnabled,
Mark Lobodzinskifb5a3e62018-04-13 10:46:48 -0600373 "Attempted to use %s in %s but its required extension %s has not been enabled.\n",
John Zulauf0fdeab32018-01-23 11:27:35 -0700374 "VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR", "VkDescriptorSetLayoutCreateInfo::flags",
375 VK_KHR_PUSH_DESCRIPTOR_EXTENSION_NAME);
376 }
377
Jeff Bolzfdf96072018-04-10 14:32:18 -0500378 const bool update_after_bind_set = !!(create_info->flags & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT);
379 if (update_after_bind_set && !descriptor_indexing_ext) {
380 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 -0600381 kVUID_Core_DrawState_ExtensionNotEnabled,
Jeff Bolzfdf96072018-04-10 14:32:18 -0500382 "Attemped to use %s in %s but its required extension %s has not been enabled.\n",
383 "VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT", "VkDescriptorSetLayoutCreateInfo::flags",
384 VK_EXT_DESCRIPTOR_INDEXING_EXTENSION_NAME);
385 }
386
John Zulauf0fdeab32018-01-23 11:27:35 -0700387 auto valid_type = [push_descriptor_set](const VkDescriptorType type) {
388 return !push_descriptor_set ||
389 ((type != VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC) && (type != VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC));
390 };
391
Jeff Bolzfdf96072018-04-10 14:32:18 -0500392 uint32_t max_binding = 0;
393
Tobin Ehlis154c2692016-10-25 09:36:53 -0600394 for (uint32_t i = 0; i < create_info->bindingCount; ++i) {
John Zulauf0fdeab32018-01-23 11:27:35 -0700395 const auto &binding_info = create_info->pBindings[i];
Jeff Bolzfdf96072018-04-10 14:32:18 -0500396 max_binding = std::max(max_binding, binding_info.binding);
397
John Zulauf0fdeab32018-01-23 11:27:35 -0700398 if (!bindings.insert(binding_info.binding).second) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600399 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 -0600400 "VUID-VkDescriptorSetLayoutCreateInfo-binding-00279",
401 "duplicated binding number in VkDescriptorSetLayoutBinding.");
Tobin Ehlis154c2692016-10-25 09:36:53 -0600402 }
John Zulauf0fdeab32018-01-23 11:27:35 -0700403 if (!valid_type(binding_info.descriptorType)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600404 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 -0600405 "VUID-VkDescriptorSetLayoutCreateInfo-flags-00280",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600406 "invalid type %s ,for push descriptors in VkDescriptorSetLayoutBinding entry %" PRIu32 ".",
407 string_VkDescriptorType(binding_info.descriptorType), i);
John Zulauf0fdeab32018-01-23 11:27:35 -0700408 }
409 total_descriptors += binding_info.descriptorCount;
Tobin Ehlis154c2692016-10-25 09:36:53 -0600410 }
John Zulauf0fdeab32018-01-23 11:27:35 -0700411
Jeff Bolzfdf96072018-04-10 14:32:18 -0500412 if (flags_create_info) {
413 if (flags_create_info->bindingCount != 0 && flags_create_info->bindingCount != create_info->bindingCount) {
414 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 -0600415 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-bindingCount-03002",
Jeff Bolzfdf96072018-04-10 14:32:18 -0500416 "VkDescriptorSetLayoutCreateInfo::bindingCount (%d) != "
417 "VkDescriptorSetLayoutBindingFlagsCreateInfoEXT::bindingCount (%d)",
418 create_info->bindingCount, flags_create_info->bindingCount);
419 }
420
421 if (flags_create_info->bindingCount == create_info->bindingCount) {
422 for (uint32_t i = 0; i < create_info->bindingCount; ++i) {
423 const auto &binding_info = create_info->pBindings[i];
424
425 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT) {
426 if (!update_after_bind_set) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600427 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
428 "VUID-VkDescriptorSetLayoutCreateInfo-flags-03000",
429 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500430 }
431
432 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER &&
433 !descriptor_indexing_features->descriptorBindingUniformBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600434 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
435 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
436 "descriptorBindingUniformBufferUpdateAfterBind-03005",
437 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500438 }
439 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_SAMPLER ||
440 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER ||
441 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE) &&
442 !descriptor_indexing_features->descriptorBindingSampledImageUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600443 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
444 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
445 "descriptorBindingSampledImageUpdateAfterBind-03006",
446 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500447 }
448 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_IMAGE &&
449 !descriptor_indexing_features->descriptorBindingStorageImageUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600450 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
451 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
452 "descriptorBindingStorageImageUpdateAfterBind-03007",
453 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500454 }
455 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER &&
456 !descriptor_indexing_features->descriptorBindingStorageBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600457 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
458 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
459 "descriptorBindingStorageBufferUpdateAfterBind-03008",
460 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500461 }
462 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER &&
463 !descriptor_indexing_features->descriptorBindingUniformTexelBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600464 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
465 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
466 "descriptorBindingUniformTexelBufferUpdateAfterBind-03009",
467 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500468 }
469 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER &&
470 !descriptor_indexing_features->descriptorBindingStorageTexelBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600471 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
472 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
473 "descriptorBindingStorageTexelBufferUpdateAfterBind-03010",
474 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500475 }
476 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT ||
477 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
478 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600479 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
480 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-None-03011",
481 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500482 }
483 }
484
485 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT) {
486 if (!descriptor_indexing_features->descriptorBindingUpdateUnusedWhilePending) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600487 skip |= log_msg(
488 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
489 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-descriptorBindingUpdateUnusedWhilePending-03012",
490 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500491 }
492 }
493
494 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT) {
495 if (!descriptor_indexing_features->descriptorBindingPartiallyBound) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600496 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
497 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-descriptorBindingPartiallyBound-03013",
498 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500499 }
500 }
501
502 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT_EXT) {
503 if (binding_info.binding != max_binding) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600504 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
505 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-pBindingFlags-03004",
506 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500507 }
508
509 if (!descriptor_indexing_features->descriptorBindingVariableDescriptorCount) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600510 skip |= log_msg(
511 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
512 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-descriptorBindingVariableDescriptorCount-03014",
513 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500514 }
515 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
516 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600517 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
518 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-pBindingFlags-03015",
519 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500520 }
521 }
522
523 if (push_descriptor_set &&
524 (flags_create_info->pBindingFlags[i] &
525 (VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT |
526 VK_DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT_EXT))) {
527 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 -0600528 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-flags-03003",
529 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500530 }
531 }
532 }
533 }
534
John Zulauf0fdeab32018-01-23 11:27:35 -0700535 if ((push_descriptor_set) && (total_descriptors > max_push_descriptors)) {
536 const char *undefined = push_descriptor_ext ? "" : " -- undefined";
Dave Houltond8ed0212018-05-16 17:18:24 -0600537 skip |=
538 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
539 "VUID-VkDescriptorSetLayoutCreateInfo-flags-00281",
540 "for push descriptor, total descriptor count in layout (%" PRIu64
541 ") must not be greater than VkPhysicalDevicePushDescriptorPropertiesKHR::maxPushDescriptors (%" PRIu32 "%s).",
542 total_descriptors, max_push_descriptors, undefined);
John Zulauf0fdeab32018-01-23 11:27:35 -0700543 }
544
Tobin Ehlis154c2692016-10-25 09:36:53 -0600545 return skip;
546}
547
Tobin Ehlis68d0adf2016-06-01 11:33:50 -0600548cvdescriptorset::AllocateDescriptorSetsData::AllocateDescriptorSetsData(uint32_t count)
549 : required_descriptors_by_type{}, layout_nodes(count, nullptr) {}
550
Tobin Ehlis93f22372016-10-12 14:34:12 -0600551cvdescriptorset::DescriptorSet::DescriptorSet(const VkDescriptorSet set, const VkDescriptorPool pool,
Jeff Bolzfdf96072018-04-10 14:32:18 -0500552 const std::shared_ptr<DescriptorSetLayout const> &layout, uint32_t variable_count,
553 layer_data *dev_data)
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -0700554 : some_update_(false),
555 set_(set),
556 pool_state_(nullptr),
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600557 p_layout_(layout),
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -0700558 device_data_(dev_data),
Jeff Bolzfdf96072018-04-10 14:32:18 -0500559 limits_(GetPhysDevProperties(dev_data)->properties.limits),
560 variable_count_(variable_count) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700561 pool_state_ = GetDescriptorPoolState(dev_data, pool);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600562 // Foreach binding, create default descriptors of given type
John Zulaufb6d71202017-12-22 16:47:09 -0700563 descriptors_.reserve(p_layout_->GetTotalDescriptorCount());
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600564 for (uint32_t i = 0; i < p_layout_->GetBindingCount(); ++i) {
565 auto type = p_layout_->GetTypeFromIndex(i);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600566 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700567 case VK_DESCRIPTOR_TYPE_SAMPLER: {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600568 auto immut_sampler = p_layout_->GetImmutableSamplerPtrFromIndex(i);
569 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
Tobin Ehlis082c7512017-05-08 11:24:57 -0600570 if (immut_sampler) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700571 descriptors_.emplace_back(new SamplerDescriptor(immut_sampler + di));
Tobin Ehlis082c7512017-05-08 11:24:57 -0600572 some_update_ = true; // Immutable samplers are updated at creation
573 } else
Chris Forbes9f340852017-05-09 08:51:38 -0700574 descriptors_.emplace_back(new SamplerDescriptor(nullptr));
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700575 }
576 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600577 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700578 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600579 auto immut = p_layout_->GetImmutableSamplerPtrFromIndex(i);
580 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
Tobin Ehlis082c7512017-05-08 11:24:57 -0600581 if (immut) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700582 descriptors_.emplace_back(new ImageSamplerDescriptor(immut + di));
Tobin Ehlis082c7512017-05-08 11:24:57 -0600583 some_update_ = true; // Immutable samplers are updated at creation
584 } else
Chris Forbes9f340852017-05-09 08:51:38 -0700585 descriptors_.emplace_back(new ImageSamplerDescriptor(nullptr));
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700586 }
587 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600588 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700589 // ImageDescriptors
590 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
591 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
592 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600593 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700594 descriptors_.emplace_back(new ImageDescriptor(type));
595 break;
596 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
597 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600598 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700599 descriptors_.emplace_back(new TexelDescriptor(type));
600 break;
601 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
602 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
603 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
604 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600605 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700606 descriptors_.emplace_back(new BufferDescriptor(type));
607 break;
608 default:
609 assert(0); // Bad descriptor type specified
610 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600611 }
612 }
613}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600614
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700615cvdescriptorset::DescriptorSet::~DescriptorSet() { InvalidateBoundCmdBuffers(); }
Chris Forbes57989132016-07-26 17:06:10 +1200616
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700617static std::string string_descriptor_req_view_type(descriptor_req req) {
618 std::string result("");
Chris Forbes57989132016-07-26 17:06:10 +1200619 for (unsigned i = 0; i <= VK_IMAGE_VIEW_TYPE_END_RANGE; i++) {
620 if (req & (1 << i)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700621 if (result.size()) result += ", ";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700622 result += string_VkImageViewType(VkImageViewType(i));
Chris Forbes57989132016-07-26 17:06:10 +1200623 }
624 }
625
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700626 if (!result.size()) result = "(none)";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700627
628 return result;
Chris Forbes57989132016-07-26 17:06:10 +1200629}
630
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600631// Is this sets underlying layout compatible with passed in layout according to "Pipeline Layout Compatibility" in spec?
Tobin Ehlis6dc57dd2017-06-21 10:08:52 -0600632bool cvdescriptorset::DescriptorSet::IsCompatible(DescriptorSetLayout const *const layout, std::string *error) const {
633 return layout->IsCompatible(p_layout_.get(), error);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600634}
Chris Forbes57989132016-07-26 17:06:10 +1200635
Tobin Ehlis3066db62016-08-22 08:12:23 -0600636// 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 -0600637// This includes validating that all descriptors in the given bindings are updated,
638// that any update buffers are valid, and that any dynamic offsets are within the bounds of their buffers.
639// Return true if state is acceptable, or false and write an error message into error string
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600640bool cvdescriptorset::DescriptorSet::ValidateDrawState(const std::map<uint32_t, descriptor_req> &bindings,
John Zulauf48a6a702017-12-22 17:14:54 -0700641 const std::vector<uint32_t> &dynamic_offsets, GLOBAL_CB_NODE *cb_node,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600642 const char *caller, std::string *error) const {
Chris Forbesc7090a82016-07-25 18:10:41 +1200643 for (auto binding_pair : bindings) {
644 auto binding = binding_pair.first;
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600645 if (!p_layout_->HasBinding(binding)) {
Tobin Ehlis58c59582016-06-21 12:34:33 -0600646 std::stringstream error_str;
647 error_str << "Attempting to validate DrawState for binding #" << binding
648 << " which is an invalid binding for this descriptor set.";
649 *error = error_str.str();
650 return false;
651 }
John Zulaufc483f442017-12-15 14:02:06 -0700652 IndexRange index_range = p_layout_->GetGlobalIndexRangeFromBinding(binding);
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700653 auto array_idx = 0; // Track array idx if we're dealing with array descriptors
Jeff Bolzfdf96072018-04-10 14:32:18 -0500654
655 if (IsVariableDescriptorCount(binding)) {
656 // Only validate the first N descriptors if it uses variable_count
657 index_range.end = index_range.start + GetVariableDescriptorCount();
658 }
659
John Zulaufc483f442017-12-15 14:02:06 -0700660 for (uint32_t i = index_range.start; i < index_range.end; ++i, ++array_idx) {
Jeff Bolzfdf96072018-04-10 14:32:18 -0500661 if (p_layout_->GetDescriptorBindingFlagsFromBinding(binding) & VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT) {
662 // Can't validate the descriptor because it may not have been updated,
663 // or the view could have been destroyed
664 continue;
665 } else if (!descriptors_[i]->updated) {
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700666 std::stringstream error_str;
667 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
668 << " is being used in draw but has not been updated.";
669 *error = error_str.str();
670 return false;
671 } else {
672 auto descriptor_class = descriptors_[i]->GetClass();
673 if (descriptor_class == GeneralBuffer) {
674 // Verify that buffers are valid
675 auto buffer = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetBuffer();
676 auto buffer_node = GetBufferState(device_data_, buffer);
677 if (!buffer_node) {
678 std::stringstream error_str;
679 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
680 << " references invalid buffer " << buffer << ".";
681 *error = error_str.str();
682 return false;
John Zulauf48a6a702017-12-22 17:14:54 -0700683 } else if (!buffer_node->sparse) {
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700684 for (auto mem_binding : buffer_node->GetBoundMemory()) {
685 if (!GetMemObjInfo(device_data_, mem_binding)) {
686 std::stringstream error_str;
687 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
688 << " uses buffer " << buffer << " that references invalid memory " << mem_binding << ".";
689 *error = error_str.str();
Tobin Ehlisc8266452017-04-07 12:20:30 -0600690 return false;
691 }
692 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700693 }
694 if (descriptors_[i]->IsDynamic()) {
695 // Validate that dynamic offsets are within the buffer
696 auto buffer_size = buffer_node->createInfo.size;
697 auto range = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetRange();
698 auto desc_offset = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetOffset();
699 auto dyn_offset = dynamic_offsets[GetDynamicOffsetIndexFromBinding(binding) + array_idx];
700 if (VK_WHOLE_SIZE == range) {
701 if ((dyn_offset + desc_offset) > buffer_size) {
702 std::stringstream error_str;
703 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
704 << " uses buffer " << buffer << " with update range of VK_WHOLE_SIZE has dynamic offset "
705 << dyn_offset << " combined with offset " << desc_offset
706 << " that oversteps the buffer size of " << buffer_size << ".";
707 *error = error_str.str();
708 return false;
709 }
710 } else {
711 if ((dyn_offset + desc_offset + range) > buffer_size) {
712 std::stringstream error_str;
713 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
714 << " uses buffer " << buffer << " with dynamic offset " << dyn_offset
715 << " combined with offset " << desc_offset << " and range " << range
716 << " that oversteps the buffer size of " << buffer_size << ".";
717 *error = error_str.str();
718 return false;
719 }
720 }
721 }
722 } else if (descriptor_class == ImageSampler || descriptor_class == Image) {
723 VkImageView image_view;
724 VkImageLayout image_layout;
725 if (descriptor_class == ImageSampler) {
726 image_view = static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetImageView();
727 image_layout = static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetImageLayout();
728 } else {
729 image_view = static_cast<ImageDescriptor *>(descriptors_[i].get())->GetImageView();
730 image_layout = static_cast<ImageDescriptor *>(descriptors_[i].get())->GetImageLayout();
731 }
732 auto reqs = binding_pair.second;
733
734 auto image_view_state = GetImageViewState(device_data_, image_view);
Tobin Ehlis836a1372017-07-14 11:25:21 -0600735 if (nullptr == image_view_state) {
736 // Image view must have been destroyed since initial update. Could potentially flag the descriptor
737 // as "invalid" (updated = false) at DestroyImageView() time and detect this error at bind time
738 std::stringstream error_str;
739 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
740 << " is using imageView " << image_view << " that has been destroyed.";
741 *error = error_str.str();
742 return false;
743 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700744 auto image_view_ci = image_view_state->create_info;
745
746 if ((reqs & DESCRIPTOR_REQ_ALL_VIEW_TYPE_BITS) && (~reqs & (1 << image_view_ci.viewType))) {
747 // bad view type
748 std::stringstream error_str;
749 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
750 << " requires an image view of type " << string_descriptor_req_view_type(reqs) << " but got "
751 << string_VkImageViewType(image_view_ci.viewType) << ".";
752 *error = error_str.str();
753 return false;
754 }
755
756 auto image_node = GetImageState(device_data_, image_view_ci.image);
757 assert(image_node);
758 // Verify Image Layout
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700759 // Copy first mip level into sub_layers and loop over each mip level to verify layout
760 VkImageSubresourceLayers sub_layers;
761 sub_layers.aspectMask = image_view_ci.subresourceRange.aspectMask;
762 sub_layers.baseArrayLayer = image_view_ci.subresourceRange.baseArrayLayer;
763 sub_layers.layerCount = image_view_ci.subresourceRange.layerCount;
764 bool hit_error = false;
765 for (auto cur_level = image_view_ci.subresourceRange.baseMipLevel;
766 cur_level < image_view_ci.subresourceRange.levelCount; ++cur_level) {
767 sub_layers.mipLevel = cur_level;
Cort Stratton7df30962018-05-17 19:45:57 -0700768 // No "invalid layout" VUID required for this call, since the optimal_layout parameter is UNDEFINED.
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700769 VerifyImageLayout(device_data_, cb_node, image_node, sub_layers, image_layout, VK_IMAGE_LAYOUT_UNDEFINED,
Cort Stratton7df30962018-05-17 19:45:57 -0700770 caller, kVUIDUndefined, "VUID-VkDescriptorImageInfo-imageLayout-00344", &hit_error);
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700771 if (hit_error) {
772 *error =
Dave Houltona9df0ce2018-02-07 10:51:23 -0700773 "Image layout specified at vkUpdateDescriptorSets() time doesn't match actual image layout at time "
774 "descriptor is used. See previous error callback for specific details.";
Chris Forbes57989132016-07-26 17:06:10 +1200775 return false;
776 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700777 }
778 // Verify Sample counts
779 if ((reqs & DESCRIPTOR_REQ_SINGLE_SAMPLE) && image_node->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
780 std::stringstream error_str;
781 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
782 << " requires bound image to have VK_SAMPLE_COUNT_1_BIT but got "
783 << string_VkSampleCountFlagBits(image_node->createInfo.samples) << ".";
784 *error = error_str.str();
785 return false;
786 }
787 if ((reqs & DESCRIPTOR_REQ_MULTI_SAMPLE) && image_node->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
788 std::stringstream error_str;
789 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
790 << " requires bound image to have multiple samples, but got VK_SAMPLE_COUNT_1_BIT.";
791 *error = error_str.str();
792 return false;
Chris Forbes57989132016-07-26 17:06:10 +1200793 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600794 }
Tobin Ehlisb1a2e4b2018-03-16 07:54:24 -0600795 if (descriptor_class == ImageSampler || descriptor_class == PlainSampler) {
796 // Verify Sampler still valid
797 VkSampler sampler;
798 if (descriptor_class == ImageSampler) {
799 sampler = static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetSampler();
800 } else {
801 sampler = static_cast<SamplerDescriptor *>(descriptors_[i].get())->GetSampler();
802 }
803 if (!ValidateSampler(sampler, device_data_)) {
804 std::stringstream error_str;
805 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
806 << " is using sampler " << sampler << " that has been destroyed.";
807 *error = error_str.str();
808 return false;
809 }
810 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600811 }
812 }
813 }
814 return true;
815}
Chris Forbes57989132016-07-26 17:06:10 +1200816
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600817// For given bindings, place any update buffers or images into the passed-in unordered_sets
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600818uint32_t cvdescriptorset::DescriptorSet::GetStorageUpdates(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600819 std::unordered_set<VkBuffer> *buffer_set,
820 std::unordered_set<VkImageView> *image_set) const {
821 auto num_updates = 0;
Chris Forbesc7090a82016-07-25 18:10:41 +1200822 for (auto binding_pair : bindings) {
823 auto binding = binding_pair.first;
Tobin Ehlis58c59582016-06-21 12:34:33 -0600824 // If a binding doesn't exist, skip it
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600825 if (!p_layout_->HasBinding(binding)) {
Tobin Ehlis58c59582016-06-21 12:34:33 -0600826 continue;
827 }
John Zulaufc483f442017-12-15 14:02:06 -0700828 uint32_t start_idx = p_layout_->GetGlobalIndexRangeFromBinding(binding).start;
Tobin Ehlis81f17852016-05-05 09:04:33 -0600829 if (descriptors_[start_idx]->IsStorage()) {
830 if (Image == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600831 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600832 if (descriptors_[start_idx + i]->updated) {
833 image_set->insert(static_cast<ImageDescriptor *>(descriptors_[start_idx + i].get())->GetImageView());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600834 num_updates++;
835 }
836 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600837 } else if (TexelBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600838 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600839 if (descriptors_[start_idx + i]->updated) {
840 auto bufferview = static_cast<TexelDescriptor *>(descriptors_[start_idx + i].get())->GetBufferView();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700841 auto bv_state = GetBufferViewState(device_data_, bufferview);
Tobin Ehlis8b872462016-09-14 08:12:08 -0600842 if (bv_state) {
843 buffer_set->insert(bv_state->create_info.buffer);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600844 num_updates++;
845 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600846 }
847 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600848 } else if (GeneralBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600849 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600850 if (descriptors_[start_idx + i]->updated) {
851 buffer_set->insert(static_cast<BufferDescriptor *>(descriptors_[start_idx + i].get())->GetBuffer());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600852 num_updates++;
853 }
854 }
855 }
856 }
857 }
858 return num_updates;
859}
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600860// Set is being deleted or updates so invalidate all bound cmd buffers
861void cvdescriptorset::DescriptorSet::InvalidateBoundCmdBuffers() {
Petr Krausbc7f5442017-05-14 23:43:38 +0200862 core_validation::invalidateCommandBuffers(device_data_, cb_bindings, {HandleToUint64(set_), kVulkanObjectTypeDescriptorSet});
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600863}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600864// Perform write update in given update struct
Tobin Ehlis300888c2016-05-18 13:43:26 -0600865void cvdescriptorset::DescriptorSet::PerformWriteUpdate(const VkWriteDescriptorSet *update) {
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700866 // Perform update on a per-binding basis as consecutive updates roll over to next binding
867 auto descriptors_remaining = update->descriptorCount;
868 auto binding_being_updated = update->dstBinding;
869 auto offset = update->dstArrayElement;
Tobin Ehlise16805c2017-08-09 09:10:37 -0600870 uint32_t update_index = 0;
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700871 while (descriptors_remaining) {
872 uint32_t update_count = std::min(descriptors_remaining, GetDescriptorCountFromBinding(binding_being_updated));
John Zulaufc483f442017-12-15 14:02:06 -0700873 auto global_idx = p_layout_->GetGlobalIndexRangeFromBinding(binding_being_updated).start + offset;
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700874 // Loop over the updates for a single binding at a time
Tobin Ehlise16805c2017-08-09 09:10:37 -0600875 for (uint32_t di = 0; di < update_count; ++di, ++update_index) {
876 descriptors_[global_idx + di]->WriteUpdate(update, update_index);
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700877 }
878 // Roll over to next binding in case of consecutive update
879 descriptors_remaining -= update_count;
880 offset = 0;
881 binding_being_updated++;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600882 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700883 if (update->descriptorCount) some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600884
Jeff Bolzfdf96072018-04-10 14:32:18 -0500885 if (!(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
886 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
887 InvalidateBoundCmdBuffers();
888 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600889}
Tobin Ehlis300888c2016-05-18 13:43:26 -0600890// Validate Copy update
891bool cvdescriptorset::DescriptorSet::ValidateCopyUpdate(const debug_report_data *report_data, const VkCopyDescriptorSet *update,
Dave Houlton00c154e2018-05-24 13:20:50 -0600892 const DescriptorSet *src_set, std::string *error_code,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600893 std::string *error_msg) {
John Zulauf5dfd45c2018-01-17 11:06:34 -0700894 // Verify dst layout still valid
895 if (p_layout_->IsDestroyed()) {
Dave Houlton00c154e2018-05-24 13:20:50 -0600896 *error_code = "VUID-VkCopyDescriptorSet-dstSet-parameter";
John Zulauf5dfd45c2018-01-17 11:06:34 -0700897 string_sprintf(error_msg,
898 "Cannot call vkUpdateDescriptorSets() to perform copy update on descriptor set dstSet 0x%" PRIxLEAST64
899 " created with destroyed VkDescriptorSetLayout 0x%" PRIxLEAST64,
900 HandleToUint64(set_), HandleToUint64(p_layout_->GetDescriptorSetLayout()));
901 return false;
902 }
903
904 // Verify src layout still valid
905 if (src_set->p_layout_->IsDestroyed()) {
Dave Houlton00c154e2018-05-24 13:20:50 -0600906 *error_code = "VUID-VkCopyDescriptorSet-srcSet-parameter";
John Zulauf5dfd45c2018-01-17 11:06:34 -0700907 string_sprintf(
908 error_msg,
909 "Cannot call vkUpdateDescriptorSets() to perform copy update of dstSet 0x%" PRIxLEAST64
910 " from descriptor set srcSet 0x%" PRIxLEAST64 " created with destroyed VkDescriptorSetLayout 0x%" PRIxLEAST64,
911 HandleToUint64(set_), HandleToUint64(src_set->set_), HandleToUint64(src_set->p_layout_->GetDescriptorSetLayout()));
912 return false;
913 }
914
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600915 if (!p_layout_->HasBinding(update->dstBinding)) {
Dave Houlton00c154e2018-05-24 13:20:50 -0600916 *error_code = "VUID-VkCopyDescriptorSet-dstBinding-00347";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600917 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700918 error_str << "DescriptorSet " << set_ << " does not have copy update dest binding of " << update->dstBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600919 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600920 return false;
921 }
922 if (!src_set->HasBinding(update->srcBinding)) {
Dave Houlton00c154e2018-05-24 13:20:50 -0600923 *error_code = "VUID-VkCopyDescriptorSet-srcBinding-00345";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600924 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700925 error_str << "DescriptorSet " << set_ << " does not have copy update src binding of " << update->srcBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600926 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600927 return false;
928 }
Jeff Bolzfdf96072018-04-10 14:32:18 -0500929 // Verify idle ds
930 if (in_use.load() &&
931 !(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
932 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
933 // TODO : Re-using Free Idle error code, need copy update idle error code
Dave Houlton00c154e2018-05-24 13:20:50 -0600934 *error_code = "VUID-vkFreeDescriptorSets-pDescriptorSets-00309";
Jeff Bolzfdf96072018-04-10 14:32:18 -0500935 std::stringstream error_str;
936 error_str << "Cannot call vkUpdateDescriptorSets() to perform copy update on descriptor set " << set_
937 << " that is in use by a command buffer";
938 *error_msg = error_str.str();
939 return false;
940 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600941 // src & dst set bindings are valid
942 // Check bounds of src & dst
John Zulaufc483f442017-12-15 14:02:06 -0700943 auto src_start_idx = src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start + update->srcArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600944 if ((src_start_idx + update->descriptorCount) > src_set->GetTotalDescriptorCount()) {
945 // SRC update out of bounds
Dave Houlton00c154e2018-05-24 13:20:50 -0600946 *error_code = "VUID-VkCopyDescriptorSet-srcArrayElement-00346";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600947 std::stringstream error_str;
948 error_str << "Attempting copy update from descriptorSet " << update->srcSet << " binding#" << update->srcBinding
John Zulaufc483f442017-12-15 14:02:06 -0700949 << " with offset index of " << src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600950 << " plus update array offset of " << update->srcArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700951 << " descriptors oversteps total number of descriptors in set: " << src_set->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600952 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600953 return false;
954 }
John Zulaufc483f442017-12-15 14:02:06 -0700955 auto dst_start_idx = p_layout_->GetGlobalIndexRangeFromBinding(update->dstBinding).start + update->dstArrayElement;
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600956 if ((dst_start_idx + update->descriptorCount) > p_layout_->GetTotalDescriptorCount()) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600957 // DST update out of bounds
Dave Houlton00c154e2018-05-24 13:20:50 -0600958 *error_code = "VUID-VkCopyDescriptorSet-dstArrayElement-00348";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600959 std::stringstream error_str;
960 error_str << "Attempting copy update to descriptorSet " << set_ << " binding#" << update->dstBinding
John Zulaufc483f442017-12-15 14:02:06 -0700961 << " with offset index of " << p_layout_->GetGlobalIndexRangeFromBinding(update->dstBinding).start
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600962 << " plus update array offset of " << update->dstArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600963 << " descriptors oversteps total number of descriptors in set: " << p_layout_->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600964 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600965 return false;
966 }
967 // Check that types match
Dave Houltond8ed0212018-05-16 17:18:24 -0600968 // TODO : Base default error case going from here is "VUID-VkAcquireNextImageInfoKHR-semaphore-parameter"2ba which covers all
969 // consistency issues, need more fine-grained error codes
Dave Houlton00c154e2018-05-24 13:20:50 -0600970 *error_code = "VUID-VkCopyDescriptorSet-srcSet-00349";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600971 auto src_type = src_set->GetTypeFromBinding(update->srcBinding);
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600972 auto dst_type = p_layout_->GetTypeFromBinding(update->dstBinding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600973 if (src_type != dst_type) {
974 std::stringstream error_str;
975 error_str << "Attempting copy update to descriptorSet " << set_ << " binding #" << update->dstBinding << " with type "
976 << string_VkDescriptorType(dst_type) << " from descriptorSet " << src_set->GetSet() << " binding #"
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700977 << update->srcBinding << " with type " << string_VkDescriptorType(src_type) << ". Types do not match";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600978 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600979 return false;
980 }
981 // Verify consistency of src & dst bindings if update crosses binding boundaries
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600982 if ((!src_set->GetLayout()->VerifyUpdateConsistency(update->srcBinding, update->srcArrayElement, update->descriptorCount,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600983 "copy update from", src_set->GetSet(), error_msg)) ||
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600984 (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "copy update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600985 set_, error_msg))) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600986 return false;
987 }
Jeff Bolzfdf96072018-04-10 14:32:18 -0500988
989 if ((src_set->GetLayout()->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT) &&
990 !(GetLayout()->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -0600991 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01918";
Jeff Bolzfdf96072018-04-10 14:32:18 -0500992 std::stringstream error_str;
993 error_str << "If pname:srcSet's (" << update->srcSet
994 << ") layout was created with the "
995 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag "
996 "set, then pname:dstSet's ("
997 << update->dstSet
998 << ") layout must: also have been created with the "
999 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag set";
1000 *error_msg = error_str.str();
1001 return false;
1002 }
1003
1004 if (!(src_set->GetLayout()->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT) &&
1005 (GetLayout()->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001006 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01919";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001007 std::stringstream error_str;
1008 error_str << "If pname:srcSet's (" << update->srcSet
1009 << ") layout was created without the "
1010 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag "
1011 "set, then pname:dstSet's ("
1012 << update->dstSet
1013 << ") layout must: also have been created without the "
1014 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag set";
1015 *error_msg = error_str.str();
1016 return false;
1017 }
1018
1019 if ((src_set->GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT) &&
1020 !(GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001021 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01920";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001022 std::stringstream error_str;
1023 error_str << "If the descriptor pool from which pname:srcSet (" << update->srcSet
1024 << ") was allocated was created "
1025 "with the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag "
1026 "set, then the descriptor pool from which pname:dstSet ("
1027 << update->dstSet
1028 << ") was allocated must: "
1029 "also have been created with the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag set";
1030 *error_msg = error_str.str();
1031 return false;
1032 }
1033
1034 if (!(src_set->GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT) &&
1035 (GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001036 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01921";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001037 std::stringstream error_str;
1038 error_str << "If the descriptor pool from which pname:srcSet (" << update->srcSet
1039 << ") was allocated was created "
1040 "without the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag "
1041 "set, then the descriptor pool from which pname:dstSet ("
1042 << update->dstSet
1043 << ") was allocated must: "
1044 "also have been created without the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag set";
1045 *error_msg = error_str.str();
1046 return false;
1047 }
1048
Tobin Ehlisd41e7b62016-05-19 07:56:18 -06001049 // Update parameters all look good and descriptor updated so verify update contents
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001050 if (!VerifyCopyUpdateContents(update, src_set, src_type, src_start_idx, error_code, error_msg)) return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001051
1052 // All checks passed so update is good
1053 return true;
1054}
1055// Perform Copy update
1056void cvdescriptorset::DescriptorSet::PerformCopyUpdate(const VkCopyDescriptorSet *update, const DescriptorSet *src_set) {
John Zulaufc483f442017-12-15 14:02:06 -07001057 auto src_start_idx = src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start + update->srcArrayElement;
1058 auto dst_start_idx = p_layout_->GetGlobalIndexRangeFromBinding(update->dstBinding).start + update->dstArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001059 // Update parameters all look good so perform update
1060 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02001061 auto src = src_set->descriptors_[src_start_idx + di].get();
1062 auto dst = descriptors_[dst_start_idx + di].get();
1063 if (src->updated) {
1064 dst->CopyUpdate(src);
1065 some_update_ = true;
1066 } else {
1067 dst->updated = false;
1068 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001069 }
Tobin Ehlis56a30942016-05-19 08:00:00 -06001070
Jeff Bolzfdf96072018-04-10 14:32:18 -05001071 if (!(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
1072 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
1073 InvalidateBoundCmdBuffers();
1074 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001075}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001076
Tobin Ehlisf9519102016-08-17 09:49:13 -06001077// Bind cb_node to this set and this set to cb_node.
1078// Prereq: This should be called for a set that has been confirmed to be active for the given cb_node, meaning it's going
1079// to be used in a draw by the given cb_node
Tobin Ehlis276d3d32016-12-21 09:21:06 -07001080void cvdescriptorset::DescriptorSet::BindCommandBuffer(GLOBAL_CB_NODE *cb_node,
Tobin Ehlis022528b2016-12-29 12:22:32 -07001081 const std::map<uint32_t, descriptor_req> &binding_req_map) {
Tobin Ehlis9252c2b2016-07-21 14:40:22 -06001082 // bind cb to this descriptor set
1083 cb_bindings.insert(cb_node);
Tobin Ehlis7ca20be2016-10-12 15:09:16 -06001084 // Add bindings for descriptor set, the set's pool, and individual objects in the set
Petr Krausbc7f5442017-05-14 23:43:38 +02001085 cb_node->object_bindings.insert({HandleToUint64(set_), kVulkanObjectTypeDescriptorSet});
Tobin Ehlis7ca20be2016-10-12 15:09:16 -06001086 pool_state_->cb_bindings.insert(cb_node);
Petr Krausbc7f5442017-05-14 23:43:38 +02001087 cb_node->object_bindings.insert({HandleToUint64(pool_state_->pool), kVulkanObjectTypeDescriptorPool});
Tobin Ehlisf9519102016-08-17 09:49:13 -06001088 // For the active slots, use set# to look up descriptorSet from boundDescriptorSets, and bind all of that descriptor set's
1089 // resources
Tobin Ehlis022528b2016-12-29 12:22:32 -07001090 for (auto binding_req_pair : binding_req_map) {
1091 auto binding = binding_req_pair.first;
John Zulaufc483f442017-12-15 14:02:06 -07001092 auto range = p_layout_->GetGlobalIndexRangeFromBinding(binding);
1093 for (uint32_t i = range.start; i < range.end; ++i) {
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001094 descriptors_[i]->BindCommandBuffer(device_data_, cb_node);
1095 }
1096 }
Tobin Ehlis9252c2b2016-07-21 14:40:22 -06001097}
John Zulauf48a6a702017-12-22 17:14:54 -07001098void cvdescriptorset::DescriptorSet::FilterAndTrackOneBindingReq(const BindingReqMap::value_type &binding_req_pair,
1099 const BindingReqMap &in_req, BindingReqMap *out_req,
1100 TrackedBindings *bindings) {
1101 assert(out_req);
1102 assert(bindings);
1103 const auto binding = binding_req_pair.first;
1104 // Use insert and look at the boolean ("was inserted") in the returned pair to see if this is a new set member.
1105 // Saves one hash lookup vs. find ... compare w/ end ... insert.
1106 const auto it_bool_pair = bindings->insert(binding);
1107 if (it_bool_pair.second) {
1108 out_req->emplace(binding_req_pair);
1109 }
1110}
1111void cvdescriptorset::DescriptorSet::FilterAndTrackOneBindingReq(const BindingReqMap::value_type &binding_req_pair,
1112 const BindingReqMap &in_req, BindingReqMap *out_req,
1113 TrackedBindings *bindings, uint32_t limit) {
1114 if (bindings->size() < limit) FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, bindings);
1115}
1116
1117void cvdescriptorset::DescriptorSet::FilterAndTrackBindingReqs(GLOBAL_CB_NODE *cb_state, const BindingReqMap &in_req,
1118 BindingReqMap *out_req) {
1119 TrackedBindings &bound = cached_validation_[cb_state].command_binding_and_usage;
1120 if (bound.size() == GetBindingCount()) {
1121 return; // All bindings are bound, out req is empty
1122 }
1123 for (const auto &binding_req_pair : in_req) {
1124 const auto binding = binding_req_pair.first;
1125 // If a binding doesn't exist, or has already been bound, skip it
1126 if (p_layout_->HasBinding(binding)) {
1127 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, &bound);
1128 }
1129 }
1130}
1131
1132void cvdescriptorset::DescriptorSet::FilterAndTrackBindingReqs(GLOBAL_CB_NODE *cb_state, PIPELINE_STATE *pipeline,
1133 const BindingReqMap &in_req, BindingReqMap *out_req) {
1134 auto &validated = cached_validation_[cb_state];
1135 auto &image_sample_val = validated.image_samplers[pipeline];
1136 auto *const dynamic_buffers = &validated.dynamic_buffers;
1137 auto *const non_dynamic_buffers = &validated.non_dynamic_buffers;
1138 const auto &stats = p_layout_->GetBindingTypeStats();
1139 for (const auto &binding_req_pair : in_req) {
1140 auto binding = binding_req_pair.first;
1141 VkDescriptorSetLayoutBinding const *layout_binding = p_layout_->GetDescriptorSetLayoutBindingPtrFromBinding(binding);
1142 if (!layout_binding) {
1143 continue;
1144 }
1145 // Caching criteria differs per type.
1146 // If image_layout have changed , the image descriptors need to be validated against them.
1147 if ((layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC) ||
1148 (layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
1149 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, dynamic_buffers, stats.dynamic_buffer_count);
1150 } else if ((layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER) ||
1151 (layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER)) {
1152 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, non_dynamic_buffers, stats.non_dynamic_buffer_count);
1153 } else {
1154 // This is rather crude, as the changed layouts may not impact the bound descriptors,
1155 // but the simple "versioning" is a simple "dirt" test.
1156 auto &version = image_sample_val[binding]; // Take advantage of default construtor zero initialzing new entries
1157 if (version != cb_state->image_layout_change_count) {
1158 version = cb_state->image_layout_change_count;
1159 out_req->emplace(binding_req_pair);
1160 }
1161 }
1162 }
1163}
Tobin Ehlis9252c2b2016-07-21 14:40:22 -06001164
Tobin Ehlis300888c2016-05-18 13:43:26 -06001165cvdescriptorset::SamplerDescriptor::SamplerDescriptor(const VkSampler *immut) : sampler_(VK_NULL_HANDLE), immutable_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001166 updated = false;
1167 descriptor_class = PlainSampler;
1168 if (immut) {
1169 sampler_ = *immut;
1170 immutable_ = true;
1171 updated = true;
1172 }
1173}
Tobin Ehlise2f80292016-06-02 10:08:53 -06001174// Validate given sampler. Currently this only checks to make sure it exists in the samplerMap
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001175bool cvdescriptorset::ValidateSampler(const VkSampler sampler, const layer_data *dev_data) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001176 return (GetSamplerState(dev_data, sampler) != nullptr);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001177}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001178
Tobin Ehlis554bf382016-05-24 11:14:43 -06001179bool cvdescriptorset::ValidateImageUpdate(VkImageView image_view, VkImageLayout image_layout, VkDescriptorType type,
Dave Houlton00c154e2018-05-24 13:20:50 -06001180 const layer_data *dev_data, std::string *error_code, std::string *error_msg) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001181 // TODO : Defaulting to 00943 for all cases here. Need to create new error codes for various cases.
Dave Houlton00c154e2018-05-24 13:20:50 -06001182 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00326";
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001183 auto iv_state = GetImageViewState(dev_data, image_view);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001184 if (!iv_state) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001185 std::stringstream error_str;
1186 error_str << "Invalid VkImageView: " << image_view;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001187 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001188 return false;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001189 }
Tobin Ehlis81280962016-07-20 14:04:20 -06001190 // 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 -06001191 // Validate that imageLayout is compatible with aspect_mask and image format
1192 // and validate that image usage bits are correct for given usage
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001193 VkImageAspectFlags aspect_mask = iv_state->create_info.subresourceRange.aspectMask;
1194 VkImage image = iv_state->create_info.image;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001195 VkFormat format = VK_FORMAT_MAX_ENUM;
1196 VkImageUsageFlags usage = 0;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001197 auto image_node = GetImageState(dev_data, image);
Tobin Ehlis1c9c55f2016-06-02 11:49:22 -06001198 if (image_node) {
1199 format = image_node->createInfo.format;
1200 usage = image_node->createInfo.usage;
Tobin Ehlis029d2fe2016-09-21 09:19:15 -06001201 // Validate that memory is bound to image
Tobin Ehlis2cb8eb22017-01-03 14:09:57 -07001202 // TODO: This should have its own valid usage id apart from 2524 which is from CreateImageView case. The only
1203 // the error here occurs is if memory bound to a created imageView has been freed.
Dave Houltond8ed0212018-05-16 17:18:24 -06001204 if (ValidateMemoryIsBoundToImage(dev_data, image_node, "vkUpdateDescriptorSets()",
1205 "VUID-VkImageViewCreateInfo-image-01020")) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001206 *error_code = "VUID-VkImageViewCreateInfo-image-01020";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001207 *error_msg = "No memory bound to image.";
Tobin Ehlis029d2fe2016-09-21 09:19:15 -06001208 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001209 }
Chris Forbes67757ff2017-07-21 13:59:01 -07001210
1211 // KHR_maintenance1 allows rendering into 2D or 2DArray views which slice a 3D image,
1212 // but not binding them to descriptor sets.
1213 if (image_node->createInfo.imageType == VK_IMAGE_TYPE_3D &&
1214 (iv_state->create_info.viewType == VK_IMAGE_VIEW_TYPE_2D ||
1215 iv_state->create_info.viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001216 *error_code = "VUID-VkDescriptorImageInfo-imageView-00343";
Chris Forbes67757ff2017-07-21 13:59:01 -07001217 *error_msg = "ImageView must not be a 2D or 2DArray view of a 3D image";
1218 return false;
1219 }
Tobin Ehlis1809f912016-05-25 09:24:36 -06001220 }
1221 // First validate that format and layout are compatible
1222 if (format == VK_FORMAT_MAX_ENUM) {
1223 std::stringstream error_str;
1224 error_str << "Invalid image (" << image << ") in imageView (" << image_view << ").";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001225 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001226 return false;
1227 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001228 // TODO : The various image aspect and format checks here are based on general spec language in 11.5 Image Views section under
1229 // vkCreateImageView(). What's the best way to create unique id for these cases?
Dave Houlton1d2022c2017-03-29 11:43:58 -06001230 bool ds = FormatIsDepthOrStencil(format);
Tobin Ehlis1809f912016-05-25 09:24:36 -06001231 switch (image_layout) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001232 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
1233 // Only Color bit must be set
1234 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobin Ehlis1809f912016-05-25 09:24:36 -06001235 std::stringstream error_str;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001236 error_str
1237 << "ImageView (" << image_view
1238 << ") 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 -06001239 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001240 return false;
1241 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001242 // format must NOT be DS
1243 if (ds) {
1244 std::stringstream error_str;
1245 error_str << "ImageView (" << image_view
1246 << ") uses layout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL but the image format is "
1247 << string_VkFormat(format) << " which is not a color format.";
1248 *error_msg = error_str.str();
1249 return false;
1250 }
1251 break;
1252 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
1253 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
1254 // Depth or stencil bit must be set, but both must NOT be set
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001255 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
1256 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
1257 // both must NOT be set
1258 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001259 error_str << "ImageView (" << image_view << ") has both STENCIL and DEPTH aspects set";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001260 *error_msg = error_str.str();
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001261 return false;
1262 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001263 } else if (!(aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
1264 // Neither were set
1265 std::stringstream error_str;
1266 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1267 << " but does not have STENCIL or DEPTH aspects set";
1268 *error_msg = error_str.str();
1269 return false;
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001270 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001271 // format must be DS
1272 if (!ds) {
1273 std::stringstream error_str;
1274 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1275 << " but the image format is " << string_VkFormat(format) << " which is not a depth/stencil format.";
1276 *error_msg = error_str.str();
1277 return false;
1278 }
1279 break;
1280 default:
1281 // For other layouts if the source is depth/stencil image, both aspect bits must not be set
1282 if (ds) {
1283 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
1284 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
1285 // both must NOT be set
1286 std::stringstream error_str;
1287 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1288 << " and is using depth/stencil image of format " << string_VkFormat(format)
1289 << " but it has both STENCIL and DEPTH aspects set, which is illegal. When using a depth/stencil "
1290 "image in a descriptor set, please only set either VK_IMAGE_ASPECT_DEPTH_BIT or "
1291 "VK_IMAGE_ASPECT_STENCIL_BIT depending on whether it will be used for depth reads or stencil "
1292 "reads respectively.";
1293 *error_msg = error_str.str();
1294 return false;
1295 }
1296 }
1297 }
1298 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001299 }
1300 // Now validate that usage flags are correctly set for given type of update
Tobin Ehlisfb4cf712016-10-10 14:02:48 -06001301 // 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 -06001302 // TODO : The various image usage bit requirements are in general spec language for VkImageUsageFlags bit block in 11.3 Images
1303 // under vkCreateImage()
Dave Houltond8ed0212018-05-16 17:18:24 -06001304 // TODO : Need to also validate case "VUID-VkWriteDescriptorSet-descriptorType-00336" where STORAGE_IMAGE & INPUT_ATTACH types
1305 // must have been created with identify swizzle
Tobin Ehlis1809f912016-05-25 09:24:36 -06001306 std::string error_usage_bit;
1307 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001308 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1309 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
1310 if (!(usage & VK_IMAGE_USAGE_SAMPLED_BIT)) {
1311 error_usage_bit = "VK_IMAGE_USAGE_SAMPLED_BIT";
1312 }
1313 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001314 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001315 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
1316 if (!(usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
1317 error_usage_bit = "VK_IMAGE_USAGE_STORAGE_BIT";
1318 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
1319 std::stringstream error_str;
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001320 // TODO : Need to create custom enum error codes for these cases
1321 if (image_node->shared_presentable) {
1322 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != image_layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001323 error_str << "ImageView (" << image_view
1324 << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type with a front-buffered image is being updated with "
1325 "layout "
1326 << string_VkImageLayout(image_layout)
1327 << " but according to spec section 13.1 Descriptor Types, 'Front-buffered images that report "
1328 "support for VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT must be in the "
1329 "VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR layout.'";
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001330 *error_msg = error_str.str();
1331 return false;
1332 }
1333 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001334 error_str << "ImageView (" << image_view
1335 << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type is being updated with layout "
1336 << string_VkImageLayout(image_layout)
1337 << " but according to spec section 13.1 Descriptor Types, 'Load and store operations on storage "
1338 "images can only be done on images in VK_IMAGE_LAYOUT_GENERAL layout.'";
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001339 *error_msg = error_str.str();
1340 return false;
1341 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001342 }
1343 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001344 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001345 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT: {
1346 if (!(usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) {
1347 error_usage_bit = "VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT";
1348 }
1349 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001350 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001351 default:
1352 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001353 }
1354 if (!error_usage_bit.empty()) {
1355 std::stringstream error_str;
1356 error_str << "ImageView (" << image_view << ") with usage mask 0x" << usage
1357 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
1358 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001359 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001360 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001361 }
1362 return true;
1363}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001364
Tobin Ehlis300888c2016-05-18 13:43:26 -06001365void cvdescriptorset::SamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Chris Forbesfea2c542018-04-13 09:34:15 -07001366 if (!immutable_) {
1367 sampler_ = update->pImageInfo[index].sampler;
1368 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001369 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001370}
1371
Tobin Ehlis300888c2016-05-18 13:43:26 -06001372void cvdescriptorset::SamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001373 if (!immutable_) {
1374 auto update_sampler = static_cast<const SamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001375 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001376 }
1377 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001378}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001379
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001380void cvdescriptorset::SamplerDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001381 if (!immutable_) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001382 auto sampler_state = GetSamplerState(dev_data, sampler_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001383 if (sampler_state) core_validation::AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001384 }
1385}
1386
Tobin Ehlis300888c2016-05-18 13:43:26 -06001387cvdescriptorset::ImageSamplerDescriptor::ImageSamplerDescriptor(const VkSampler *immut)
Chris Forbes9f340852017-05-09 08:51:38 -07001388 : sampler_(VK_NULL_HANDLE), immutable_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001389 updated = false;
1390 descriptor_class = ImageSampler;
1391 if (immut) {
1392 sampler_ = *immut;
1393 immutable_ = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001394 }
1395}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001396
Tobin Ehlis300888c2016-05-18 13:43:26 -06001397void cvdescriptorset::ImageSamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001398 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001399 const auto &image_info = update->pImageInfo[index];
Chris Forbesfea2c542018-04-13 09:34:15 -07001400 if (!immutable_) {
1401 sampler_ = image_info.sampler;
1402 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001403 image_view_ = image_info.imageView;
1404 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001405}
1406
Tobin Ehlis300888c2016-05-18 13:43:26 -06001407void cvdescriptorset::ImageSamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001408 if (!immutable_) {
1409 auto update_sampler = static_cast<const ImageSamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001410 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001411 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001412 auto image_view = static_cast<const ImageSamplerDescriptor *>(src)->image_view_;
1413 auto image_layout = static_cast<const ImageSamplerDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001414 updated = true;
1415 image_view_ = image_view;
1416 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001417}
1418
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001419void cvdescriptorset::ImageSamplerDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -06001420 // First add binding for any non-immutable sampler
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001421 if (!immutable_) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001422 auto sampler_state = GetSamplerState(dev_data, sampler_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001423 if (sampler_state) core_validation::AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001424 }
Tobin Ehlis81e46372016-08-17 13:33:44 -06001425 // Add binding for image
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001426 auto iv_state = GetImageViewState(dev_data, image_view_);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001427 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -06001428 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001429 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001430}
1431
Tobin Ehlis300888c2016-05-18 13:43:26 -06001432cvdescriptorset::ImageDescriptor::ImageDescriptor(const VkDescriptorType type)
1433 : storage_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001434 updated = false;
1435 descriptor_class = Image;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001436 if (VK_DESCRIPTOR_TYPE_STORAGE_IMAGE == type) storage_ = true;
Petr Kraus13c98a62017-12-09 00:22:39 +01001437}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001438
Tobin Ehlis300888c2016-05-18 13:43:26 -06001439void cvdescriptorset::ImageDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001440 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001441 const auto &image_info = update->pImageInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001442 image_view_ = image_info.imageView;
1443 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001444}
1445
Tobin Ehlis300888c2016-05-18 13:43:26 -06001446void cvdescriptorset::ImageDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001447 auto image_view = static_cast<const ImageDescriptor *>(src)->image_view_;
1448 auto image_layout = static_cast<const ImageDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001449 updated = true;
1450 image_view_ = image_view;
1451 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001452}
1453
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001454void cvdescriptorset::ImageDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -06001455 // Add binding for image
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001456 auto iv_state = GetImageViewState(dev_data, image_view_);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001457 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -06001458 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001459 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001460}
1461
Tobin Ehlis300888c2016-05-18 13:43:26 -06001462cvdescriptorset::BufferDescriptor::BufferDescriptor(const VkDescriptorType type)
1463 : storage_(false), dynamic_(false), buffer_(VK_NULL_HANDLE), offset_(0), range_(0) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001464 updated = false;
1465 descriptor_class = GeneralBuffer;
1466 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
1467 dynamic_ = true;
1468 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type) {
1469 storage_ = true;
1470 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
1471 dynamic_ = true;
1472 storage_ = true;
1473 }
1474}
Tobin Ehlis300888c2016-05-18 13:43:26 -06001475void cvdescriptorset::BufferDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001476 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001477 const auto &buffer_info = update->pBufferInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001478 buffer_ = buffer_info.buffer;
1479 offset_ = buffer_info.offset;
1480 range_ = buffer_info.range;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001481}
1482
Tobin Ehlis300888c2016-05-18 13:43:26 -06001483void cvdescriptorset::BufferDescriptor::CopyUpdate(const Descriptor *src) {
1484 auto buff_desc = static_cast<const BufferDescriptor *>(src);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001485 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001486 buffer_ = buff_desc->buffer_;
1487 offset_ = buff_desc->offset_;
1488 range_ = buff_desc->range_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001489}
1490
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001491void cvdescriptorset::BufferDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001492 auto buffer_node = GetBufferState(dev_data, buffer_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001493 if (buffer_node) core_validation::AddCommandBufferBindingBuffer(dev_data, cb_node, buffer_node);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001494}
1495
Tobin Ehlis300888c2016-05-18 13:43:26 -06001496cvdescriptorset::TexelDescriptor::TexelDescriptor(const VkDescriptorType type) : buffer_view_(VK_NULL_HANDLE), storage_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001497 updated = false;
1498 descriptor_class = TexelBuffer;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001499 if (VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER == type) storage_ = true;
Petr Kraus13c98a62017-12-09 00:22:39 +01001500}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001501
Tobin Ehlis300888c2016-05-18 13:43:26 -06001502void cvdescriptorset::TexelDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001503 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001504 buffer_view_ = update->pTexelBufferView[index];
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001505}
1506
Tobin Ehlis300888c2016-05-18 13:43:26 -06001507void cvdescriptorset::TexelDescriptor::CopyUpdate(const Descriptor *src) {
1508 updated = true;
1509 buffer_view_ = static_cast<const TexelDescriptor *>(src)->buffer_view_;
1510}
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001511
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001512void cvdescriptorset::TexelDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001513 auto bv_state = GetBufferViewState(dev_data, buffer_view_);
Tobin Ehlis8b872462016-09-14 08:12:08 -06001514 if (bv_state) {
Tobin Ehlis2515c0e2016-09-28 07:12:28 -06001515 core_validation::AddCommandBufferBindingBufferView(dev_data, cb_node, bv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001516 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001517}
1518
Tobin Ehlis300888c2016-05-18 13:43:26 -06001519// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1520// sets, and then calls their respective Validate[Write|Copy]Update functions.
1521// If the update hits an issue for which the callback returns "true", meaning that the call down the chain should
1522// be skipped, then true is returned.
1523// If there is no issue with the update, then false is returned.
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001524bool cvdescriptorset::ValidateUpdateDescriptorSets(const debug_report_data *report_data, const layer_data *dev_data,
1525 uint32_t write_count, const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001526 const VkCopyDescriptorSet *p_cds) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001527 bool skip = false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001528 // Validate Write updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001529 for (uint32_t i = 0; i < write_count; i++) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001530 auto dest_set = p_wds[i].dstSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001531 auto set_node = core_validation::GetSetNode(dev_data, dest_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001532 if (!set_node) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001533 skip |=
Tobin Ehlis300888c2016-05-18 13:43:26 -06001534 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06001535 HandleToUint64(dest_set), kVUID_Core_DrawState_InvalidDescriptorSet,
Tobin Ehlis300888c2016-05-18 13:43:26 -06001536 "Cannot call vkUpdateDescriptorSets() on descriptor set 0x%" PRIxLEAST64 " that has not been allocated.",
Petr Krausbc7f5442017-05-14 23:43:38 +02001537 HandleToUint64(dest_set));
Tobin Ehlis300888c2016-05-18 13:43:26 -06001538 } else {
Dave Houltond8ed0212018-05-16 17:18:24 -06001539 std::string error_code;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001540 std::string error_str;
Dave Houlton00c154e2018-05-24 13:20:50 -06001541 if (!set_node->ValidateWriteUpdate(report_data, &p_wds[i], &error_code, &error_str)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001542 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 -06001543 HandleToUint64(dest_set), error_code,
Artem Kharytoniuk2456f992018-01-12 14:17:41 +01001544 "vkUpdateDescriptorSets() failed write update validation for Descriptor Set 0x%" PRIx64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001545 " with error: %s.",
1546 HandleToUint64(dest_set), error_str.c_str());
Tobin Ehlis300888c2016-05-18 13:43:26 -06001547 }
1548 }
1549 }
1550 // Now validate copy updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001551 for (uint32_t i = 0; i < copy_count; ++i) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001552 auto dst_set = p_cds[i].dstSet;
1553 auto src_set = p_cds[i].srcSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001554 auto src_node = core_validation::GetSetNode(dev_data, src_set);
1555 auto dst_node = core_validation::GetSetNode(dev_data, dst_set);
Tobin Ehlisa1712752017-01-04 09:41:47 -07001556 // Object_tracker verifies that src & dest descriptor set are valid
1557 assert(src_node);
1558 assert(dst_node);
Dave Houltond8ed0212018-05-16 17:18:24 -06001559 std::string error_code;
Tobin Ehlisa1712752017-01-04 09:41:47 -07001560 std::string error_str;
Dave Houlton00c154e2018-05-24 13:20:50 -06001561 if (!dst_node->ValidateCopyUpdate(report_data, &p_cds[i], src_node, &error_code, &error_str)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001562 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 -06001563 HandleToUint64(dst_set), error_code,
Artem Kharytoniuk2456f992018-01-12 14:17:41 +01001564 "vkUpdateDescriptorSets() failed copy update from Descriptor Set 0x%" PRIx64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001565 " to Descriptor Set 0x%" PRIx64 " with error: %s.",
1566 HandleToUint64(src_set), HandleToUint64(dst_set), error_str.c_str());
Tobin Ehlis300888c2016-05-18 13:43:26 -06001567 }
1568 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001569 return skip;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001570}
1571// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1572// sets, and then calls their respective Perform[Write|Copy]Update functions.
1573// Prerequisite : ValidateUpdateDescriptorSets() should be called and return "false" prior to calling PerformUpdateDescriptorSets()
1574// with the same set of updates.
1575// This is split from the validate code to allow validation prior to calling down the chain, and then update after
1576// calling down the chain.
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001577void cvdescriptorset::PerformUpdateDescriptorSets(const layer_data *dev_data, uint32_t write_count,
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001578 const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
1579 const VkCopyDescriptorSet *p_cds) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001580 // Write updates first
1581 uint32_t i = 0;
1582 for (i = 0; i < write_count; ++i) {
1583 auto dest_set = p_wds[i].dstSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001584 auto set_node = core_validation::GetSetNode(dev_data, dest_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001585 if (set_node) {
1586 set_node->PerformWriteUpdate(&p_wds[i]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001587 }
1588 }
1589 // Now copy updates
1590 for (i = 0; i < copy_count; ++i) {
1591 auto dst_set = p_cds[i].dstSet;
1592 auto src_set = p_cds[i].srcSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001593 auto src_node = core_validation::GetSetNode(dev_data, src_set);
1594 auto dst_node = core_validation::GetSetNode(dev_data, dst_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001595 if (src_node && dst_node) {
1596 dst_node->PerformCopyUpdate(&p_cds[i], src_node);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001597 }
1598 }
1599}
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001600// This helper function carries out the state updates for descriptor updates peformed via update templates. It basically collects
1601// data and leverages the PerformUpdateDescriptor helper functions to do this.
1602void cvdescriptorset::PerformUpdateDescriptorSetsWithTemplateKHR(layer_data *device_data, VkDescriptorSet descriptorSet,
1603 std::unique_ptr<TEMPLATE_STATE> const &template_state,
1604 const void *pData) {
1605 auto const &create_info = template_state->create_info;
1606
1607 // Create a vector of write structs
1608 std::vector<VkWriteDescriptorSet> desc_writes;
1609 auto layout_obj = GetDescriptorSetLayout(device_data, create_info.descriptorSetLayout);
1610
1611 // Create a WriteDescriptorSet struct for each template update entry
1612 for (uint32_t i = 0; i < create_info.descriptorUpdateEntryCount; i++) {
1613 auto binding_count = layout_obj->GetDescriptorCountFromBinding(create_info.pDescriptorUpdateEntries[i].dstBinding);
1614 auto binding_being_updated = create_info.pDescriptorUpdateEntries[i].dstBinding;
1615 auto dst_array_element = create_info.pDescriptorUpdateEntries[i].dstArrayElement;
1616
John Zulaufb6d71202017-12-22 16:47:09 -07001617 desc_writes.reserve(desc_writes.size() + create_info.pDescriptorUpdateEntries[i].descriptorCount);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001618 for (uint32_t j = 0; j < create_info.pDescriptorUpdateEntries[i].descriptorCount; j++) {
1619 desc_writes.emplace_back();
1620 auto &write_entry = desc_writes.back();
1621
1622 size_t offset = create_info.pDescriptorUpdateEntries[i].offset + j * create_info.pDescriptorUpdateEntries[i].stride;
1623 char *update_entry = (char *)(pData) + offset;
1624
1625 if (dst_array_element >= binding_count) {
1626 dst_array_element = 0;
Mark Lobodzinski4aa479d2017-03-10 09:14:00 -07001627 binding_being_updated = layout_obj->GetNextValidBinding(binding_being_updated);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001628 }
1629
1630 write_entry.sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
1631 write_entry.pNext = NULL;
1632 write_entry.dstSet = descriptorSet;
1633 write_entry.dstBinding = binding_being_updated;
1634 write_entry.dstArrayElement = dst_array_element;
1635 write_entry.descriptorCount = 1;
1636 write_entry.descriptorType = create_info.pDescriptorUpdateEntries[i].descriptorType;
1637
1638 switch (create_info.pDescriptorUpdateEntries[i].descriptorType) {
1639 case VK_DESCRIPTOR_TYPE_SAMPLER:
1640 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
1641 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1642 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
1643 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
1644 write_entry.pImageInfo = reinterpret_cast<VkDescriptorImageInfo *>(update_entry);
1645 break;
1646
1647 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1648 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1649 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1650 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1651 write_entry.pBufferInfo = reinterpret_cast<VkDescriptorBufferInfo *>(update_entry);
1652 break;
1653
1654 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1655 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1656 write_entry.pTexelBufferView = reinterpret_cast<VkBufferView *>(update_entry);
1657 break;
1658 default:
1659 assert(0);
1660 break;
1661 }
1662 dst_array_element++;
1663 }
1664 }
1665 PerformUpdateDescriptorSets(device_data, static_cast<uint32_t>(desc_writes.size()), desc_writes.data(), 0, NULL);
1666}
Tobin Ehlis300888c2016-05-18 13:43:26 -06001667// Validate the state for a given write update but don't actually perform the update
1668// If an error would occur for this update, return false and fill in details in error_msg string
1669bool cvdescriptorset::DescriptorSet::ValidateWriteUpdate(const debug_report_data *report_data, const VkWriteDescriptorSet *update,
Dave Houlton00c154e2018-05-24 13:20:50 -06001670 std::string *error_code, std::string *error_msg) {
John Zulauf5dfd45c2018-01-17 11:06:34 -07001671 // Verify dst layout still valid
1672 if (p_layout_->IsDestroyed()) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001673 *error_code = "VUID-VkWriteDescriptorSet-dstSet-00320";
John Zulauf5dfd45c2018-01-17 11:06:34 -07001674 string_sprintf(error_msg,
1675 "Cannot call vkUpdateDescriptorSets() to perform write update on descriptor set 0x%" PRIxLEAST64
1676 " created with destroyed VkDescriptorSetLayout 0x%" PRIxLEAST64,
1677 HandleToUint64(set_), HandleToUint64(p_layout_->GetDescriptorSetLayout()));
1678 return false;
1679 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001680 // Verify dst binding exists
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001681 if (!p_layout_->HasBinding(update->dstBinding)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001682 *error_code = "VUID-VkWriteDescriptorSet-dstBinding-00315";
Tobin Ehlis300888c2016-05-18 13:43:26 -06001683 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001684 error_str << "DescriptorSet " << set_ << " does not have binding " << update->dstBinding;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001685 *error_msg = error_str.str();
1686 return false;
Tobin Ehlis59a5efc2016-11-21 09:41:57 -07001687 } else {
1688 // Make sure binding isn't empty
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001689 if (0 == p_layout_->GetDescriptorCountFromBinding(update->dstBinding)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001690 *error_code = "VUID-VkWriteDescriptorSet-dstBinding-00316";
Tobin Ehlis59a5efc2016-11-21 09:41:57 -07001691 std::stringstream error_str;
1692 error_str << "DescriptorSet " << set_ << " cannot updated binding " << update->dstBinding << " that has 0 descriptors";
1693 *error_msg = error_str.str();
1694 return false;
1695 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001696 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05001697 // Verify idle ds
1698 if (in_use.load() &&
1699 !(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
1700 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
1701 // TODO : Re-using Free Idle error code, need write update idle error code
Dave Houlton00c154e2018-05-24 13:20:50 -06001702 *error_code = "VUID-vkFreeDescriptorSets-pDescriptorSets-00309";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001703 std::stringstream error_str;
1704 error_str << "Cannot call vkUpdateDescriptorSets() to perform write update on descriptor set " << set_
1705 << " that is in use by a command buffer";
1706 *error_msg = error_str.str();
1707 return false;
1708 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001709 // We know that binding is valid, verify update and do update on each descriptor
John Zulaufc483f442017-12-15 14:02:06 -07001710 auto start_idx = p_layout_->GetGlobalIndexRangeFromBinding(update->dstBinding).start + update->dstArrayElement;
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001711 auto type = p_layout_->GetTypeFromBinding(update->dstBinding);
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001712 if (type != update->descriptorType) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001713 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00319";
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001714 std::stringstream error_str;
1715 error_str << "Attempting write update to descriptor set " << set_ << " binding #" << update->dstBinding << " with type "
1716 << string_VkDescriptorType(type) << " but update type is " << string_VkDescriptorType(update->descriptorType);
1717 *error_msg = error_str.str();
1718 return false;
1719 }
Tobin Ehlis7b402352016-12-15 07:51:20 -07001720 if (update->descriptorCount > (descriptors_.size() - start_idx)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001721 *error_code = "VUID-VkWriteDescriptorSet-dstArrayElement-00321";
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001722 std::stringstream error_str;
1723 error_str << "Attempting write update to descriptor set " << set_ << " binding #" << update->dstBinding << " with "
Tobin Ehlis7b402352016-12-15 07:51:20 -07001724 << descriptors_.size() - start_idx
Tobin Ehlisf922ef82016-11-30 10:19:14 -07001725 << " descriptors in that binding and all successive bindings of the set, but update of "
1726 << update->descriptorCount << " descriptors combined with update array element offset of "
1727 << update->dstArrayElement << " oversteps the available number of consecutive descriptors";
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001728 *error_msg = error_str.str();
1729 return false;
1730 }
1731 // Verify consecutive bindings match (if needed)
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001732 if (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "write update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001733 set_, error_msg)) {
Tobin Ehlis48fbd692017-01-04 09:17:01 -07001734 // TODO : Should break out "consecutive binding updates" language into valid usage statements
Dave Houlton00c154e2018-05-24 13:20:50 -06001735 *error_code = "VUID-VkWriteDescriptorSet-dstArrayElement-00321";
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001736 return false;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001737 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001738 // Update is within bounds and consistent so last step is to validate update contents
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001739 if (!VerifyWriteUpdateContents(update, start_idx, error_code, error_msg)) {
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001740 std::stringstream error_str;
1741 error_str << "Write update to descriptor in set " << set_ << " binding #" << update->dstBinding
1742 << " failed with error message: " << error_msg->c_str();
1743 *error_msg = error_str.str();
1744 return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001745 }
1746 // All checks passed, update is clean
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001747 return true;
Tobin Ehlis03d61de2016-05-17 08:31:46 -06001748}
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001749// For the given buffer, verify that its creation parameters are appropriate for the given type
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001750// 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 -07001751bool cvdescriptorset::DescriptorSet::ValidateBufferUsage(BUFFER_STATE const *buffer_node, VkDescriptorType type,
Dave Houlton00c154e2018-05-24 13:20:50 -06001752 std::string *error_code, std::string *error_msg) const {
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001753 // Verify that usage bits set correctly for given type
Tobin Ehlis94bc5d22016-06-02 07:46:52 -06001754 auto usage = buffer_node->createInfo.usage;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001755 std::string error_usage_bit;
1756 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001757 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1758 if (!(usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001759 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00334";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001760 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT";
1761 }
1762 break;
1763 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1764 if (!(usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001765 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00335";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001766 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT";
1767 }
1768 break;
1769 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1770 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1771 if (!(usage & VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001772 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00330";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001773 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT";
1774 }
1775 break;
1776 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1777 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1778 if (!(usage & VK_BUFFER_USAGE_STORAGE_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001779 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00331";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001780 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_BUFFER_BIT";
1781 }
1782 break;
1783 default:
1784 break;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001785 }
1786 if (!error_usage_bit.empty()) {
1787 std::stringstream error_str;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001788 error_str << "Buffer (" << buffer_node->buffer << ") with usage mask 0x" << usage
1789 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
1790 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001791 *error_msg = error_str.str();
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001792 return false;
1793 }
1794 return true;
1795}
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001796// For buffer descriptor updates, verify the buffer usage and VkDescriptorBufferInfo struct which includes:
1797// 1. buffer is valid
1798// 2. buffer was created with correct usage flags
1799// 3. offset is less than buffer size
1800// 4. range is either VK_WHOLE_SIZE or falls in (0, (buffer size - offset)]
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001801// 5. range and offset are within the device's limits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001802// 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 -06001803bool cvdescriptorset::DescriptorSet::ValidateBufferUpdate(VkDescriptorBufferInfo const *buffer_info, VkDescriptorType type,
Dave Houlton00c154e2018-05-24 13:20:50 -06001804 std::string *error_code, std::string *error_msg) const {
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001805 // First make sure that buffer is valid
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001806 auto buffer_node = GetBufferState(device_data_, buffer_info->buffer);
Tobin Ehlisfa8b6182016-12-22 13:40:45 -07001807 // Any invalid buffer should already be caught by object_tracker
1808 assert(buffer_node);
Dave Houltond8ed0212018-05-16 17:18:24 -06001809 if (ValidateMemoryIsBoundToBuffer(device_data_, buffer_node, "vkUpdateDescriptorSets()",
1810 "VUID-VkWriteDescriptorSet-descriptorType-00329")) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001811 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00329";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001812 *error_msg = "No memory bound to buffer.";
Tobin Ehlis81280962016-07-20 14:04:20 -06001813 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001814 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001815 // Verify usage bits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001816 if (!ValidateBufferUsage(buffer_node, type, error_code, error_msg)) {
1817 // error_msg will have been updated by ValidateBufferUsage()
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001818 return false;
1819 }
1820 // offset must be less than buffer size
Jeremy Hayesd1a6a822017-03-09 14:39:45 -07001821 if (buffer_info->offset >= buffer_node->createInfo.size) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001822 *error_code = "VUID-VkDescriptorBufferInfo-offset-00340";
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001823 std::stringstream error_str;
Jeremy Hayesd1a6a822017-03-09 14:39:45 -07001824 error_str << "VkDescriptorBufferInfo offset of " << buffer_info->offset << " is greater than or equal to buffer "
1825 << buffer_node->buffer << " size of " << buffer_node->createInfo.size;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001826 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001827 return false;
1828 }
1829 if (buffer_info->range != VK_WHOLE_SIZE) {
1830 // Range must be VK_WHOLE_SIZE or > 0
1831 if (!buffer_info->range) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001832 *error_code = "VUID-VkDescriptorBufferInfo-range-00341";
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001833 std::stringstream error_str;
1834 error_str << "VkDescriptorBufferInfo range is not VK_WHOLE_SIZE and is zero, which is not allowed.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001835 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001836 return false;
1837 }
1838 // Range must be VK_WHOLE_SIZE or <= (buffer size - offset)
1839 if (buffer_info->range > (buffer_node->createInfo.size - buffer_info->offset)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001840 *error_code = "VUID-VkDescriptorBufferInfo-range-00342";
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001841 std::stringstream error_str;
1842 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range << " which is greater than buffer size ("
1843 << buffer_node->createInfo.size << ") minus requested offset of " << buffer_info->offset;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001844 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001845 return false;
1846 }
1847 }
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001848 // Check buffer update sizes against device limits
1849 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER == type || VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
1850 auto max_ub_range = limits_.maxUniformBufferRange;
1851 // TODO : If range is WHOLE_SIZE, need to make sure underlying buffer size doesn't exceed device max
1852 if (buffer_info->range != VK_WHOLE_SIZE && buffer_info->range > max_ub_range) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001853 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00332";
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001854 std::stringstream error_str;
1855 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range
1856 << " which is greater than this device's maxUniformBufferRange (" << max_ub_range << ")";
1857 *error_msg = error_str.str();
1858 return false;
1859 }
1860 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type || VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
1861 auto max_sb_range = limits_.maxStorageBufferRange;
1862 // TODO : If range is WHOLE_SIZE, need to make sure underlying buffer size doesn't exceed device max
1863 if (buffer_info->range != VK_WHOLE_SIZE && buffer_info->range > max_sb_range) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001864 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00333";
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001865 std::stringstream error_str;
1866 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range
1867 << " which is greater than this device's maxStorageBufferRange (" << max_sb_range << ")";
1868 *error_msg = error_str.str();
1869 return false;
1870 }
1871 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001872 return true;
1873}
1874
Tobin Ehlis300888c2016-05-18 13:43:26 -06001875// Verify that the contents of the update are ok, but don't perform actual update
1876bool cvdescriptorset::DescriptorSet::VerifyWriteUpdateContents(const VkWriteDescriptorSet *update, const uint32_t index,
Dave Houlton00c154e2018-05-24 13:20:50 -06001877 std::string *error_code, std::string *error_msg) const {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001878 switch (update->descriptorType) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001879 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
1880 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1881 // Validate image
1882 auto image_view = update->pImageInfo[di].imageView;
1883 auto image_layout = update->pImageInfo[di].imageLayout;
1884 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001885 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001886 error_str << "Attempted write update to combined image sampler descriptor failed due to: "
1887 << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001888 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001889 return false;
1890 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001891 }
1892 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001893 // fall through
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001894 case VK_DESCRIPTOR_TYPE_SAMPLER: {
1895 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1896 if (!descriptors_[index + di].get()->IsImmutableSampler()) {
1897 if (!ValidateSampler(update->pImageInfo[di].sampler, device_data_)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001898 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00325";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001899 std::stringstream error_str;
1900 error_str << "Attempted write update to sampler descriptor with invalid sampler: "
1901 << update->pImageInfo[di].sampler << ".";
1902 *error_msg = error_str.str();
1903 return false;
1904 }
1905 } else {
1906 // TODO : Warn here
1907 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001908 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001909 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001910 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001911 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1912 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
1913 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
1914 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1915 auto image_view = update->pImageInfo[di].imageView;
1916 auto image_layout = update->pImageInfo[di].imageLayout;
1917 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, error_code, error_msg)) {
1918 std::stringstream error_str;
1919 error_str << "Attempted write update to image descriptor failed due to: " << error_msg->c_str();
1920 *error_msg = error_str.str();
1921 return false;
1922 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001923 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001924 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001925 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001926 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1927 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER: {
1928 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1929 auto buffer_view = update->pTexelBufferView[di];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001930 auto bv_state = GetBufferViewState(device_data_, buffer_view);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001931 if (!bv_state) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001932 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00323";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001933 std::stringstream error_str;
1934 error_str << "Attempted write update to texel buffer descriptor with invalid buffer view: " << buffer_view;
1935 *error_msg = error_str.str();
1936 return false;
1937 }
1938 auto buffer = bv_state->create_info.buffer;
Tobin Ehlisdf0d62a2017-10-11 08:48:00 -06001939 auto buffer_state = GetBufferState(device_data_, buffer);
1940 // Verify that buffer underlying the view hasn't been destroyed prematurely
1941 if (!buffer_state) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001942 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00323";
Tobin Ehlisdf0d62a2017-10-11 08:48:00 -06001943 std::stringstream error_str;
1944 error_str << "Attempted write update to texel buffer descriptor failed because underlying buffer (" << buffer
1945 << ") has been destroyed: " << error_msg->c_str();
1946 *error_msg = error_str.str();
1947 return false;
1948 } else if (!ValidateBufferUsage(buffer_state, update->descriptorType, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001949 std::stringstream error_str;
1950 error_str << "Attempted write update to texel buffer descriptor failed due to: " << error_msg->c_str();
1951 *error_msg = error_str.str();
1952 return false;
1953 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001954 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001955 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001956 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001957 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1958 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1959 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1960 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC: {
1961 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1962 if (!ValidateBufferUpdate(update->pBufferInfo + di, update->descriptorType, error_code, error_msg)) {
1963 std::stringstream error_str;
1964 error_str << "Attempted write update to buffer descriptor failed due to: " << error_msg->c_str();
1965 *error_msg = error_str.str();
1966 return false;
1967 }
1968 }
1969 break;
1970 }
1971 default:
1972 assert(0); // We've already verified update type so should never get here
1973 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001974 }
1975 // All checks passed so update contents are good
1976 return true;
1977}
1978// Verify that the contents of the update are ok, but don't perform actual update
1979bool cvdescriptorset::DescriptorSet::VerifyCopyUpdateContents(const VkCopyDescriptorSet *update, const DescriptorSet *src_set,
Dave Houlton00c154e2018-05-24 13:20:50 -06001980 VkDescriptorType type, uint32_t index, std::string *error_code,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001981 std::string *error_msg) const {
1982 // Note : Repurposing some Write update error codes here as specific details aren't called out for copy updates like they are
1983 // for write updates
Tobin Ehlis300888c2016-05-18 13:43:26 -06001984 switch (src_set->descriptors_[index]->descriptor_class) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001985 case PlainSampler: {
1986 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02001987 const auto src_desc = src_set->descriptors_[index + di].get();
1988 if (!src_desc->updated) continue;
1989 if (!src_desc->IsImmutableSampler()) {
1990 auto update_sampler = static_cast<SamplerDescriptor *>(src_desc)->GetSampler();
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001991 if (!ValidateSampler(update_sampler, device_data_)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001992 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00325";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001993 std::stringstream error_str;
1994 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
1995 *error_msg = error_str.str();
1996 return false;
1997 }
1998 } else {
1999 // TODO : Warn here
2000 }
2001 }
2002 break;
2003 }
2004 case ImageSampler: {
2005 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02002006 const auto src_desc = src_set->descriptors_[index + di].get();
2007 if (!src_desc->updated) continue;
2008 auto img_samp_desc = static_cast<const ImageSamplerDescriptor *>(src_desc);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002009 // First validate sampler
2010 if (!img_samp_desc->IsImmutableSampler()) {
2011 auto update_sampler = img_samp_desc->GetSampler();
2012 if (!ValidateSampler(update_sampler, device_data_)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002013 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00325";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002014 std::stringstream error_str;
2015 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
2016 *error_msg = error_str.str();
2017 return false;
2018 }
2019 } else {
2020 // TODO : Warn here
2021 }
2022 // Validate image
2023 auto image_view = img_samp_desc->GetImageView();
2024 auto image_layout = img_samp_desc->GetImageLayout();
2025 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06002026 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002027 error_str << "Attempted copy update to combined image sampler descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002028 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06002029 return false;
2030 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002031 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002032 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002033 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002034 case Image: {
2035 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02002036 const auto src_desc = src_set->descriptors_[index + di].get();
2037 if (!src_desc->updated) continue;
2038 auto img_desc = static_cast<const ImageDescriptor *>(src_desc);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002039 auto image_view = img_desc->GetImageView();
2040 auto image_layout = img_desc->GetImageLayout();
2041 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06002042 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002043 error_str << "Attempted copy update to image descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002044 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06002045 return false;
2046 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002047 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002048 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002049 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002050 case TexelBuffer: {
2051 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02002052 const auto src_desc = src_set->descriptors_[index + di].get();
2053 if (!src_desc->updated) continue;
2054 auto buffer_view = static_cast<TexelDescriptor *>(src_desc)->GetBufferView();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002055 auto bv_state = GetBufferViewState(device_data_, buffer_view);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002056 if (!bv_state) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002057 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00323";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002058 std::stringstream error_str;
2059 error_str << "Attempted copy update to texel buffer descriptor with invalid buffer view: " << buffer_view;
2060 *error_msg = error_str.str();
2061 return false;
2062 }
2063 auto buffer = bv_state->create_info.buffer;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002064 if (!ValidateBufferUsage(GetBufferState(device_data_, buffer), type, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002065 std::stringstream error_str;
2066 error_str << "Attempted copy update to texel buffer descriptor failed due to: " << error_msg->c_str();
2067 *error_msg = error_str.str();
2068 return false;
2069 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002070 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002071 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002072 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002073 case GeneralBuffer: {
2074 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02002075 const auto src_desc = src_set->descriptors_[index + di].get();
2076 if (!src_desc->updated) continue;
2077 auto buffer = static_cast<BufferDescriptor *>(src_desc)->GetBuffer();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002078 if (!ValidateBufferUsage(GetBufferState(device_data_, buffer), type, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002079 std::stringstream error_str;
2080 error_str << "Attempted copy update to buffer descriptor failed due to: " << error_msg->c_str();
2081 *error_msg = error_str.str();
2082 return false;
2083 }
Tobin Ehliscbcf2342016-05-24 13:07:12 -06002084 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002085 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002086 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002087 default:
2088 assert(0); // We've already verified update type so should never get here
2089 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002090 }
2091 // All checks passed so update contents are good
2092 return true;
Chris Forbesb4e0bdb2016-05-31 16:34:40 +12002093}
Tobin Ehlisf320b192017-03-14 11:22:50 -06002094// Update the common AllocateDescriptorSetsData
2095void cvdescriptorset::UpdateAllocateDescriptorSetsData(const layer_data *dev_data, const VkDescriptorSetAllocateInfo *p_alloc_info,
2096 AllocateDescriptorSetsData *ds_data) {
2097 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
2098 auto layout = GetDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
2099 if (layout) {
2100 ds_data->layout_nodes[i] = layout;
2101 // Count total descriptors required per type
2102 for (uint32_t j = 0; j < layout->GetBindingCount(); ++j) {
2103 const auto &binding_layout = layout->GetDescriptorSetLayoutBindingPtrFromIndex(j);
2104 uint32_t typeIndex = static_cast<uint32_t>(binding_layout->descriptorType);
2105 ds_data->required_descriptors_by_type[typeIndex] += binding_layout->descriptorCount;
2106 }
2107 }
2108 // Any unknown layouts will be flagged as errors during ValidateAllocateDescriptorSets() call
2109 }
Petr Kraus13c98a62017-12-09 00:22:39 +01002110}
Tobin Ehlisee471462016-05-26 11:21:59 -06002111// Verify that the state at allocate time is correct, but don't actually allocate the sets yet
Tobin Ehlisf320b192017-03-14 11:22:50 -06002112bool cvdescriptorset::ValidateAllocateDescriptorSets(const core_validation::layer_data *dev_data,
2113 const VkDescriptorSetAllocateInfo *p_alloc_info,
2114 const AllocateDescriptorSetsData *ds_data) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002115 bool skip = false;
Tobin Ehlisf320b192017-03-14 11:22:50 -06002116 auto report_data = core_validation::GetReportData(dev_data);
Jeff Bolzfdf96072018-04-10 14:32:18 -05002117 auto pool_state = GetDescriptorPoolState(dev_data, p_alloc_info->descriptorPool);
Tobin Ehlisee471462016-05-26 11:21:59 -06002118
2119 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002120 auto layout = GetDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
John Zulauf5562d062018-01-24 11:54:05 -07002121 if (layout) { // nullptr layout indicates no valid layout handle for this device, validated/logged in object_tracker
2122 if (layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR) {
2123 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 -06002124 HandleToUint64(p_alloc_info->pSetLayouts[i]), "VUID-VkDescriptorSetAllocateInfo-pSetLayouts-00308",
John Zulauf5562d062018-01-24 11:54:05 -07002125 "Layout 0x%" PRIxLEAST64 " specified at pSetLayouts[%" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002126 "] in vkAllocateDescriptorSets() was created with invalid flag %s set.",
John Zulauf5562d062018-01-24 11:54:05 -07002127 HandleToUint64(p_alloc_info->pSetLayouts[i]), i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002128 "VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR");
John Zulauf5562d062018-01-24 11:54:05 -07002129 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05002130 if (layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT &&
2131 !(pool_state->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
2132 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 -06002133 0, "VUID-VkDescriptorSetAllocateInfo-pSetLayouts-03044",
Jeff Bolzfdf96072018-04-10 14:32:18 -05002134 "Descriptor set layout create flags and pool create flags mismatch for index (%d)", i);
2135 }
Tobin Ehlisee471462016-05-26 11:21:59 -06002136 }
2137 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002138 if (!GetDeviceExtensions(dev_data)->vk_khr_maintenance1) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002139 // Track number of descriptorSets allowable in this pool
2140 if (pool_state->availableSets < p_alloc_info->descriptorSetCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002141 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 -06002142 HandleToUint64(pool_state->pool), "VUID-VkDescriptorSetAllocateInfo-descriptorSetCount-00306",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002143 "Unable to allocate %u descriptorSets from pool 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002144 ". This pool only has %d descriptorSets remaining.",
2145 p_alloc_info->descriptorSetCount, HandleToUint64(pool_state->pool), pool_state->availableSets);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002146 }
2147 // Determine whether descriptor counts are satisfiable
2148 for (uint32_t i = 0; i < VK_DESCRIPTOR_TYPE_RANGE_SIZE; i++) {
2149 if (ds_data->required_descriptors_by_type[i] > pool_state->availableDescriptorTypeCount[i]) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002150 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 -06002151 HandleToUint64(pool_state->pool), "VUID-VkDescriptorSetAllocateInfo-descriptorPool-00307",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002152 "Unable to allocate %u descriptors of type %s from pool 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002153 ". This pool only has %d descriptors of this type remaining.",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002154 ds_data->required_descriptors_by_type[i], string_VkDescriptorType(VkDescriptorType(i)),
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002155 HandleToUint64(pool_state->pool), pool_state->availableDescriptorTypeCount[i]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002156 }
Tobin Ehlisee471462016-05-26 11:21:59 -06002157 }
2158 }
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06002159
Jeff Bolzfdf96072018-04-10 14:32:18 -05002160 const auto *count_allocate_info = lvl_find_in_chain<VkDescriptorSetVariableDescriptorCountAllocateInfoEXT>(p_alloc_info->pNext);
2161
2162 if (count_allocate_info) {
2163 if (count_allocate_info->descriptorSetCount != 0 &&
2164 count_allocate_info->descriptorSetCount != p_alloc_info->descriptorSetCount) {
2165 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 -06002166 "VUID-VkDescriptorSetVariableDescriptorCountAllocateInfoEXT-descriptorSetCount-03045",
Jeff Bolzfdf96072018-04-10 14:32:18 -05002167 "VkDescriptorSetAllocateInfo::descriptorSetCount (%d) != "
2168 "VkDescriptorSetVariableDescriptorCountAllocateInfoEXT::descriptorSetCount (%d)",
2169 p_alloc_info->descriptorSetCount, count_allocate_info->descriptorSetCount);
2170 }
2171 if (count_allocate_info->descriptorSetCount == p_alloc_info->descriptorSetCount) {
2172 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
2173 auto layout = GetDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
2174 if (count_allocate_info->pDescriptorCounts[i] > layout->GetDescriptorCountFromBinding(layout->GetMaxBinding())) {
2175 skip |= log_msg(
2176 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 -06002177 "VUID-VkDescriptorSetVariableDescriptorCountAllocateInfoEXT-pSetLayouts-03046",
2178 "pDescriptorCounts[%d] = (%d), binding's descriptorCount = (%d)", i,
Jeff Bolzfdf96072018-04-10 14:32:18 -05002179 count_allocate_info->pDescriptorCounts[i], layout->GetDescriptorCountFromBinding(layout->GetMaxBinding()));
2180 }
2181 }
2182 }
2183 }
2184
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002185 return skip;
Tobin Ehlisee471462016-05-26 11:21:59 -06002186}
2187// Decrement allocated sets from the pool and insert new sets into set_map
Tobin Ehlis4e380592016-06-02 12:41:47 -06002188void cvdescriptorset::PerformAllocateDescriptorSets(const VkDescriptorSetAllocateInfo *p_alloc_info,
2189 const VkDescriptorSet *descriptor_sets,
2190 const AllocateDescriptorSetsData *ds_data,
Tobin Ehlisbd711bd2016-10-12 14:27:30 -06002191 std::unordered_map<VkDescriptorPool, DESCRIPTOR_POOL_STATE *> *pool_map,
Tobin Ehlis4e380592016-06-02 12:41:47 -06002192 std::unordered_map<VkDescriptorSet, cvdescriptorset::DescriptorSet *> *set_map,
John Zulauf48a6a702017-12-22 17:14:54 -07002193 layer_data *dev_data) {
Tobin Ehlisee471462016-05-26 11:21:59 -06002194 auto pool_state = (*pool_map)[p_alloc_info->descriptorPool];
Mark Lobodzinskic9430182017-06-13 13:00:05 -06002195 // Account for sets and individual descriptors allocated from pool
Tobin Ehlisee471462016-05-26 11:21:59 -06002196 pool_state->availableSets -= p_alloc_info->descriptorSetCount;
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06002197 for (uint32_t i = 0; i < VK_DESCRIPTOR_TYPE_RANGE_SIZE; i++) {
2198 pool_state->availableDescriptorTypeCount[i] -= ds_data->required_descriptors_by_type[i];
2199 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05002200
2201 const auto *variable_count_info = lvl_find_in_chain<VkDescriptorSetVariableDescriptorCountAllocateInfoEXT>(p_alloc_info->pNext);
2202 bool variable_count_valid = variable_count_info && variable_count_info->descriptorSetCount == p_alloc_info->descriptorSetCount;
2203
Mark Lobodzinskic9430182017-06-13 13:00:05 -06002204 // Create tracking object for each descriptor set; insert into global map and the pool's set.
Tobin Ehlisee471462016-05-26 11:21:59 -06002205 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Jeff Bolzfdf96072018-04-10 14:32:18 -05002206 uint32_t variable_count = variable_count_valid ? variable_count_info->pDescriptorCounts[i] : 0;
2207
Tobin Ehlis93f22372016-10-12 14:34:12 -06002208 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 -05002209 variable_count, dev_data);
Tobin Ehlisee471462016-05-26 11:21:59 -06002210
2211 pool_state->sets.insert(new_ds);
2212 new_ds->in_use.store(0);
2213 (*set_map)[descriptor_sets[i]] = new_ds;
2214 }
2215}
John Zulauf48a6a702017-12-22 17:14:54 -07002216
2217cvdescriptorset::PrefilterBindRequestMap::PrefilterBindRequestMap(cvdescriptorset::DescriptorSet &ds, const BindingReqMap &in_map,
2218 GLOBAL_CB_NODE *cb_state)
2219 : filtered_map_(), orig_map_(in_map) {
2220 if (ds.GetTotalDescriptorCount() > kManyDescriptors_) {
2221 filtered_map_.reset(new std::map<uint32_t, descriptor_req>());
2222 ds.FilterAndTrackBindingReqs(cb_state, orig_map_, filtered_map_.get());
2223 }
2224}
2225cvdescriptorset::PrefilterBindRequestMap::PrefilterBindRequestMap(cvdescriptorset::DescriptorSet &ds, const BindingReqMap &in_map,
2226 GLOBAL_CB_NODE *cb_state, PIPELINE_STATE *pipeline)
2227 : filtered_map_(), orig_map_(in_map) {
2228 if (ds.GetTotalDescriptorCount() > kManyDescriptors_) {
2229 filtered_map_.reset(new std::map<uint32_t, descriptor_req>());
2230 ds.FilterAndTrackBindingReqs(cb_state, pipeline, orig_map_, filtered_map_.get());
2231 }
Artem Kharytoniuk2456f992018-01-12 14:17:41 +01002232}