blob: f9d64568fcb43de4996d7ab78b1f4d74d3f2165a [file] [log] [blame]
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001/* Copyright (c) 2015-2016 The Khronos Group Inc.
2 * Copyright (c) 2015-2016 Valve Corporation
3 * Copyright (c) 2015-2016 LunarG, Inc.
4 * Copyright (C) 2015-2016 Google Inc.
5 *
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,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600372 DRAWSTATE_EXTENSION_NOT_ENABLED,
John Zulauf0fdeab32018-01-23 11:27:35 -0700373 "Attemped to use %s in %s but its required extension %s has not been enabled.\n",
374 "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,
381 DRAWSTATE_EXTENSION_NOT_ENABLED,
382 "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,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600400 VALIDATION_ERROR_0500022e, "duplicated binding number in VkDescriptorSetLayoutBinding.");
Tobin Ehlis154c2692016-10-25 09:36:53 -0600401 }
John Zulauf0fdeab32018-01-23 11:27:35 -0700402 if (!valid_type(binding_info.descriptorType)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600403 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600404 VALIDATION_ERROR_05000230,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600405 "invalid type %s ,for push descriptors in VkDescriptorSetLayoutBinding entry %" PRIu32 ".",
406 string_VkDescriptorType(binding_info.descriptorType), i);
John Zulauf0fdeab32018-01-23 11:27:35 -0700407 }
408 total_descriptors += binding_info.descriptorCount;
Tobin Ehlis154c2692016-10-25 09:36:53 -0600409 }
John Zulauf0fdeab32018-01-23 11:27:35 -0700410
Jeff Bolzfdf96072018-04-10 14:32:18 -0500411 if (flags_create_info) {
412 if (flags_create_info->bindingCount != 0 && flags_create_info->bindingCount != create_info->bindingCount) {
413 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
414 VALIDATION_ERROR_46a01774,
415 "VkDescriptorSetLayoutCreateInfo::bindingCount (%d) != "
416 "VkDescriptorSetLayoutBindingFlagsCreateInfoEXT::bindingCount (%d)",
417 create_info->bindingCount, flags_create_info->bindingCount);
418 }
419
420 if (flags_create_info->bindingCount == create_info->bindingCount) {
421 for (uint32_t i = 0; i < create_info->bindingCount; ++i) {
422 const auto &binding_info = create_info->pBindings[i];
423
424 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT) {
425 if (!update_after_bind_set) {
426 skip |=
427 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
428 VALIDATION_ERROR_05001770, "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
429 }
430
431 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER &&
432 !descriptor_indexing_features->descriptorBindingUniformBufferUpdateAfterBind) {
433 skip |=
434 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
435 VALIDATION_ERROR_46a0177a, "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
436 }
437 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_SAMPLER ||
438 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER ||
439 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE) &&
440 !descriptor_indexing_features->descriptorBindingSampledImageUpdateAfterBind) {
441 skip |=
442 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
443 VALIDATION_ERROR_46a0177c, "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
444 }
445 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_IMAGE &&
446 !descriptor_indexing_features->descriptorBindingStorageImageUpdateAfterBind) {
447 skip |=
448 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
449 VALIDATION_ERROR_46a0177e, "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
450 }
451 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER &&
452 !descriptor_indexing_features->descriptorBindingStorageBufferUpdateAfterBind) {
453 skip |=
454 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
455 VALIDATION_ERROR_46a01780, "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
456 }
457 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER &&
458 !descriptor_indexing_features->descriptorBindingUniformTexelBufferUpdateAfterBind) {
459 skip |=
460 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
461 VALIDATION_ERROR_46a01782, "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
462 }
463 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER &&
464 !descriptor_indexing_features->descriptorBindingStorageTexelBufferUpdateAfterBind) {
465 skip |=
466 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
467 VALIDATION_ERROR_46a01784, "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
468 }
469 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT ||
470 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
471 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
472 skip |=
473 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
474 VALIDATION_ERROR_46a01786, "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
475 }
476 }
477
478 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT) {
479 if (!descriptor_indexing_features->descriptorBindingUpdateUnusedWhilePending) {
480 skip |=
481 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
482 VALIDATION_ERROR_46a01788, "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
483 }
484 }
485
486 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT) {
487 if (!descriptor_indexing_features->descriptorBindingPartiallyBound) {
488 skip |=
489 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
490 VALIDATION_ERROR_46a0178a, "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
491 }
492 }
493
494 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT_EXT) {
495 if (binding_info.binding != max_binding) {
496 skip |=
497 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
498 VALIDATION_ERROR_46a01778, "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
499 }
500
501 if (!descriptor_indexing_features->descriptorBindingVariableDescriptorCount) {
502 skip |=
503 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
504 VALIDATION_ERROR_46a0178c, "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
505 }
506 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
507 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
508 skip |=
509 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
510 VALIDATION_ERROR_46a0178e, "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
511 }
512 }
513
514 if (push_descriptor_set &&
515 (flags_create_info->pBindingFlags[i] &
516 (VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT |
517 VK_DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT_EXT))) {
518 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
519 VALIDATION_ERROR_46a01776, "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
520 }
521 }
522 }
523 }
524
John Zulauf0fdeab32018-01-23 11:27:35 -0700525 if ((push_descriptor_set) && (total_descriptors > max_push_descriptors)) {
526 const char *undefined = push_descriptor_ext ? "" : " -- undefined";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600527 skip |= log_msg(
Mark Lobodzinski88529492018-04-01 10:38:15 -0600528 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, VALIDATION_ERROR_05000232,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600529 "for push descriptor, total descriptor count in layout (%" PRIu64
530 ") must not be greater than VkPhysicalDevicePushDescriptorPropertiesKHR::maxPushDescriptors (%" PRIu32 "%s).",
531 total_descriptors, max_push_descriptors, undefined);
John Zulauf0fdeab32018-01-23 11:27:35 -0700532 }
533
Tobin Ehlis154c2692016-10-25 09:36:53 -0600534 return skip;
535}
536
Tobin Ehlis68d0adf2016-06-01 11:33:50 -0600537cvdescriptorset::AllocateDescriptorSetsData::AllocateDescriptorSetsData(uint32_t count)
538 : required_descriptors_by_type{}, layout_nodes(count, nullptr) {}
539
Tobin Ehlis93f22372016-10-12 14:34:12 -0600540cvdescriptorset::DescriptorSet::DescriptorSet(const VkDescriptorSet set, const VkDescriptorPool pool,
Jeff Bolzfdf96072018-04-10 14:32:18 -0500541 const std::shared_ptr<DescriptorSetLayout const> &layout, uint32_t variable_count,
542 layer_data *dev_data)
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -0700543 : some_update_(false),
544 set_(set),
545 pool_state_(nullptr),
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600546 p_layout_(layout),
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -0700547 device_data_(dev_data),
Jeff Bolzfdf96072018-04-10 14:32:18 -0500548 limits_(GetPhysDevProperties(dev_data)->properties.limits),
549 variable_count_(variable_count) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700550 pool_state_ = GetDescriptorPoolState(dev_data, pool);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600551 // Foreach binding, create default descriptors of given type
John Zulaufb6d71202017-12-22 16:47:09 -0700552 descriptors_.reserve(p_layout_->GetTotalDescriptorCount());
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600553 for (uint32_t i = 0; i < p_layout_->GetBindingCount(); ++i) {
554 auto type = p_layout_->GetTypeFromIndex(i);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600555 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700556 case VK_DESCRIPTOR_TYPE_SAMPLER: {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600557 auto immut_sampler = p_layout_->GetImmutableSamplerPtrFromIndex(i);
558 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
Tobin Ehlis082c7512017-05-08 11:24:57 -0600559 if (immut_sampler) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700560 descriptors_.emplace_back(new SamplerDescriptor(immut_sampler + di));
Tobin Ehlis082c7512017-05-08 11:24:57 -0600561 some_update_ = true; // Immutable samplers are updated at creation
562 } else
Chris Forbes9f340852017-05-09 08:51:38 -0700563 descriptors_.emplace_back(new SamplerDescriptor(nullptr));
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700564 }
565 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600566 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700567 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600568 auto immut = 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) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700571 descriptors_.emplace_back(new ImageSamplerDescriptor(immut + 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 ImageSamplerDescriptor(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 // ImageDescriptors
579 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
580 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
581 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600582 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700583 descriptors_.emplace_back(new ImageDescriptor(type));
584 break;
585 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
586 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600587 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700588 descriptors_.emplace_back(new TexelDescriptor(type));
589 break;
590 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
591 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
592 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
593 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600594 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700595 descriptors_.emplace_back(new BufferDescriptor(type));
596 break;
597 default:
598 assert(0); // Bad descriptor type specified
599 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600600 }
601 }
602}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600603
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700604cvdescriptorset::DescriptorSet::~DescriptorSet() { InvalidateBoundCmdBuffers(); }
Chris Forbes57989132016-07-26 17:06:10 +1200605
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700606static std::string string_descriptor_req_view_type(descriptor_req req) {
607 std::string result("");
Chris Forbes57989132016-07-26 17:06:10 +1200608 for (unsigned i = 0; i <= VK_IMAGE_VIEW_TYPE_END_RANGE; i++) {
609 if (req & (1 << i)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700610 if (result.size()) result += ", ";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700611 result += string_VkImageViewType(VkImageViewType(i));
Chris Forbes57989132016-07-26 17:06:10 +1200612 }
613 }
614
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700615 if (!result.size()) result = "(none)";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700616
617 return result;
Chris Forbes57989132016-07-26 17:06:10 +1200618}
619
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600620// Is this sets underlying layout compatible with passed in layout according to "Pipeline Layout Compatibility" in spec?
Tobin Ehlis6dc57dd2017-06-21 10:08:52 -0600621bool cvdescriptorset::DescriptorSet::IsCompatible(DescriptorSetLayout const *const layout, std::string *error) const {
622 return layout->IsCompatible(p_layout_.get(), error);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600623}
Chris Forbes57989132016-07-26 17:06:10 +1200624
Tobin Ehlis3066db62016-08-22 08:12:23 -0600625// 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 -0600626// This includes validating that all descriptors in the given bindings are updated,
627// that any update buffers are valid, and that any dynamic offsets are within the bounds of their buffers.
628// Return true if state is acceptable, or false and write an error message into error string
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600629bool cvdescriptorset::DescriptorSet::ValidateDrawState(const std::map<uint32_t, descriptor_req> &bindings,
John Zulauf48a6a702017-12-22 17:14:54 -0700630 const std::vector<uint32_t> &dynamic_offsets, GLOBAL_CB_NODE *cb_node,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600631 const char *caller, std::string *error) const {
Chris Forbesc7090a82016-07-25 18:10:41 +1200632 for (auto binding_pair : bindings) {
633 auto binding = binding_pair.first;
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600634 if (!p_layout_->HasBinding(binding)) {
Tobin Ehlis58c59582016-06-21 12:34:33 -0600635 std::stringstream error_str;
636 error_str << "Attempting to validate DrawState for binding #" << binding
637 << " which is an invalid binding for this descriptor set.";
638 *error = error_str.str();
639 return false;
640 }
John Zulaufc483f442017-12-15 14:02:06 -0700641 IndexRange index_range = p_layout_->GetGlobalIndexRangeFromBinding(binding);
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700642 auto array_idx = 0; // Track array idx if we're dealing with array descriptors
Jeff Bolzfdf96072018-04-10 14:32:18 -0500643
644 if (IsVariableDescriptorCount(binding)) {
645 // Only validate the first N descriptors if it uses variable_count
646 index_range.end = index_range.start + GetVariableDescriptorCount();
647 }
648
John Zulaufc483f442017-12-15 14:02:06 -0700649 for (uint32_t i = index_range.start; i < index_range.end; ++i, ++array_idx) {
Jeff Bolzfdf96072018-04-10 14:32:18 -0500650 if (p_layout_->GetDescriptorBindingFlagsFromBinding(binding) & VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT) {
651 // Can't validate the descriptor because it may not have been updated,
652 // or the view could have been destroyed
653 continue;
654 } else if (!descriptors_[i]->updated) {
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700655 std::stringstream error_str;
656 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
657 << " is being used in draw but has not been updated.";
658 *error = error_str.str();
659 return false;
660 } else {
661 auto descriptor_class = descriptors_[i]->GetClass();
662 if (descriptor_class == GeneralBuffer) {
663 // Verify that buffers are valid
664 auto buffer = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetBuffer();
665 auto buffer_node = GetBufferState(device_data_, buffer);
666 if (!buffer_node) {
667 std::stringstream error_str;
668 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
669 << " references invalid buffer " << buffer << ".";
670 *error = error_str.str();
671 return false;
John Zulauf48a6a702017-12-22 17:14:54 -0700672 } else if (!buffer_node->sparse) {
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700673 for (auto mem_binding : buffer_node->GetBoundMemory()) {
674 if (!GetMemObjInfo(device_data_, mem_binding)) {
675 std::stringstream error_str;
676 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
677 << " uses buffer " << buffer << " that references invalid memory " << mem_binding << ".";
678 *error = error_str.str();
Tobin Ehlisc8266452017-04-07 12:20:30 -0600679 return false;
680 }
681 }
John Zulauf48a6a702017-12-22 17:14:54 -0700682 } else {
683 // Enqueue sparse resource validation, as these can only be validated at submit time
684 auto device_data_copy = device_data_; // Cannot capture members by value, so make capturable copy.
685 std::function<bool(void)> function = [device_data_copy, caller, buffer_node]() {
686 return core_validation::ValidateBufferMemoryIsValid(device_data_copy, buffer_node, caller);
687 };
688 cb_node->queue_submit_functions.push_back(function);
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700689 }
690 if (descriptors_[i]->IsDynamic()) {
691 // Validate that dynamic offsets are within the buffer
692 auto buffer_size = buffer_node->createInfo.size;
693 auto range = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetRange();
694 auto desc_offset = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetOffset();
695 auto dyn_offset = dynamic_offsets[GetDynamicOffsetIndexFromBinding(binding) + array_idx];
696 if (VK_WHOLE_SIZE == range) {
697 if ((dyn_offset + desc_offset) > buffer_size) {
698 std::stringstream error_str;
699 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
700 << " uses buffer " << buffer << " with update range of VK_WHOLE_SIZE has dynamic offset "
701 << dyn_offset << " combined with offset " << desc_offset
702 << " that oversteps the buffer size of " << buffer_size << ".";
703 *error = error_str.str();
704 return false;
705 }
706 } else {
707 if ((dyn_offset + desc_offset + range) > buffer_size) {
708 std::stringstream error_str;
709 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
710 << " uses buffer " << buffer << " with dynamic offset " << dyn_offset
711 << " combined with offset " << desc_offset << " and range " << range
712 << " that oversteps the buffer size of " << buffer_size << ".";
713 *error = error_str.str();
714 return false;
715 }
716 }
717 }
718 } else if (descriptor_class == ImageSampler || descriptor_class == Image) {
719 VkImageView image_view;
720 VkImageLayout image_layout;
721 if (descriptor_class == ImageSampler) {
722 image_view = static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetImageView();
723 image_layout = static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetImageLayout();
724 } else {
725 image_view = static_cast<ImageDescriptor *>(descriptors_[i].get())->GetImageView();
726 image_layout = static_cast<ImageDescriptor *>(descriptors_[i].get())->GetImageLayout();
727 }
728 auto reqs = binding_pair.second;
729
730 auto image_view_state = GetImageViewState(device_data_, image_view);
Tobin Ehlis836a1372017-07-14 11:25:21 -0600731 if (nullptr == image_view_state) {
732 // Image view must have been destroyed since initial update. Could potentially flag the descriptor
733 // as "invalid" (updated = false) at DestroyImageView() time and detect this error at bind time
734 std::stringstream error_str;
735 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
736 << " is using imageView " << image_view << " that has been destroyed.";
737 *error = error_str.str();
738 return false;
739 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700740 auto image_view_ci = image_view_state->create_info;
741
742 if ((reqs & DESCRIPTOR_REQ_ALL_VIEW_TYPE_BITS) && (~reqs & (1 << image_view_ci.viewType))) {
743 // bad view type
744 std::stringstream error_str;
745 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
746 << " requires an image view of type " << string_descriptor_req_view_type(reqs) << " but got "
747 << string_VkImageViewType(image_view_ci.viewType) << ".";
748 *error = error_str.str();
749 return false;
750 }
751
752 auto image_node = GetImageState(device_data_, image_view_ci.image);
753 assert(image_node);
754 // Verify Image Layout
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700755 // Copy first mip level into sub_layers and loop over each mip level to verify layout
756 VkImageSubresourceLayers sub_layers;
757 sub_layers.aspectMask = image_view_ci.subresourceRange.aspectMask;
758 sub_layers.baseArrayLayer = image_view_ci.subresourceRange.baseArrayLayer;
759 sub_layers.layerCount = image_view_ci.subresourceRange.layerCount;
760 bool hit_error = false;
761 for (auto cur_level = image_view_ci.subresourceRange.baseMipLevel;
762 cur_level < image_view_ci.subresourceRange.levelCount; ++cur_level) {
763 sub_layers.mipLevel = cur_level;
764 VerifyImageLayout(device_data_, cb_node, image_node, sub_layers, image_layout, VK_IMAGE_LAYOUT_UNDEFINED,
Chris Forbesc6bb6ce2017-07-21 14:03:06 -0700765 caller, VALIDATION_ERROR_046002b0, &hit_error);
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700766 if (hit_error) {
767 *error =
Dave Houltona9df0ce2018-02-07 10:51:23 -0700768 "Image layout specified at vkUpdateDescriptorSets() time doesn't match actual image layout at time "
769 "descriptor is used. See previous error callback for specific details.";
Chris Forbes57989132016-07-26 17:06:10 +1200770 return false;
771 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700772 }
773 // Verify Sample counts
774 if ((reqs & DESCRIPTOR_REQ_SINGLE_SAMPLE) && image_node->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
775 std::stringstream error_str;
776 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
777 << " requires bound image to have VK_SAMPLE_COUNT_1_BIT but got "
778 << string_VkSampleCountFlagBits(image_node->createInfo.samples) << ".";
779 *error = error_str.str();
780 return false;
781 }
782 if ((reqs & DESCRIPTOR_REQ_MULTI_SAMPLE) && image_node->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
783 std::stringstream error_str;
784 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
785 << " requires bound image to have multiple samples, but got VK_SAMPLE_COUNT_1_BIT.";
786 *error = error_str.str();
787 return false;
Chris Forbes57989132016-07-26 17:06:10 +1200788 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600789 }
Tobin Ehlisb1a2e4b2018-03-16 07:54:24 -0600790 if (descriptor_class == ImageSampler || descriptor_class == PlainSampler) {
791 // Verify Sampler still valid
792 VkSampler sampler;
793 if (descriptor_class == ImageSampler) {
794 sampler = static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetSampler();
795 } else {
796 sampler = static_cast<SamplerDescriptor *>(descriptors_[i].get())->GetSampler();
797 }
798 if (!ValidateSampler(sampler, device_data_)) {
799 std::stringstream error_str;
800 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
801 << " is using sampler " << sampler << " that has been destroyed.";
802 *error = error_str.str();
803 return false;
804 }
805 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600806 }
807 }
808 }
809 return true;
810}
Chris Forbes57989132016-07-26 17:06:10 +1200811
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600812// For given bindings, place any update buffers or images into the passed-in unordered_sets
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600813uint32_t cvdescriptorset::DescriptorSet::GetStorageUpdates(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600814 std::unordered_set<VkBuffer> *buffer_set,
815 std::unordered_set<VkImageView> *image_set) const {
816 auto num_updates = 0;
Chris Forbesc7090a82016-07-25 18:10:41 +1200817 for (auto binding_pair : bindings) {
818 auto binding = binding_pair.first;
Tobin Ehlis58c59582016-06-21 12:34:33 -0600819 // If a binding doesn't exist, skip it
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600820 if (!p_layout_->HasBinding(binding)) {
Tobin Ehlis58c59582016-06-21 12:34:33 -0600821 continue;
822 }
John Zulaufc483f442017-12-15 14:02:06 -0700823 uint32_t start_idx = p_layout_->GetGlobalIndexRangeFromBinding(binding).start;
Tobin Ehlis81f17852016-05-05 09:04:33 -0600824 if (descriptors_[start_idx]->IsStorage()) {
825 if (Image == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600826 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600827 if (descriptors_[start_idx + i]->updated) {
828 image_set->insert(static_cast<ImageDescriptor *>(descriptors_[start_idx + i].get())->GetImageView());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600829 num_updates++;
830 }
831 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600832 } else if (TexelBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600833 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600834 if (descriptors_[start_idx + i]->updated) {
835 auto bufferview = static_cast<TexelDescriptor *>(descriptors_[start_idx + i].get())->GetBufferView();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700836 auto bv_state = GetBufferViewState(device_data_, bufferview);
Tobin Ehlis8b872462016-09-14 08:12:08 -0600837 if (bv_state) {
838 buffer_set->insert(bv_state->create_info.buffer);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600839 num_updates++;
840 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600841 }
842 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600843 } else if (GeneralBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600844 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600845 if (descriptors_[start_idx + i]->updated) {
846 buffer_set->insert(static_cast<BufferDescriptor *>(descriptors_[start_idx + i].get())->GetBuffer());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600847 num_updates++;
848 }
849 }
850 }
851 }
852 }
853 return num_updates;
854}
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600855// Set is being deleted or updates so invalidate all bound cmd buffers
856void cvdescriptorset::DescriptorSet::InvalidateBoundCmdBuffers() {
Petr Krausbc7f5442017-05-14 23:43:38 +0200857 core_validation::invalidateCommandBuffers(device_data_, cb_bindings, {HandleToUint64(set_), kVulkanObjectTypeDescriptorSet});
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600858}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600859// Perform write update in given update struct
Tobin Ehlis300888c2016-05-18 13:43:26 -0600860void cvdescriptorset::DescriptorSet::PerformWriteUpdate(const VkWriteDescriptorSet *update) {
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700861 // Perform update on a per-binding basis as consecutive updates roll over to next binding
862 auto descriptors_remaining = update->descriptorCount;
863 auto binding_being_updated = update->dstBinding;
864 auto offset = update->dstArrayElement;
Tobin Ehlise16805c2017-08-09 09:10:37 -0600865 uint32_t update_index = 0;
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700866 while (descriptors_remaining) {
867 uint32_t update_count = std::min(descriptors_remaining, GetDescriptorCountFromBinding(binding_being_updated));
John Zulaufc483f442017-12-15 14:02:06 -0700868 auto global_idx = p_layout_->GetGlobalIndexRangeFromBinding(binding_being_updated).start + offset;
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700869 // Loop over the updates for a single binding at a time
Tobin Ehlise16805c2017-08-09 09:10:37 -0600870 for (uint32_t di = 0; di < update_count; ++di, ++update_index) {
871 descriptors_[global_idx + di]->WriteUpdate(update, update_index);
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700872 }
873 // Roll over to next binding in case of consecutive update
874 descriptors_remaining -= update_count;
875 offset = 0;
876 binding_being_updated++;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600877 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700878 if (update->descriptorCount) some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600879
Jeff Bolzfdf96072018-04-10 14:32:18 -0500880 if (!(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
881 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
882 InvalidateBoundCmdBuffers();
883 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600884}
Tobin Ehlis300888c2016-05-18 13:43:26 -0600885// Validate Copy update
886bool cvdescriptorset::DescriptorSet::ValidateCopyUpdate(const debug_report_data *report_data, const VkCopyDescriptorSet *update,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600887 const DescriptorSet *src_set, UNIQUE_VALIDATION_ERROR_CODE *error_code,
888 std::string *error_msg) {
John Zulauf5dfd45c2018-01-17 11:06:34 -0700889 // Verify dst layout still valid
890 if (p_layout_->IsDestroyed()) {
John Zulauf5dfd45c2018-01-17 11:06:34 -0700891 *error_code = VALIDATION_ERROR_03207601;
892 string_sprintf(error_msg,
893 "Cannot call vkUpdateDescriptorSets() to perform copy update on descriptor set dstSet 0x%" PRIxLEAST64
894 " created with destroyed VkDescriptorSetLayout 0x%" PRIxLEAST64,
895 HandleToUint64(set_), HandleToUint64(p_layout_->GetDescriptorSetLayout()));
896 return false;
897 }
898
899 // Verify src layout still valid
900 if (src_set->p_layout_->IsDestroyed()) {
John Zulauf5dfd45c2018-01-17 11:06:34 -0700901 *error_code = VALIDATION_ERROR_0322d201;
902 string_sprintf(
903 error_msg,
904 "Cannot call vkUpdateDescriptorSets() to perform copy update of dstSet 0x%" PRIxLEAST64
905 " from descriptor set srcSet 0x%" PRIxLEAST64 " created with destroyed VkDescriptorSetLayout 0x%" PRIxLEAST64,
906 HandleToUint64(set_), HandleToUint64(src_set->set_), HandleToUint64(src_set->p_layout_->GetDescriptorSetLayout()));
907 return false;
908 }
909
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600910 if (!p_layout_->HasBinding(update->dstBinding)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600911 *error_code = VALIDATION_ERROR_032002b6;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600912 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700913 error_str << "DescriptorSet " << set_ << " does not have copy update dest binding of " << update->dstBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600914 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600915 return false;
916 }
917 if (!src_set->HasBinding(update->srcBinding)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600918 *error_code = VALIDATION_ERROR_032002b2;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600919 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700920 error_str << "DescriptorSet " << set_ << " does not have copy update src binding of " << update->srcBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600921 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600922 return false;
923 }
Jeff Bolzfdf96072018-04-10 14:32:18 -0500924 // Verify idle ds
925 if (in_use.load() &&
926 !(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
927 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
928 // TODO : Re-using Free Idle error code, need copy update idle error code
929 *error_code = VALIDATION_ERROR_2860026a;
930 std::stringstream error_str;
931 error_str << "Cannot call vkUpdateDescriptorSets() to perform copy update on descriptor set " << set_
932 << " that is in use by a command buffer";
933 *error_msg = error_str.str();
934 return false;
935 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600936 // src & dst set bindings are valid
937 // Check bounds of src & dst
John Zulaufc483f442017-12-15 14:02:06 -0700938 auto src_start_idx = src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start + update->srcArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600939 if ((src_start_idx + update->descriptorCount) > src_set->GetTotalDescriptorCount()) {
940 // SRC update out of bounds
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600941 *error_code = VALIDATION_ERROR_032002b4;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600942 std::stringstream error_str;
943 error_str << "Attempting copy update from descriptorSet " << update->srcSet << " binding#" << update->srcBinding
John Zulaufc483f442017-12-15 14:02:06 -0700944 << " with offset index of " << src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600945 << " plus update array offset of " << update->srcArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700946 << " descriptors oversteps total number of descriptors in set: " << src_set->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600947 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600948 return false;
949 }
John Zulaufc483f442017-12-15 14:02:06 -0700950 auto dst_start_idx = p_layout_->GetGlobalIndexRangeFromBinding(update->dstBinding).start + update->dstArrayElement;
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600951 if ((dst_start_idx + update->descriptorCount) > p_layout_->GetTotalDescriptorCount()) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600952 // DST update out of bounds
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600953 *error_code = VALIDATION_ERROR_032002b8;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600954 std::stringstream error_str;
955 error_str << "Attempting copy update to descriptorSet " << set_ << " binding#" << update->dstBinding
John Zulaufc483f442017-12-15 14:02:06 -0700956 << " with offset index of " << p_layout_->GetGlobalIndexRangeFromBinding(update->dstBinding).start
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600957 << " plus update array offset of " << update->dstArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600958 << " descriptors oversteps total number of descriptors in set: " << p_layout_->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600959 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600960 return false;
961 }
962 // Check that types match
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600963 // TODO : Base default error case going from here is VALIDATION_ERROR_0002b8012ba which covers all consistency issues, need more
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600964 // fine-grained error codes
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600965 *error_code = VALIDATION_ERROR_032002ba;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600966 auto src_type = src_set->GetTypeFromBinding(update->srcBinding);
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600967 auto dst_type = p_layout_->GetTypeFromBinding(update->dstBinding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600968 if (src_type != dst_type) {
969 std::stringstream error_str;
970 error_str << "Attempting copy update to descriptorSet " << set_ << " binding #" << update->dstBinding << " with type "
971 << string_VkDescriptorType(dst_type) << " from descriptorSet " << src_set->GetSet() << " binding #"
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700972 << update->srcBinding << " with type " << string_VkDescriptorType(src_type) << ". Types do not match";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600973 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600974 return false;
975 }
976 // Verify consistency of src & dst bindings if update crosses binding boundaries
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600977 if ((!src_set->GetLayout()->VerifyUpdateConsistency(update->srcBinding, update->srcArrayElement, update->descriptorCount,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600978 "copy update from", src_set->GetSet(), error_msg)) ||
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600979 (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "copy update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600980 set_, error_msg))) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600981 return false;
982 }
Jeff Bolzfdf96072018-04-10 14:32:18 -0500983
984 if ((src_set->GetLayout()->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT) &&
985 !(GetLayout()->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT)) {
986 *error_code = VALIDATION_ERROR_03200efc;
987 std::stringstream error_str;
988 error_str << "If pname:srcSet's (" << update->srcSet
989 << ") layout was created with the "
990 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag "
991 "set, then pname:dstSet's ("
992 << update->dstSet
993 << ") layout must: also have been created with the "
994 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag set";
995 *error_msg = error_str.str();
996 return false;
997 }
998
999 if (!(src_set->GetLayout()->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT) &&
1000 (GetLayout()->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT)) {
1001 *error_code = VALIDATION_ERROR_03200efe;
1002 std::stringstream error_str;
1003 error_str << "If pname:srcSet's (" << update->srcSet
1004 << ") layout was created without the "
1005 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag "
1006 "set, then pname:dstSet's ("
1007 << update->dstSet
1008 << ") layout must: also have been created without the "
1009 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag set";
1010 *error_msg = error_str.str();
1011 return false;
1012 }
1013
1014 if ((src_set->GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT) &&
1015 !(GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
1016 *error_code = VALIDATION_ERROR_03200f00;
1017 std::stringstream error_str;
1018 error_str << "If the descriptor pool from which pname:srcSet (" << update->srcSet
1019 << ") was allocated was created "
1020 "with the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag "
1021 "set, then the descriptor pool from which pname:dstSet ("
1022 << update->dstSet
1023 << ") was allocated must: "
1024 "also have been created with the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag set";
1025 *error_msg = error_str.str();
1026 return false;
1027 }
1028
1029 if (!(src_set->GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT) &&
1030 (GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
1031 *error_code = VALIDATION_ERROR_03200f02;
1032 std::stringstream error_str;
1033 error_str << "If the descriptor pool from which pname:srcSet (" << update->srcSet
1034 << ") was allocated was created "
1035 "without the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag "
1036 "set, then the descriptor pool from which pname:dstSet ("
1037 << update->dstSet
1038 << ") was allocated must: "
1039 "also have been created without the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag set";
1040 *error_msg = error_str.str();
1041 return false;
1042 }
1043
Tobin Ehlisd41e7b62016-05-19 07:56:18 -06001044 // Update parameters all look good and descriptor updated so verify update contents
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001045 if (!VerifyCopyUpdateContents(update, src_set, src_type, src_start_idx, error_code, error_msg)) return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001046
1047 // All checks passed so update is good
1048 return true;
1049}
1050// Perform Copy update
1051void cvdescriptorset::DescriptorSet::PerformCopyUpdate(const VkCopyDescriptorSet *update, const DescriptorSet *src_set) {
John Zulaufc483f442017-12-15 14:02:06 -07001052 auto src_start_idx = src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start + update->srcArrayElement;
1053 auto dst_start_idx = p_layout_->GetGlobalIndexRangeFromBinding(update->dstBinding).start + update->dstArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001054 // Update parameters all look good so perform update
1055 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02001056 auto src = src_set->descriptors_[src_start_idx + di].get();
1057 auto dst = descriptors_[dst_start_idx + di].get();
1058 if (src->updated) {
1059 dst->CopyUpdate(src);
1060 some_update_ = true;
1061 } else {
1062 dst->updated = false;
1063 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001064 }
Tobin Ehlis56a30942016-05-19 08:00:00 -06001065
Jeff Bolzfdf96072018-04-10 14:32:18 -05001066 if (!(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
1067 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
1068 InvalidateBoundCmdBuffers();
1069 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001070}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001071
Tobin Ehlisf9519102016-08-17 09:49:13 -06001072// Bind cb_node to this set and this set to cb_node.
1073// Prereq: This should be called for a set that has been confirmed to be active for the given cb_node, meaning it's going
1074// to be used in a draw by the given cb_node
Tobin Ehlis276d3d32016-12-21 09:21:06 -07001075void cvdescriptorset::DescriptorSet::BindCommandBuffer(GLOBAL_CB_NODE *cb_node,
Tobin Ehlis022528b2016-12-29 12:22:32 -07001076 const std::map<uint32_t, descriptor_req> &binding_req_map) {
Tobin Ehlis9252c2b2016-07-21 14:40:22 -06001077 // bind cb to this descriptor set
1078 cb_bindings.insert(cb_node);
Tobin Ehlis7ca20be2016-10-12 15:09:16 -06001079 // Add bindings for descriptor set, the set's pool, and individual objects in the set
Petr Krausbc7f5442017-05-14 23:43:38 +02001080 cb_node->object_bindings.insert({HandleToUint64(set_), kVulkanObjectTypeDescriptorSet});
Tobin Ehlis7ca20be2016-10-12 15:09:16 -06001081 pool_state_->cb_bindings.insert(cb_node);
Petr Krausbc7f5442017-05-14 23:43:38 +02001082 cb_node->object_bindings.insert({HandleToUint64(pool_state_->pool), kVulkanObjectTypeDescriptorPool});
Tobin Ehlisf9519102016-08-17 09:49:13 -06001083 // For the active slots, use set# to look up descriptorSet from boundDescriptorSets, and bind all of that descriptor set's
1084 // resources
Tobin Ehlis022528b2016-12-29 12:22:32 -07001085 for (auto binding_req_pair : binding_req_map) {
1086 auto binding = binding_req_pair.first;
John Zulaufc483f442017-12-15 14:02:06 -07001087 auto range = p_layout_->GetGlobalIndexRangeFromBinding(binding);
1088 for (uint32_t i = range.start; i < range.end; ++i) {
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001089 descriptors_[i]->BindCommandBuffer(device_data_, cb_node);
1090 }
1091 }
Tobin Ehlis9252c2b2016-07-21 14:40:22 -06001092}
John Zulauf48a6a702017-12-22 17:14:54 -07001093void cvdescriptorset::DescriptorSet::FilterAndTrackOneBindingReq(const BindingReqMap::value_type &binding_req_pair,
1094 const BindingReqMap &in_req, BindingReqMap *out_req,
1095 TrackedBindings *bindings) {
1096 assert(out_req);
1097 assert(bindings);
1098 const auto binding = binding_req_pair.first;
1099 // Use insert and look at the boolean ("was inserted") in the returned pair to see if this is a new set member.
1100 // Saves one hash lookup vs. find ... compare w/ end ... insert.
1101 const auto it_bool_pair = bindings->insert(binding);
1102 if (it_bool_pair.second) {
1103 out_req->emplace(binding_req_pair);
1104 }
1105}
1106void cvdescriptorset::DescriptorSet::FilterAndTrackOneBindingReq(const BindingReqMap::value_type &binding_req_pair,
1107 const BindingReqMap &in_req, BindingReqMap *out_req,
1108 TrackedBindings *bindings, uint32_t limit) {
1109 if (bindings->size() < limit) FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, bindings);
1110}
1111
1112void cvdescriptorset::DescriptorSet::FilterAndTrackBindingReqs(GLOBAL_CB_NODE *cb_state, const BindingReqMap &in_req,
1113 BindingReqMap *out_req) {
1114 TrackedBindings &bound = cached_validation_[cb_state].command_binding_and_usage;
1115 if (bound.size() == GetBindingCount()) {
1116 return; // All bindings are bound, out req is empty
1117 }
1118 for (const auto &binding_req_pair : in_req) {
1119 const auto binding = binding_req_pair.first;
1120 // If a binding doesn't exist, or has already been bound, skip it
1121 if (p_layout_->HasBinding(binding)) {
1122 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, &bound);
1123 }
1124 }
1125}
1126
1127void cvdescriptorset::DescriptorSet::FilterAndTrackBindingReqs(GLOBAL_CB_NODE *cb_state, PIPELINE_STATE *pipeline,
1128 const BindingReqMap &in_req, BindingReqMap *out_req) {
1129 auto &validated = cached_validation_[cb_state];
1130 auto &image_sample_val = validated.image_samplers[pipeline];
1131 auto *const dynamic_buffers = &validated.dynamic_buffers;
1132 auto *const non_dynamic_buffers = &validated.non_dynamic_buffers;
1133 const auto &stats = p_layout_->GetBindingTypeStats();
1134 for (const auto &binding_req_pair : in_req) {
1135 auto binding = binding_req_pair.first;
1136 VkDescriptorSetLayoutBinding const *layout_binding = p_layout_->GetDescriptorSetLayoutBindingPtrFromBinding(binding);
1137 if (!layout_binding) {
1138 continue;
1139 }
1140 // Caching criteria differs per type.
1141 // If image_layout have changed , the image descriptors need to be validated against them.
1142 if ((layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC) ||
1143 (layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
1144 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, dynamic_buffers, stats.dynamic_buffer_count);
1145 } else if ((layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER) ||
1146 (layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER)) {
1147 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, non_dynamic_buffers, stats.non_dynamic_buffer_count);
1148 } else {
1149 // This is rather crude, as the changed layouts may not impact the bound descriptors,
1150 // but the simple "versioning" is a simple "dirt" test.
1151 auto &version = image_sample_val[binding]; // Take advantage of default construtor zero initialzing new entries
1152 if (version != cb_state->image_layout_change_count) {
1153 version = cb_state->image_layout_change_count;
1154 out_req->emplace(binding_req_pair);
1155 }
1156 }
1157 }
1158}
Tobin Ehlis9252c2b2016-07-21 14:40:22 -06001159
Tobin Ehlis300888c2016-05-18 13:43:26 -06001160cvdescriptorset::SamplerDescriptor::SamplerDescriptor(const VkSampler *immut) : sampler_(VK_NULL_HANDLE), immutable_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001161 updated = false;
1162 descriptor_class = PlainSampler;
1163 if (immut) {
1164 sampler_ = *immut;
1165 immutable_ = true;
1166 updated = true;
1167 }
1168}
Tobin Ehlise2f80292016-06-02 10:08:53 -06001169// Validate given sampler. Currently this only checks to make sure it exists in the samplerMap
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001170bool cvdescriptorset::ValidateSampler(const VkSampler sampler, const layer_data *dev_data) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001171 return (GetSamplerState(dev_data, sampler) != nullptr);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001172}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001173
Tobin Ehlis554bf382016-05-24 11:14:43 -06001174bool cvdescriptorset::ValidateImageUpdate(VkImageView image_view, VkImageLayout image_layout, VkDescriptorType type,
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001175 const layer_data *dev_data, UNIQUE_VALIDATION_ERROR_CODE *error_code,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001176 std::string *error_msg) {
1177 // TODO : Defaulting to 00943 for all cases here. Need to create new error codes for various cases.
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001178 *error_code = VALIDATION_ERROR_15c0028c;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001179 auto iv_state = GetImageViewState(dev_data, image_view);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001180 if (!iv_state) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001181 std::stringstream error_str;
1182 error_str << "Invalid VkImageView: " << image_view;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001183 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001184 return false;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001185 }
Tobin Ehlis81280962016-07-20 14:04:20 -06001186 // 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 -06001187 // Validate that imageLayout is compatible with aspect_mask and image format
1188 // and validate that image usage bits are correct for given usage
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001189 VkImageAspectFlags aspect_mask = iv_state->create_info.subresourceRange.aspectMask;
1190 VkImage image = iv_state->create_info.image;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001191 VkFormat format = VK_FORMAT_MAX_ENUM;
1192 VkImageUsageFlags usage = 0;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001193 auto image_node = GetImageState(dev_data, image);
Tobin Ehlis1c9c55f2016-06-02 11:49:22 -06001194 if (image_node) {
1195 format = image_node->createInfo.format;
1196 usage = image_node->createInfo.usage;
Tobin Ehlis029d2fe2016-09-21 09:19:15 -06001197 // Validate that memory is bound to image
Tobin Ehlis2cb8eb22017-01-03 14:09:57 -07001198 // TODO: This should have its own valid usage id apart from 2524 which is from CreateImageView case. The only
1199 // the error here occurs is if memory bound to a created imageView has been freed.
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001200 if (ValidateMemoryIsBoundToImage(dev_data, image_node, "vkUpdateDescriptorSets()", VALIDATION_ERROR_0ac007f8)) {
1201 *error_code = VALIDATION_ERROR_0ac007f8;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001202 *error_msg = "No memory bound to image.";
Tobin Ehlis029d2fe2016-09-21 09:19:15 -06001203 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001204 }
Chris Forbes67757ff2017-07-21 13:59:01 -07001205
1206 // KHR_maintenance1 allows rendering into 2D or 2DArray views which slice a 3D image,
1207 // but not binding them to descriptor sets.
1208 if (image_node->createInfo.imageType == VK_IMAGE_TYPE_3D &&
1209 (iv_state->create_info.viewType == VK_IMAGE_VIEW_TYPE_2D ||
1210 iv_state->create_info.viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
1211 *error_code = VALIDATION_ERROR_046002ae;
1212 *error_msg = "ImageView must not be a 2D or 2DArray view of a 3D image";
1213 return false;
1214 }
Tobin Ehlis1809f912016-05-25 09:24:36 -06001215 }
1216 // First validate that format and layout are compatible
1217 if (format == VK_FORMAT_MAX_ENUM) {
1218 std::stringstream error_str;
1219 error_str << "Invalid image (" << image << ") in imageView (" << image_view << ").";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001220 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001221 return false;
1222 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001223 // TODO : The various image aspect and format checks here are based on general spec language in 11.5 Image Views section under
1224 // vkCreateImageView(). What's the best way to create unique id for these cases?
Dave Houlton1d2022c2017-03-29 11:43:58 -06001225 bool ds = FormatIsDepthOrStencil(format);
Tobin Ehlis1809f912016-05-25 09:24:36 -06001226 switch (image_layout) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001227 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
1228 // Only Color bit must be set
1229 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobin Ehlis1809f912016-05-25 09:24:36 -06001230 std::stringstream error_str;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001231 error_str
1232 << "ImageView (" << image_view
1233 << ") 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 -06001234 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001235 return false;
1236 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001237 // format must NOT be DS
1238 if (ds) {
1239 std::stringstream error_str;
1240 error_str << "ImageView (" << image_view
1241 << ") uses layout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL but the image format is "
1242 << string_VkFormat(format) << " which is not a color format.";
1243 *error_msg = error_str.str();
1244 return false;
1245 }
1246 break;
1247 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
1248 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
1249 // Depth or stencil bit must be set, but both must NOT be set
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001250 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
1251 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
1252 // both must NOT be set
1253 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001254 error_str << "ImageView (" << image_view << ") has both STENCIL and DEPTH aspects set";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001255 *error_msg = error_str.str();
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001256 return false;
1257 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001258 } else if (!(aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
1259 // Neither were set
1260 std::stringstream error_str;
1261 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1262 << " but does not have STENCIL or DEPTH aspects set";
1263 *error_msg = error_str.str();
1264 return false;
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001265 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001266 // format must be DS
1267 if (!ds) {
1268 std::stringstream error_str;
1269 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1270 << " but the image format is " << string_VkFormat(format) << " which is not a depth/stencil format.";
1271 *error_msg = error_str.str();
1272 return false;
1273 }
1274 break;
1275 default:
1276 // For other layouts if the source is depth/stencil image, both aspect bits must not be set
1277 if (ds) {
1278 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
1279 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
1280 // both must NOT be set
1281 std::stringstream error_str;
1282 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1283 << " and is using depth/stencil image of format " << string_VkFormat(format)
1284 << " but it has both STENCIL and DEPTH aspects set, which is illegal. When using a depth/stencil "
1285 "image in a descriptor set, please only set either VK_IMAGE_ASPECT_DEPTH_BIT or "
1286 "VK_IMAGE_ASPECT_STENCIL_BIT depending on whether it will be used for depth reads or stencil "
1287 "reads respectively.";
1288 *error_msg = error_str.str();
1289 return false;
1290 }
1291 }
1292 }
1293 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001294 }
1295 // Now validate that usage flags are correctly set for given type of update
Tobin Ehlisfb4cf712016-10-10 14:02:48 -06001296 // 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 -06001297 // TODO : The various image usage bit requirements are in general spec language for VkImageUsageFlags bit block in 11.3 Images
1298 // under vkCreateImage()
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001299 // TODO : Need to also validate case VALIDATION_ERROR_15c002a0 where STORAGE_IMAGE & INPUT_ATTACH types must have been created
1300 // with identify swizzle
Tobin Ehlis1809f912016-05-25 09:24:36 -06001301 std::string error_usage_bit;
1302 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001303 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1304 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
1305 if (!(usage & VK_IMAGE_USAGE_SAMPLED_BIT)) {
1306 error_usage_bit = "VK_IMAGE_USAGE_SAMPLED_BIT";
1307 }
1308 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001309 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001310 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
1311 if (!(usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
1312 error_usage_bit = "VK_IMAGE_USAGE_STORAGE_BIT";
1313 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
1314 std::stringstream error_str;
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001315 // TODO : Need to create custom enum error codes for these cases
1316 if (image_node->shared_presentable) {
1317 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != image_layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001318 error_str << "ImageView (" << image_view
1319 << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type with a front-buffered image is being updated with "
1320 "layout "
1321 << string_VkImageLayout(image_layout)
1322 << " but according to spec section 13.1 Descriptor Types, 'Front-buffered images that report "
1323 "support for VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT must be in the "
1324 "VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR layout.'";
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001325 *error_msg = error_str.str();
1326 return false;
1327 }
1328 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001329 error_str << "ImageView (" << image_view
1330 << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type is being updated with layout "
1331 << string_VkImageLayout(image_layout)
1332 << " but according to spec section 13.1 Descriptor Types, 'Load and store operations on storage "
1333 "images can only be done on images in VK_IMAGE_LAYOUT_GENERAL layout.'";
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001334 *error_msg = error_str.str();
1335 return false;
1336 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001337 }
1338 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001339 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001340 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT: {
1341 if (!(usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) {
1342 error_usage_bit = "VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT";
1343 }
1344 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001345 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001346 default:
1347 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001348 }
1349 if (!error_usage_bit.empty()) {
1350 std::stringstream error_str;
1351 error_str << "ImageView (" << image_view << ") with usage mask 0x" << usage
1352 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
1353 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001354 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001355 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001356 }
1357 return true;
1358}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001359
Tobin Ehlis300888c2016-05-18 13:43:26 -06001360void cvdescriptorset::SamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Chris Forbesfea2c542018-04-13 09:34:15 -07001361 if (!immutable_) {
1362 sampler_ = update->pImageInfo[index].sampler;
1363 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001364 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001365}
1366
Tobin Ehlis300888c2016-05-18 13:43:26 -06001367void cvdescriptorset::SamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001368 if (!immutable_) {
1369 auto update_sampler = static_cast<const SamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001370 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001371 }
1372 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001373}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001374
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001375void cvdescriptorset::SamplerDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001376 if (!immutable_) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001377 auto sampler_state = GetSamplerState(dev_data, sampler_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001378 if (sampler_state) core_validation::AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001379 }
1380}
1381
Tobin Ehlis300888c2016-05-18 13:43:26 -06001382cvdescriptorset::ImageSamplerDescriptor::ImageSamplerDescriptor(const VkSampler *immut)
Chris Forbes9f340852017-05-09 08:51:38 -07001383 : sampler_(VK_NULL_HANDLE), immutable_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001384 updated = false;
1385 descriptor_class = ImageSampler;
1386 if (immut) {
1387 sampler_ = *immut;
1388 immutable_ = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001389 }
1390}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001391
Tobin Ehlis300888c2016-05-18 13:43:26 -06001392void cvdescriptorset::ImageSamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001393 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001394 const auto &image_info = update->pImageInfo[index];
Chris Forbesfea2c542018-04-13 09:34:15 -07001395 if (!immutable_) {
1396 sampler_ = image_info.sampler;
1397 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001398 image_view_ = image_info.imageView;
1399 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001400}
1401
Tobin Ehlis300888c2016-05-18 13:43:26 -06001402void cvdescriptorset::ImageSamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001403 if (!immutable_) {
1404 auto update_sampler = static_cast<const ImageSamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001405 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001406 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001407 auto image_view = static_cast<const ImageSamplerDescriptor *>(src)->image_view_;
1408 auto image_layout = static_cast<const ImageSamplerDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001409 updated = true;
1410 image_view_ = image_view;
1411 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001412}
1413
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001414void cvdescriptorset::ImageSamplerDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -06001415 // First add binding for any non-immutable sampler
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001416 if (!immutable_) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001417 auto sampler_state = GetSamplerState(dev_data, sampler_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001418 if (sampler_state) core_validation::AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001419 }
Tobin Ehlis81e46372016-08-17 13:33:44 -06001420 // Add binding for image
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001421 auto iv_state = GetImageViewState(dev_data, image_view_);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001422 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -06001423 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001424 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001425}
1426
Tobin Ehlis300888c2016-05-18 13:43:26 -06001427cvdescriptorset::ImageDescriptor::ImageDescriptor(const VkDescriptorType type)
1428 : storage_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001429 updated = false;
1430 descriptor_class = Image;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001431 if (VK_DESCRIPTOR_TYPE_STORAGE_IMAGE == type) storage_ = true;
Petr Kraus13c98a62017-12-09 00:22:39 +01001432}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001433
Tobin Ehlis300888c2016-05-18 13:43:26 -06001434void cvdescriptorset::ImageDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001435 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001436 const auto &image_info = update->pImageInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001437 image_view_ = image_info.imageView;
1438 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001439}
1440
Tobin Ehlis300888c2016-05-18 13:43:26 -06001441void cvdescriptorset::ImageDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001442 auto image_view = static_cast<const ImageDescriptor *>(src)->image_view_;
1443 auto image_layout = static_cast<const ImageDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001444 updated = true;
1445 image_view_ = image_view;
1446 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001447}
1448
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001449void cvdescriptorset::ImageDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -06001450 // Add binding for image
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001451 auto iv_state = GetImageViewState(dev_data, image_view_);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001452 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -06001453 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001454 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001455}
1456
Tobin Ehlis300888c2016-05-18 13:43:26 -06001457cvdescriptorset::BufferDescriptor::BufferDescriptor(const VkDescriptorType type)
1458 : storage_(false), dynamic_(false), buffer_(VK_NULL_HANDLE), offset_(0), range_(0) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001459 updated = false;
1460 descriptor_class = GeneralBuffer;
1461 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
1462 dynamic_ = true;
1463 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type) {
1464 storage_ = true;
1465 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
1466 dynamic_ = true;
1467 storage_ = true;
1468 }
1469}
Tobin Ehlis300888c2016-05-18 13:43:26 -06001470void cvdescriptorset::BufferDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001471 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001472 const auto &buffer_info = update->pBufferInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001473 buffer_ = buffer_info.buffer;
1474 offset_ = buffer_info.offset;
1475 range_ = buffer_info.range;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001476}
1477
Tobin Ehlis300888c2016-05-18 13:43:26 -06001478void cvdescriptorset::BufferDescriptor::CopyUpdate(const Descriptor *src) {
1479 auto buff_desc = static_cast<const BufferDescriptor *>(src);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001480 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001481 buffer_ = buff_desc->buffer_;
1482 offset_ = buff_desc->offset_;
1483 range_ = buff_desc->range_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001484}
1485
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001486void cvdescriptorset::BufferDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001487 auto buffer_node = GetBufferState(dev_data, buffer_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001488 if (buffer_node) core_validation::AddCommandBufferBindingBuffer(dev_data, cb_node, buffer_node);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001489}
1490
Tobin Ehlis300888c2016-05-18 13:43:26 -06001491cvdescriptorset::TexelDescriptor::TexelDescriptor(const VkDescriptorType type) : buffer_view_(VK_NULL_HANDLE), storage_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001492 updated = false;
1493 descriptor_class = TexelBuffer;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001494 if (VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER == type) storage_ = true;
Petr Kraus13c98a62017-12-09 00:22:39 +01001495}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001496
Tobin Ehlis300888c2016-05-18 13:43:26 -06001497void cvdescriptorset::TexelDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001498 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001499 buffer_view_ = update->pTexelBufferView[index];
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001500}
1501
Tobin Ehlis300888c2016-05-18 13:43:26 -06001502void cvdescriptorset::TexelDescriptor::CopyUpdate(const Descriptor *src) {
1503 updated = true;
1504 buffer_view_ = static_cast<const TexelDescriptor *>(src)->buffer_view_;
1505}
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001506
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001507void cvdescriptorset::TexelDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001508 auto bv_state = GetBufferViewState(dev_data, buffer_view_);
Tobin Ehlis8b872462016-09-14 08:12:08 -06001509 if (bv_state) {
Tobin Ehlis2515c0e2016-09-28 07:12:28 -06001510 core_validation::AddCommandBufferBindingBufferView(dev_data, cb_node, bv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001511 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001512}
1513
Tobin Ehlis300888c2016-05-18 13:43:26 -06001514// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1515// sets, and then calls their respective Validate[Write|Copy]Update functions.
1516// If the update hits an issue for which the callback returns "true", meaning that the call down the chain should
1517// be skipped, then true is returned.
1518// If there is no issue with the update, then false is returned.
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001519bool cvdescriptorset::ValidateUpdateDescriptorSets(const debug_report_data *report_data, const layer_data *dev_data,
1520 uint32_t write_count, const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001521 const VkCopyDescriptorSet *p_cds) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001522 bool skip = false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001523 // Validate Write updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001524 for (uint32_t i = 0; i < write_count; i++) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001525 auto dest_set = p_wds[i].dstSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001526 auto set_node = core_validation::GetSetNode(dev_data, dest_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001527 if (!set_node) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001528 skip |=
Tobin Ehlis300888c2016-05-18 13:43:26 -06001529 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 -06001530 HandleToUint64(dest_set), DRAWSTATE_INVALID_DESCRIPTOR_SET,
Tobin Ehlis300888c2016-05-18 13:43:26 -06001531 "Cannot call vkUpdateDescriptorSets() on descriptor set 0x%" PRIxLEAST64 " that has not been allocated.",
Petr Krausbc7f5442017-05-14 23:43:38 +02001532 HandleToUint64(dest_set));
Tobin Ehlis300888c2016-05-18 13:43:26 -06001533 } else {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001534 UNIQUE_VALIDATION_ERROR_CODE error_code;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001535 std::string error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001536 if (!set_node->ValidateWriteUpdate(report_data, &p_wds[i], &error_code, &error_str)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001537 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 -06001538 HandleToUint64(dest_set), error_code,
Artem Kharytoniuk2456f992018-01-12 14:17:41 +01001539 "vkUpdateDescriptorSets() failed write update validation for Descriptor Set 0x%" PRIx64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001540 " with error: %s.",
1541 HandleToUint64(dest_set), error_str.c_str());
Tobin Ehlis300888c2016-05-18 13:43:26 -06001542 }
1543 }
1544 }
1545 // Now validate copy updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001546 for (uint32_t i = 0; i < copy_count; ++i) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001547 auto dst_set = p_cds[i].dstSet;
1548 auto src_set = p_cds[i].srcSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001549 auto src_node = core_validation::GetSetNode(dev_data, src_set);
1550 auto dst_node = core_validation::GetSetNode(dev_data, dst_set);
Tobin Ehlisa1712752017-01-04 09:41:47 -07001551 // Object_tracker verifies that src & dest descriptor set are valid
1552 assert(src_node);
1553 assert(dst_node);
1554 UNIQUE_VALIDATION_ERROR_CODE error_code;
1555 std::string error_str;
1556 if (!dst_node->ValidateCopyUpdate(report_data, &p_cds[i], src_node, &error_code, &error_str)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001557 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 -06001558 HandleToUint64(dst_set), error_code,
Artem Kharytoniuk2456f992018-01-12 14:17:41 +01001559 "vkUpdateDescriptorSets() failed copy update from Descriptor Set 0x%" PRIx64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001560 " to Descriptor Set 0x%" PRIx64 " with error: %s.",
1561 HandleToUint64(src_set), HandleToUint64(dst_set), error_str.c_str());
Tobin Ehlis300888c2016-05-18 13:43:26 -06001562 }
1563 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001564 return skip;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001565}
1566// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1567// sets, and then calls their respective Perform[Write|Copy]Update functions.
1568// Prerequisite : ValidateUpdateDescriptorSets() should be called and return "false" prior to calling PerformUpdateDescriptorSets()
1569// with the same set of updates.
1570// This is split from the validate code to allow validation prior to calling down the chain, and then update after
1571// calling down the chain.
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001572void cvdescriptorset::PerformUpdateDescriptorSets(const layer_data *dev_data, uint32_t write_count,
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001573 const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
1574 const VkCopyDescriptorSet *p_cds) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001575 // Write updates first
1576 uint32_t i = 0;
1577 for (i = 0; i < write_count; ++i) {
1578 auto dest_set = p_wds[i].dstSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001579 auto set_node = core_validation::GetSetNode(dev_data, dest_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001580 if (set_node) {
1581 set_node->PerformWriteUpdate(&p_wds[i]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001582 }
1583 }
1584 // Now copy updates
1585 for (i = 0; i < copy_count; ++i) {
1586 auto dst_set = p_cds[i].dstSet;
1587 auto src_set = p_cds[i].srcSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001588 auto src_node = core_validation::GetSetNode(dev_data, src_set);
1589 auto dst_node = core_validation::GetSetNode(dev_data, dst_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001590 if (src_node && dst_node) {
1591 dst_node->PerformCopyUpdate(&p_cds[i], src_node);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001592 }
1593 }
1594}
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001595// This helper function carries out the state updates for descriptor updates peformed via update templates. It basically collects
1596// data and leverages the PerformUpdateDescriptor helper functions to do this.
1597void cvdescriptorset::PerformUpdateDescriptorSetsWithTemplateKHR(layer_data *device_data, VkDescriptorSet descriptorSet,
1598 std::unique_ptr<TEMPLATE_STATE> const &template_state,
1599 const void *pData) {
1600 auto const &create_info = template_state->create_info;
1601
1602 // Create a vector of write structs
1603 std::vector<VkWriteDescriptorSet> desc_writes;
1604 auto layout_obj = GetDescriptorSetLayout(device_data, create_info.descriptorSetLayout);
1605
1606 // Create a WriteDescriptorSet struct for each template update entry
1607 for (uint32_t i = 0; i < create_info.descriptorUpdateEntryCount; i++) {
1608 auto binding_count = layout_obj->GetDescriptorCountFromBinding(create_info.pDescriptorUpdateEntries[i].dstBinding);
1609 auto binding_being_updated = create_info.pDescriptorUpdateEntries[i].dstBinding;
1610 auto dst_array_element = create_info.pDescriptorUpdateEntries[i].dstArrayElement;
1611
John Zulaufb6d71202017-12-22 16:47:09 -07001612 desc_writes.reserve(desc_writes.size() + create_info.pDescriptorUpdateEntries[i].descriptorCount);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001613 for (uint32_t j = 0; j < create_info.pDescriptorUpdateEntries[i].descriptorCount; j++) {
1614 desc_writes.emplace_back();
1615 auto &write_entry = desc_writes.back();
1616
1617 size_t offset = create_info.pDescriptorUpdateEntries[i].offset + j * create_info.pDescriptorUpdateEntries[i].stride;
1618 char *update_entry = (char *)(pData) + offset;
1619
1620 if (dst_array_element >= binding_count) {
1621 dst_array_element = 0;
Mark Lobodzinski4aa479d2017-03-10 09:14:00 -07001622 binding_being_updated = layout_obj->GetNextValidBinding(binding_being_updated);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001623 }
1624
1625 write_entry.sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
1626 write_entry.pNext = NULL;
1627 write_entry.dstSet = descriptorSet;
1628 write_entry.dstBinding = binding_being_updated;
1629 write_entry.dstArrayElement = dst_array_element;
1630 write_entry.descriptorCount = 1;
1631 write_entry.descriptorType = create_info.pDescriptorUpdateEntries[i].descriptorType;
1632
1633 switch (create_info.pDescriptorUpdateEntries[i].descriptorType) {
1634 case VK_DESCRIPTOR_TYPE_SAMPLER:
1635 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
1636 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1637 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
1638 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
1639 write_entry.pImageInfo = reinterpret_cast<VkDescriptorImageInfo *>(update_entry);
1640 break;
1641
1642 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1643 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1644 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1645 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1646 write_entry.pBufferInfo = reinterpret_cast<VkDescriptorBufferInfo *>(update_entry);
1647 break;
1648
1649 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1650 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1651 write_entry.pTexelBufferView = reinterpret_cast<VkBufferView *>(update_entry);
1652 break;
1653 default:
1654 assert(0);
1655 break;
1656 }
1657 dst_array_element++;
1658 }
1659 }
1660 PerformUpdateDescriptorSets(device_data, static_cast<uint32_t>(desc_writes.size()), desc_writes.data(), 0, NULL);
1661}
Tobin Ehlis300888c2016-05-18 13:43:26 -06001662// Validate the state for a given write update but don't actually perform the update
1663// If an error would occur for this update, return false and fill in details in error_msg string
1664bool cvdescriptorset::DescriptorSet::ValidateWriteUpdate(const debug_report_data *report_data, const VkWriteDescriptorSet *update,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001665 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) {
John Zulauf5dfd45c2018-01-17 11:06:34 -07001666 // Verify dst layout still valid
1667 if (p_layout_->IsDestroyed()) {
John Zulauf5dfd45c2018-01-17 11:06:34 -07001668 *error_code = VALIDATION_ERROR_15c00280;
1669 string_sprintf(error_msg,
1670 "Cannot call vkUpdateDescriptorSets() to perform write update on descriptor set 0x%" PRIxLEAST64
1671 " created with destroyed VkDescriptorSetLayout 0x%" PRIxLEAST64,
1672 HandleToUint64(set_), HandleToUint64(p_layout_->GetDescriptorSetLayout()));
1673 return false;
1674 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001675 // Verify dst binding exists
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001676 if (!p_layout_->HasBinding(update->dstBinding)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001677 *error_code = VALIDATION_ERROR_15c00276;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001678 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001679 error_str << "DescriptorSet " << set_ << " does not have binding " << update->dstBinding;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001680 *error_msg = error_str.str();
1681 return false;
Tobin Ehlis59a5efc2016-11-21 09:41:57 -07001682 } else {
1683 // Make sure binding isn't empty
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001684 if (0 == p_layout_->GetDescriptorCountFromBinding(update->dstBinding)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001685 *error_code = VALIDATION_ERROR_15c00278;
Tobin Ehlis59a5efc2016-11-21 09:41:57 -07001686 std::stringstream error_str;
1687 error_str << "DescriptorSet " << set_ << " cannot updated binding " << update->dstBinding << " that has 0 descriptors";
1688 *error_msg = error_str.str();
1689 return false;
1690 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001691 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05001692 // Verify idle ds
1693 if (in_use.load() &&
1694 !(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
1695 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
1696 // TODO : Re-using Free Idle error code, need write update idle error code
1697 *error_code = VALIDATION_ERROR_2860026a;
1698 std::stringstream error_str;
1699 error_str << "Cannot call vkUpdateDescriptorSets() to perform write update on descriptor set " << set_
1700 << " that is in use by a command buffer";
1701 *error_msg = error_str.str();
1702 return false;
1703 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001704 // We know that binding is valid, verify update and do update on each descriptor
John Zulaufc483f442017-12-15 14:02:06 -07001705 auto start_idx = p_layout_->GetGlobalIndexRangeFromBinding(update->dstBinding).start + update->dstArrayElement;
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001706 auto type = p_layout_->GetTypeFromBinding(update->dstBinding);
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001707 if (type != update->descriptorType) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001708 *error_code = VALIDATION_ERROR_15c0027e;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001709 std::stringstream error_str;
1710 error_str << "Attempting write update to descriptor set " << set_ << " binding #" << update->dstBinding << " with type "
1711 << string_VkDescriptorType(type) << " but update type is " << string_VkDescriptorType(update->descriptorType);
1712 *error_msg = error_str.str();
1713 return false;
1714 }
Tobin Ehlis7b402352016-12-15 07:51:20 -07001715 if (update->descriptorCount > (descriptors_.size() - start_idx)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001716 *error_code = VALIDATION_ERROR_15c00282;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001717 std::stringstream error_str;
1718 error_str << "Attempting write update to descriptor set " << set_ << " binding #" << update->dstBinding << " with "
Tobin Ehlis7b402352016-12-15 07:51:20 -07001719 << descriptors_.size() - start_idx
Tobin Ehlisf922ef82016-11-30 10:19:14 -07001720 << " descriptors in that binding and all successive bindings of the set, but update of "
1721 << update->descriptorCount << " descriptors combined with update array element offset of "
1722 << update->dstArrayElement << " oversteps the available number of consecutive descriptors";
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001723 *error_msg = error_str.str();
1724 return false;
1725 }
1726 // Verify consecutive bindings match (if needed)
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001727 if (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "write update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001728 set_, error_msg)) {
Tobin Ehlis48fbd692017-01-04 09:17:01 -07001729 // TODO : Should break out "consecutive binding updates" language into valid usage statements
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001730 *error_code = VALIDATION_ERROR_15c00282;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001731 return false;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001732 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001733 // Update is within bounds and consistent so last step is to validate update contents
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001734 if (!VerifyWriteUpdateContents(update, start_idx, error_code, error_msg)) {
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001735 std::stringstream error_str;
1736 error_str << "Write update to descriptor in set " << set_ << " binding #" << update->dstBinding
1737 << " failed with error message: " << error_msg->c_str();
1738 *error_msg = error_str.str();
1739 return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001740 }
1741 // All checks passed, update is clean
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001742 return true;
Tobin Ehlis03d61de2016-05-17 08:31:46 -06001743}
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001744// For the given buffer, verify that its creation parameters are appropriate for the given type
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001745// 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 -07001746bool cvdescriptorset::DescriptorSet::ValidateBufferUsage(BUFFER_STATE const *buffer_node, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001747 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) const {
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001748 // Verify that usage bits set correctly for given type
Tobin Ehlis94bc5d22016-06-02 07:46:52 -06001749 auto usage = buffer_node->createInfo.usage;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001750 std::string error_usage_bit;
1751 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001752 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1753 if (!(usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001754 *error_code = VALIDATION_ERROR_15c0029c;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001755 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT";
1756 }
1757 break;
1758 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1759 if (!(usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001760 *error_code = VALIDATION_ERROR_15c0029e;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001761 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT";
1762 }
1763 break;
1764 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1765 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1766 if (!(usage & VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001767 *error_code = VALIDATION_ERROR_15c00292;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001768 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT";
1769 }
1770 break;
1771 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1772 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1773 if (!(usage & VK_BUFFER_USAGE_STORAGE_BUFFER_BIT)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001774 *error_code = VALIDATION_ERROR_15c00296;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001775 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_BUFFER_BIT";
1776 }
1777 break;
1778 default:
1779 break;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001780 }
1781 if (!error_usage_bit.empty()) {
1782 std::stringstream error_str;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001783 error_str << "Buffer (" << buffer_node->buffer << ") with usage mask 0x" << usage
1784 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
1785 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001786 *error_msg = error_str.str();
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001787 return false;
1788 }
1789 return true;
1790}
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001791// For buffer descriptor updates, verify the buffer usage and VkDescriptorBufferInfo struct which includes:
1792// 1. buffer is valid
1793// 2. buffer was created with correct usage flags
1794// 3. offset is less than buffer size
1795// 4. range is either VK_WHOLE_SIZE or falls in (0, (buffer size - offset)]
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001796// 5. range and offset are within the device's limits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001797// 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 -06001798bool cvdescriptorset::DescriptorSet::ValidateBufferUpdate(VkDescriptorBufferInfo const *buffer_info, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001799 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) const {
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001800 // First make sure that buffer is valid
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001801 auto buffer_node = GetBufferState(device_data_, buffer_info->buffer);
Tobin Ehlisfa8b6182016-12-22 13:40:45 -07001802 // Any invalid buffer should already be caught by object_tracker
1803 assert(buffer_node);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001804 if (ValidateMemoryIsBoundToBuffer(device_data_, buffer_node, "vkUpdateDescriptorSets()", VALIDATION_ERROR_15c00294)) {
1805 *error_code = VALIDATION_ERROR_15c00294;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001806 *error_msg = "No memory bound to buffer.";
Tobin Ehlis81280962016-07-20 14:04:20 -06001807 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001808 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001809 // Verify usage bits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001810 if (!ValidateBufferUsage(buffer_node, type, error_code, error_msg)) {
1811 // error_msg will have been updated by ValidateBufferUsage()
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001812 return false;
1813 }
1814 // offset must be less than buffer size
Jeremy Hayesd1a6a822017-03-09 14:39:45 -07001815 if (buffer_info->offset >= buffer_node->createInfo.size) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001816 *error_code = VALIDATION_ERROR_044002a8;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001817 std::stringstream error_str;
Jeremy Hayesd1a6a822017-03-09 14:39:45 -07001818 error_str << "VkDescriptorBufferInfo offset of " << buffer_info->offset << " is greater than or equal to buffer "
1819 << buffer_node->buffer << " size of " << buffer_node->createInfo.size;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001820 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001821 return false;
1822 }
1823 if (buffer_info->range != VK_WHOLE_SIZE) {
1824 // Range must be VK_WHOLE_SIZE or > 0
1825 if (!buffer_info->range) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001826 *error_code = VALIDATION_ERROR_044002aa;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001827 std::stringstream error_str;
1828 error_str << "VkDescriptorBufferInfo range is not VK_WHOLE_SIZE and is zero, which is not allowed.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001829 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001830 return false;
1831 }
1832 // Range must be VK_WHOLE_SIZE or <= (buffer size - offset)
1833 if (buffer_info->range > (buffer_node->createInfo.size - buffer_info->offset)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001834 *error_code = VALIDATION_ERROR_044002ac;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001835 std::stringstream error_str;
1836 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range << " which is greater than buffer size ("
1837 << buffer_node->createInfo.size << ") minus requested offset of " << buffer_info->offset;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001838 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001839 return false;
1840 }
1841 }
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001842 // Check buffer update sizes against device limits
1843 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER == type || VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
1844 auto max_ub_range = limits_.maxUniformBufferRange;
1845 // TODO : If range is WHOLE_SIZE, need to make sure underlying buffer size doesn't exceed device max
1846 if (buffer_info->range != VK_WHOLE_SIZE && buffer_info->range > max_ub_range) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001847 *error_code = VALIDATION_ERROR_15c00298;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001848 std::stringstream error_str;
1849 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range
1850 << " which is greater than this device's maxUniformBufferRange (" << max_ub_range << ")";
1851 *error_msg = error_str.str();
1852 return false;
1853 }
1854 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type || VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
1855 auto max_sb_range = limits_.maxStorageBufferRange;
1856 // TODO : If range is WHOLE_SIZE, need to make sure underlying buffer size doesn't exceed device max
1857 if (buffer_info->range != VK_WHOLE_SIZE && buffer_info->range > max_sb_range) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001858 *error_code = VALIDATION_ERROR_15c0029a;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001859 std::stringstream error_str;
1860 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range
1861 << " which is greater than this device's maxStorageBufferRange (" << max_sb_range << ")";
1862 *error_msg = error_str.str();
1863 return false;
1864 }
1865 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001866 return true;
1867}
1868
Tobin Ehlis300888c2016-05-18 13:43:26 -06001869// Verify that the contents of the update are ok, but don't perform actual update
1870bool cvdescriptorset::DescriptorSet::VerifyWriteUpdateContents(const VkWriteDescriptorSet *update, const uint32_t index,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001871 UNIQUE_VALIDATION_ERROR_CODE *error_code,
1872 std::string *error_msg) const {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001873 switch (update->descriptorType) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001874 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
1875 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1876 // Validate image
1877 auto image_view = update->pImageInfo[di].imageView;
1878 auto image_layout = update->pImageInfo[di].imageLayout;
1879 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001880 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001881 error_str << "Attempted write update to combined image sampler descriptor failed due to: "
1882 << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001883 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001884 return false;
1885 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001886 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001887 // Intentional fall-through to validate sampler
Tobin Ehlis300888c2016-05-18 13:43:26 -06001888 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001889 case VK_DESCRIPTOR_TYPE_SAMPLER: {
1890 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1891 if (!descriptors_[index + di].get()->IsImmutableSampler()) {
1892 if (!ValidateSampler(update->pImageInfo[di].sampler, device_data_)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001893 *error_code = VALIDATION_ERROR_15c0028a;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001894 std::stringstream error_str;
1895 error_str << "Attempted write update to sampler descriptor with invalid sampler: "
1896 << update->pImageInfo[di].sampler << ".";
1897 *error_msg = error_str.str();
1898 return false;
1899 }
1900 } else {
1901 // TODO : Warn here
1902 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001903 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001904 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001905 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001906 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1907 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
1908 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
1909 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1910 auto image_view = update->pImageInfo[di].imageView;
1911 auto image_layout = update->pImageInfo[di].imageLayout;
1912 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, error_code, error_msg)) {
1913 std::stringstream error_str;
1914 error_str << "Attempted write update to image descriptor failed due to: " << error_msg->c_str();
1915 *error_msg = error_str.str();
1916 return false;
1917 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001918 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001919 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001920 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001921 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1922 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER: {
1923 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1924 auto buffer_view = update->pTexelBufferView[di];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001925 auto bv_state = GetBufferViewState(device_data_, buffer_view);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001926 if (!bv_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001927 *error_code = VALIDATION_ERROR_15c00286;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001928 std::stringstream error_str;
1929 error_str << "Attempted write update to texel buffer descriptor with invalid buffer view: " << buffer_view;
1930 *error_msg = error_str.str();
1931 return false;
1932 }
1933 auto buffer = bv_state->create_info.buffer;
Tobin Ehlisdf0d62a2017-10-11 08:48:00 -06001934 auto buffer_state = GetBufferState(device_data_, buffer);
1935 // Verify that buffer underlying the view hasn't been destroyed prematurely
1936 if (!buffer_state) {
1937 *error_code = VALIDATION_ERROR_15c00286;
1938 std::stringstream error_str;
1939 error_str << "Attempted write update to texel buffer descriptor failed because underlying buffer (" << buffer
1940 << ") has been destroyed: " << error_msg->c_str();
1941 *error_msg = error_str.str();
1942 return false;
1943 } else if (!ValidateBufferUsage(buffer_state, update->descriptorType, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001944 std::stringstream error_str;
1945 error_str << "Attempted write update to texel buffer descriptor failed due to: " << error_msg->c_str();
1946 *error_msg = error_str.str();
1947 return false;
1948 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001949 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001950 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001951 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001952 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1953 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1954 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1955 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC: {
1956 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1957 if (!ValidateBufferUpdate(update->pBufferInfo + di, update->descriptorType, error_code, error_msg)) {
1958 std::stringstream error_str;
1959 error_str << "Attempted write update to buffer descriptor failed due to: " << error_msg->c_str();
1960 *error_msg = error_str.str();
1961 return false;
1962 }
1963 }
1964 break;
1965 }
1966 default:
1967 assert(0); // We've already verified update type so should never get here
1968 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001969 }
1970 // All checks passed so update contents are good
1971 return true;
1972}
1973// Verify that the contents of the update are ok, but don't perform actual update
1974bool cvdescriptorset::DescriptorSet::VerifyCopyUpdateContents(const VkCopyDescriptorSet *update, const DescriptorSet *src_set,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001975 VkDescriptorType type, uint32_t index,
1976 UNIQUE_VALIDATION_ERROR_CODE *error_code,
1977 std::string *error_msg) const {
1978 // Note : Repurposing some Write update error codes here as specific details aren't called out for copy updates like they are
1979 // for write updates
Tobin Ehlis300888c2016-05-18 13:43:26 -06001980 switch (src_set->descriptors_[index]->descriptor_class) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001981 case PlainSampler: {
1982 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02001983 const auto src_desc = src_set->descriptors_[index + di].get();
1984 if (!src_desc->updated) continue;
1985 if (!src_desc->IsImmutableSampler()) {
1986 auto update_sampler = static_cast<SamplerDescriptor *>(src_desc)->GetSampler();
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001987 if (!ValidateSampler(update_sampler, device_data_)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001988 *error_code = VALIDATION_ERROR_15c0028a;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001989 std::stringstream error_str;
1990 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
1991 *error_msg = error_str.str();
1992 return false;
1993 }
1994 } else {
1995 // TODO : Warn here
1996 }
1997 }
1998 break;
1999 }
2000 case ImageSampler: {
2001 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02002002 const auto src_desc = src_set->descriptors_[index + di].get();
2003 if (!src_desc->updated) continue;
2004 auto img_samp_desc = static_cast<const ImageSamplerDescriptor *>(src_desc);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002005 // First validate sampler
2006 if (!img_samp_desc->IsImmutableSampler()) {
2007 auto update_sampler = img_samp_desc->GetSampler();
2008 if (!ValidateSampler(update_sampler, device_data_)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002009 *error_code = VALIDATION_ERROR_15c0028a;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002010 std::stringstream error_str;
2011 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
2012 *error_msg = error_str.str();
2013 return false;
2014 }
2015 } else {
2016 // TODO : Warn here
2017 }
2018 // Validate image
2019 auto image_view = img_samp_desc->GetImageView();
2020 auto image_layout = img_samp_desc->GetImageLayout();
2021 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06002022 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002023 error_str << "Attempted copy update to combined image sampler descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002024 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06002025 return false;
2026 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002027 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002028 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002029 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002030 case Image: {
2031 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02002032 const auto src_desc = src_set->descriptors_[index + di].get();
2033 if (!src_desc->updated) continue;
2034 auto img_desc = static_cast<const ImageDescriptor *>(src_desc);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002035 auto image_view = img_desc->GetImageView();
2036 auto image_layout = img_desc->GetImageLayout();
2037 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06002038 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002039 error_str << "Attempted copy update to image descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002040 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06002041 return false;
2042 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002043 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002044 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002045 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002046 case TexelBuffer: {
2047 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02002048 const auto src_desc = src_set->descriptors_[index + di].get();
2049 if (!src_desc->updated) continue;
2050 auto buffer_view = static_cast<TexelDescriptor *>(src_desc)->GetBufferView();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002051 auto bv_state = GetBufferViewState(device_data_, buffer_view);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002052 if (!bv_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002053 *error_code = VALIDATION_ERROR_15c00286;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002054 std::stringstream error_str;
2055 error_str << "Attempted copy update to texel buffer descriptor with invalid buffer view: " << buffer_view;
2056 *error_msg = error_str.str();
2057 return false;
2058 }
2059 auto buffer = bv_state->create_info.buffer;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002060 if (!ValidateBufferUsage(GetBufferState(device_data_, buffer), type, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002061 std::stringstream error_str;
2062 error_str << "Attempted copy update to texel buffer descriptor failed due to: " << error_msg->c_str();
2063 *error_msg = error_str.str();
2064 return false;
2065 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002066 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002067 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002068 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002069 case GeneralBuffer: {
2070 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02002071 const auto src_desc = src_set->descriptors_[index + di].get();
2072 if (!src_desc->updated) continue;
2073 auto buffer = static_cast<BufferDescriptor *>(src_desc)->GetBuffer();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002074 if (!ValidateBufferUsage(GetBufferState(device_data_, buffer), type, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002075 std::stringstream error_str;
2076 error_str << "Attempted copy update to buffer descriptor failed due to: " << error_msg->c_str();
2077 *error_msg = error_str.str();
2078 return false;
2079 }
Tobin Ehliscbcf2342016-05-24 13:07:12 -06002080 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002081 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002082 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002083 default:
2084 assert(0); // We've already verified update type so should never get here
2085 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002086 }
2087 // All checks passed so update contents are good
2088 return true;
Chris Forbesb4e0bdb2016-05-31 16:34:40 +12002089}
Tobin Ehlisf320b192017-03-14 11:22:50 -06002090// Update the common AllocateDescriptorSetsData
2091void cvdescriptorset::UpdateAllocateDescriptorSetsData(const layer_data *dev_data, const VkDescriptorSetAllocateInfo *p_alloc_info,
2092 AllocateDescriptorSetsData *ds_data) {
2093 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
2094 auto layout = GetDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
2095 if (layout) {
2096 ds_data->layout_nodes[i] = layout;
2097 // Count total descriptors required per type
2098 for (uint32_t j = 0; j < layout->GetBindingCount(); ++j) {
2099 const auto &binding_layout = layout->GetDescriptorSetLayoutBindingPtrFromIndex(j);
2100 uint32_t typeIndex = static_cast<uint32_t>(binding_layout->descriptorType);
2101 ds_data->required_descriptors_by_type[typeIndex] += binding_layout->descriptorCount;
2102 }
2103 }
2104 // Any unknown layouts will be flagged as errors during ValidateAllocateDescriptorSets() call
2105 }
Petr Kraus13c98a62017-12-09 00:22:39 +01002106}
Tobin Ehlisee471462016-05-26 11:21:59 -06002107// Verify that the state at allocate time is correct, but don't actually allocate the sets yet
Tobin Ehlisf320b192017-03-14 11:22:50 -06002108bool cvdescriptorset::ValidateAllocateDescriptorSets(const core_validation::layer_data *dev_data,
2109 const VkDescriptorSetAllocateInfo *p_alloc_info,
2110 const AllocateDescriptorSetsData *ds_data) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002111 bool skip = false;
Tobin Ehlisf320b192017-03-14 11:22:50 -06002112 auto report_data = core_validation::GetReportData(dev_data);
Jeff Bolzfdf96072018-04-10 14:32:18 -05002113 auto pool_state = GetDescriptorPoolState(dev_data, p_alloc_info->descriptorPool);
Tobin Ehlisee471462016-05-26 11:21:59 -06002114
2115 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002116 auto layout = GetDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
John Zulauf5562d062018-01-24 11:54:05 -07002117 if (layout) { // nullptr layout indicates no valid layout handle for this device, validated/logged in object_tracker
2118 if (layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR) {
2119 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002120 HandleToUint64(p_alloc_info->pSetLayouts[i]), VALIDATION_ERROR_04c00268,
John Zulauf5562d062018-01-24 11:54:05 -07002121 "Layout 0x%" PRIxLEAST64 " specified at pSetLayouts[%" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002122 "] in vkAllocateDescriptorSets() was created with invalid flag %s set.",
John Zulauf5562d062018-01-24 11:54:05 -07002123 HandleToUint64(p_alloc_info->pSetLayouts[i]), i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002124 "VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR");
John Zulauf5562d062018-01-24 11:54:05 -07002125 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05002126 if (layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT &&
2127 !(pool_state->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
2128 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT,
2129 0, VALIDATION_ERROR_04c017c8,
2130 "Descriptor set layout create flags and pool create flags mismatch for index (%d)", i);
2131 }
Tobin Ehlisee471462016-05-26 11:21:59 -06002132 }
2133 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06002134 if (!GetDeviceExtensions(dev_data)->vk_khr_maintenance1) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002135 // Track number of descriptorSets allowable in this pool
2136 if (pool_state->availableSets < p_alloc_info->descriptorSetCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002137 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002138 HandleToUint64(pool_state->pool), VALIDATION_ERROR_04c00264,
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002139 "Unable to allocate %u descriptorSets from pool 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002140 ". This pool only has %d descriptorSets remaining.",
2141 p_alloc_info->descriptorSetCount, HandleToUint64(pool_state->pool), pool_state->availableSets);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002142 }
2143 // Determine whether descriptor counts are satisfiable
2144 for (uint32_t i = 0; i < VK_DESCRIPTOR_TYPE_RANGE_SIZE; i++) {
2145 if (ds_data->required_descriptors_by_type[i] > pool_state->availableDescriptorTypeCount[i]) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002146 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002147 HandleToUint64(pool_state->pool), VALIDATION_ERROR_04c00266,
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002148 "Unable to allocate %u descriptors of type %s from pool 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002149 ". This pool only has %d descriptors of this type remaining.",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002150 ds_data->required_descriptors_by_type[i], string_VkDescriptorType(VkDescriptorType(i)),
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002151 HandleToUint64(pool_state->pool), pool_state->availableDescriptorTypeCount[i]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002152 }
Tobin Ehlisee471462016-05-26 11:21:59 -06002153 }
2154 }
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06002155
Jeff Bolzfdf96072018-04-10 14:32:18 -05002156 const auto *count_allocate_info = lvl_find_in_chain<VkDescriptorSetVariableDescriptorCountAllocateInfoEXT>(p_alloc_info->pNext);
2157
2158 if (count_allocate_info) {
2159 if (count_allocate_info->descriptorSetCount != 0 &&
2160 count_allocate_info->descriptorSetCount != p_alloc_info->descriptorSetCount) {
2161 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT, 0,
2162 VALIDATION_ERROR_46c017ca,
2163 "VkDescriptorSetAllocateInfo::descriptorSetCount (%d) != "
2164 "VkDescriptorSetVariableDescriptorCountAllocateInfoEXT::descriptorSetCount (%d)",
2165 p_alloc_info->descriptorSetCount, count_allocate_info->descriptorSetCount);
2166 }
2167 if (count_allocate_info->descriptorSetCount == p_alloc_info->descriptorSetCount) {
2168 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
2169 auto layout = GetDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
2170 if (count_allocate_info->pDescriptorCounts[i] > layout->GetDescriptorCountFromBinding(layout->GetMaxBinding())) {
2171 skip |= log_msg(
2172 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT, 0,
2173 VALIDATION_ERROR_46c017cc, "pDescriptorCounts[%d] = (%d), binding's descriptorCount = (%d)", i,
2174 count_allocate_info->pDescriptorCounts[i], layout->GetDescriptorCountFromBinding(layout->GetMaxBinding()));
2175 }
2176 }
2177 }
2178 }
2179
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002180 return skip;
Tobin Ehlisee471462016-05-26 11:21:59 -06002181}
2182// Decrement allocated sets from the pool and insert new sets into set_map
Tobin Ehlis4e380592016-06-02 12:41:47 -06002183void cvdescriptorset::PerformAllocateDescriptorSets(const VkDescriptorSetAllocateInfo *p_alloc_info,
2184 const VkDescriptorSet *descriptor_sets,
2185 const AllocateDescriptorSetsData *ds_data,
Tobin Ehlisbd711bd2016-10-12 14:27:30 -06002186 std::unordered_map<VkDescriptorPool, DESCRIPTOR_POOL_STATE *> *pool_map,
Tobin Ehlis4e380592016-06-02 12:41:47 -06002187 std::unordered_map<VkDescriptorSet, cvdescriptorset::DescriptorSet *> *set_map,
John Zulauf48a6a702017-12-22 17:14:54 -07002188 layer_data *dev_data) {
Tobin Ehlisee471462016-05-26 11:21:59 -06002189 auto pool_state = (*pool_map)[p_alloc_info->descriptorPool];
Mark Lobodzinskic9430182017-06-13 13:00:05 -06002190 // Account for sets and individual descriptors allocated from pool
Tobin Ehlisee471462016-05-26 11:21:59 -06002191 pool_state->availableSets -= p_alloc_info->descriptorSetCount;
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06002192 for (uint32_t i = 0; i < VK_DESCRIPTOR_TYPE_RANGE_SIZE; i++) {
2193 pool_state->availableDescriptorTypeCount[i] -= ds_data->required_descriptors_by_type[i];
2194 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05002195
2196 const auto *variable_count_info = lvl_find_in_chain<VkDescriptorSetVariableDescriptorCountAllocateInfoEXT>(p_alloc_info->pNext);
2197 bool variable_count_valid = variable_count_info && variable_count_info->descriptorSetCount == p_alloc_info->descriptorSetCount;
2198
Mark Lobodzinskic9430182017-06-13 13:00:05 -06002199 // Create tracking object for each descriptor set; insert into global map and the pool's set.
Tobin Ehlisee471462016-05-26 11:21:59 -06002200 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Jeff Bolzfdf96072018-04-10 14:32:18 -05002201 uint32_t variable_count = variable_count_valid ? variable_count_info->pDescriptorCounts[i] : 0;
2202
Tobin Ehlis93f22372016-10-12 14:34:12 -06002203 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 -05002204 variable_count, dev_data);
Tobin Ehlisee471462016-05-26 11:21:59 -06002205
2206 pool_state->sets.insert(new_ds);
2207 new_ds->in_use.store(0);
2208 (*set_map)[descriptor_sets[i]] = new_ds;
2209 }
2210}
John Zulauf48a6a702017-12-22 17:14:54 -07002211
2212cvdescriptorset::PrefilterBindRequestMap::PrefilterBindRequestMap(cvdescriptorset::DescriptorSet &ds, const BindingReqMap &in_map,
2213 GLOBAL_CB_NODE *cb_state)
2214 : filtered_map_(), orig_map_(in_map) {
2215 if (ds.GetTotalDescriptorCount() > kManyDescriptors_) {
2216 filtered_map_.reset(new std::map<uint32_t, descriptor_req>());
2217 ds.FilterAndTrackBindingReqs(cb_state, orig_map_, filtered_map_.get());
2218 }
2219}
2220cvdescriptorset::PrefilterBindRequestMap::PrefilterBindRequestMap(cvdescriptorset::DescriptorSet &ds, const BindingReqMap &in_map,
2221 GLOBAL_CB_NODE *cb_state, PIPELINE_STATE *pipeline)
2222 : filtered_map_(), orig_map_(in_map) {
2223 if (ds.GetTotalDescriptorCount() > kManyDescriptors_) {
2224 filtered_map_.reset(new std::map<uint32_t, descriptor_req>());
2225 ds.FilterAndTrackBindingReqs(cb_state, pipeline, orig_map_, filtered_map_.get());
2226 }
Artem Kharytoniuk2456f992018-01-12 14:17:41 +01002227}