blob: f071fcd9c100475a14be05a481ed4024db8ced55 [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>
19 */
20
Tobin Ehlisf922ef82016-11-30 10:19:14 -070021// Allow use of STL min and max functions in Windows
22#define NOMINMAX
23
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060024#include "descriptor_sets.h"
25#include "vk_enum_string_helper.h"
26#include "vk_safe_struct.h"
27#include <sstream>
Mark Lobodzinski2eee5d82016-12-02 15:33:18 -070028#include <algorithm>
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060029
30// Construct DescriptorSetLayout instance from given create info
Tobin Ehlis154c2692016-10-25 09:36:53 -060031cvdescriptorset::DescriptorSetLayout::DescriptorSetLayout(const VkDescriptorSetLayoutCreateInfo *p_create_info,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060032 const VkDescriptorSetLayout layout)
33 : layout_(layout), binding_count_(p_create_info->bindingCount), descriptor_count_(0), dynamic_descriptor_count_(0) {
Tobin Ehlisa3525e02016-11-17 10:50:52 -070034 // Dyn array indicies are ordered by binding # and array index of any array within the binding
35 // so we store up bindings w/ count in ordered map in order to create dyn array mappings below
36 std::map<uint32_t, uint32_t> binding_to_dyn_count;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060037 for (uint32_t i = 0; i < binding_count_; ++i) {
Tobin Ehlis9637fb22016-12-12 15:59:34 -070038 auto binding_num = p_create_info->pBindings[i].binding;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060039 descriptor_count_ += p_create_info->pBindings[i].descriptorCount;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -070040 uint32_t insert_index = 0; // Track vector index where we insert element
Tobin Ehlis9637fb22016-12-12 15:59:34 -070041 if (bindings_.empty() || binding_num > bindings_.back().binding) {
42 bindings_.push_back(safe_VkDescriptorSetLayoutBinding(&p_create_info->pBindings[i]));
Jamie Madill3f5fd492016-12-19 15:59:18 -050043 insert_index = static_cast<uint32_t>(bindings_.size()) - 1;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -070044 } else { // out-of-order binding number, need to insert into vector in-order
Tobin Ehlis9637fb22016-12-12 15:59:34 -070045 auto it = bindings_.begin();
46 // Find currently binding's spot in vector
47 while (binding_num > it->binding) {
48 assert(it != bindings_.end());
49 ++insert_index;
50 ++it;
51 }
52 bindings_.insert(it, safe_VkDescriptorSetLayoutBinding(&p_create_info->pBindings[i]));
53 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060054 // In cases where we should ignore pImmutableSamplers make sure it's NULL
55 if ((p_create_info->pBindings[i].pImmutableSamplers) &&
56 ((p_create_info->pBindings[i].descriptorType != VK_DESCRIPTOR_TYPE_SAMPLER) &&
57 (p_create_info->pBindings[i].descriptorType != VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER))) {
Tobin Ehlis9637fb22016-12-12 15:59:34 -070058 bindings_[insert_index].pImmutableSamplers = nullptr;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060059 }
60 if (p_create_info->pBindings[i].descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
61 p_create_info->pBindings[i].descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC) {
Tobin Ehlisa3525e02016-11-17 10:50:52 -070062 binding_to_dyn_count[p_create_info->pBindings[i].binding] = p_create_info->pBindings[i].descriptorCount;
Tobin Ehlisef0de162016-06-20 13:07:34 -060063 dynamic_descriptor_count_ += p_create_info->pBindings[i].descriptorCount;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060064 }
65 }
Tobin Ehlis9637fb22016-12-12 15:59:34 -070066 assert(bindings_.size() == binding_count_);
67 uint32_t global_index = 0;
68 // Vector order is finalized so create maps of bindings to indices
69 for (uint32_t i = 0; i < binding_count_; ++i) {
70 auto binding_num = bindings_[i].binding;
71 binding_to_index_map_[binding_num] = i;
72 binding_to_global_start_index_map_[binding_num] = global_index;
73 global_index += bindings_[i].descriptorCount ? bindings_[i].descriptorCount - 1 : 0;
74 binding_to_global_end_index_map_[binding_num] = global_index;
75 global_index += bindings_[i].descriptorCount ? 1 : 0;
76 }
Tobin Ehlisa3525e02016-11-17 10:50:52 -070077 // Now create dyn offset array mapping for any dynamic descriptors
78 uint32_t dyn_array_idx = 0;
79 for (const auto &bc_pair : binding_to_dyn_count) {
80 binding_to_dynamic_array_idx_map_[bc_pair.first] = dyn_array_idx;
81 dyn_array_idx += bc_pair.second;
82 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060083}
Tobin Ehlis154c2692016-10-25 09:36:53 -060084
85// Validate descriptor set layout create info
86bool cvdescriptorset::DescriptorSetLayout::ValidateCreateInfo(debug_report_data *report_data,
87 const VkDescriptorSetLayoutCreateInfo *create_info) {
88 bool skip = false;
89 std::unordered_set<uint32_t> bindings;
90 for (uint32_t i = 0; i < create_info->bindingCount; ++i) {
Tobin Ehlisfdcb63f2016-10-25 20:56:47 -060091 if (!bindings.insert(create_info->pBindings[i].binding).second) {
Tobin Ehlis154c2692016-10-25 09:36:53 -060092 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
93 VALIDATION_ERROR_02345, "DS", "duplicated binding number in VkDescriptorSetLayoutBinding. %s",
94 validation_error_map[VALIDATION_ERROR_02345]);
95 }
Tobin Ehlis154c2692016-10-25 09:36:53 -060096 }
97 return skip;
98}
99
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600100// put all bindings into the given set
101void cvdescriptorset::DescriptorSetLayout::FillBindingSet(std::unordered_set<uint32_t> *binding_set) const {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700102 for (auto binding_index_pair : binding_to_index_map_) binding_set->insert(binding_index_pair.first);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600103}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600104
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700105VkDescriptorSetLayoutBinding const *cvdescriptorset::DescriptorSetLayout::GetDescriptorSetLayoutBindingPtrFromBinding(
106 const uint32_t binding) const {
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600107 const auto &bi_itr = binding_to_index_map_.find(binding);
108 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600109 return bindings_[bi_itr->second].ptr();
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600110 }
111 return nullptr;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600112}
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700113VkDescriptorSetLayoutBinding const *cvdescriptorset::DescriptorSetLayout::GetDescriptorSetLayoutBindingPtrFromIndex(
114 const uint32_t index) const {
115 if (index >= bindings_.size()) return nullptr;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600116 return bindings_[index].ptr();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600117}
118// Return descriptorCount for given binding, 0 if index is unavailable
119uint32_t cvdescriptorset::DescriptorSetLayout::GetDescriptorCountFromBinding(const uint32_t binding) const {
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600120 const auto &bi_itr = binding_to_index_map_.find(binding);
121 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600122 return bindings_[bi_itr->second].descriptorCount;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600123 }
124 return 0;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600125}
126// Return descriptorCount for given index, 0 if index is unavailable
127uint32_t cvdescriptorset::DescriptorSetLayout::GetDescriptorCountFromIndex(const uint32_t index) const {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700128 if (index >= bindings_.size()) return 0;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600129 return bindings_[index].descriptorCount;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600130}
131// For the given binding, return descriptorType
132VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromBinding(const uint32_t binding) const {
133 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600134 const auto &bi_itr = binding_to_index_map_.find(binding);
135 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600136 return bindings_[bi_itr->second].descriptorType;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600137 }
138 return VK_DESCRIPTOR_TYPE_MAX_ENUM;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600139}
140// For the given index, return descriptorType
141VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromIndex(const uint32_t index) const {
142 assert(index < bindings_.size());
Tobin Ehlis664e6012016-05-05 11:04:44 -0600143 return bindings_[index].descriptorType;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600144}
145// For the given global index, return descriptorType
146// Currently just counting up through bindings_, may improve this in future
147VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromGlobalIndex(const uint32_t index) const {
148 uint32_t global_offset = 0;
149 for (auto binding : bindings_) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600150 global_offset += binding.descriptorCount;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700151 if (index < global_offset) return binding.descriptorType;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600152 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700153 assert(0); // requested global index is out of bounds
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600154 return VK_DESCRIPTOR_TYPE_MAX_ENUM;
155}
156// For the given binding, return stageFlags
157VkShaderStageFlags cvdescriptorset::DescriptorSetLayout::GetStageFlagsFromBinding(const uint32_t binding) const {
158 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600159 const auto &bi_itr = binding_to_index_map_.find(binding);
160 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600161 return bindings_[bi_itr->second].stageFlags;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600162 }
163 return VkShaderStageFlags(0);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600164}
165// For the given binding, return start index
166uint32_t cvdescriptorset::DescriptorSetLayout::GetGlobalStartIndexFromBinding(const uint32_t binding) const {
167 assert(binding_to_global_start_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600168 const auto &btgsi_itr = binding_to_global_start_index_map_.find(binding);
169 if (btgsi_itr != binding_to_global_start_index_map_.end()) {
170 return btgsi_itr->second;
171 }
172 // In error case max uint32_t so index is out of bounds to break ASAP
Tobin Ehlis58c59582016-06-21 12:34:33 -0600173 assert(0);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600174 return 0xFFFFFFFF;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600175}
176// For the given binding, return end index
177uint32_t cvdescriptorset::DescriptorSetLayout::GetGlobalEndIndexFromBinding(const uint32_t binding) const {
178 assert(binding_to_global_end_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600179 const auto &btgei_itr = binding_to_global_end_index_map_.find(binding);
180 if (btgei_itr != binding_to_global_end_index_map_.end()) {
181 return btgei_itr->second;
182 }
183 // In error case max uint32_t so index is out of bounds to break ASAP
Tobin Ehlis58c59582016-06-21 12:34:33 -0600184 assert(0);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600185 return 0xFFFFFFFF;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600186}
187// For given binding, return ptr to ImmutableSampler array
188VkSampler const *cvdescriptorset::DescriptorSetLayout::GetImmutableSamplerPtrFromBinding(const uint32_t binding) const {
189 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600190 const auto &bi_itr = binding_to_index_map_.find(binding);
191 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600192 return bindings_[bi_itr->second].pImmutableSamplers;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600193 }
194 return nullptr;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600195}
196// For given index, return ptr to ImmutableSampler array
197VkSampler const *cvdescriptorset::DescriptorSetLayout::GetImmutableSamplerPtrFromIndex(const uint32_t index) const {
198 assert(index < bindings_.size());
Tobin Ehlis664e6012016-05-05 11:04:44 -0600199 return bindings_[index].pImmutableSamplers;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600200}
201// If our layout is compatible with rh_ds_layout, return true,
202// else return false and fill in error_msg will description of what causes incompatibility
203bool cvdescriptorset::DescriptorSetLayout::IsCompatible(const DescriptorSetLayout *rh_ds_layout, std::string *error_msg) const {
204 // Trivial case
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700205 if (layout_ == rh_ds_layout->GetDescriptorSetLayout()) return true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600206 if (descriptor_count_ != rh_ds_layout->descriptor_count_) {
207 std::stringstream error_str;
208 error_str << "DescriptorSetLayout " << layout_ << " has " << descriptor_count_ << " descriptors, but DescriptorSetLayout "
209 << rh_ds_layout->GetDescriptorSetLayout() << " has " << rh_ds_layout->descriptor_count_ << " descriptors.";
210 *error_msg = error_str.str();
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700211 return false; // trivial fail case
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600212 }
213 // Descriptor counts match so need to go through bindings one-by-one
214 // and verify that type and stageFlags match
215 for (auto binding : bindings_) {
216 // TODO : Do we also need to check immutable samplers?
217 // VkDescriptorSetLayoutBinding *rh_binding;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600218 if (binding.descriptorCount != rh_ds_layout->GetDescriptorCountFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600219 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600220 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " has a descriptorCount of "
221 << binding.descriptorCount << " but binding " << binding.binding << " for DescriptorSetLayout "
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600222 << rh_ds_layout->GetDescriptorSetLayout() << " has a descriptorCount of "
Tobin Ehlis664e6012016-05-05 11:04:44 -0600223 << rh_ds_layout->GetDescriptorCountFromBinding(binding.binding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600224 *error_msg = error_str.str();
225 return false;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600226 } else if (binding.descriptorType != rh_ds_layout->GetTypeFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600227 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600228 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " is type '"
229 << string_VkDescriptorType(binding.descriptorType) << "' but binding " << binding.binding
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600230 << " for DescriptorSetLayout " << rh_ds_layout->GetDescriptorSetLayout() << " is type '"
Tobin Ehlis664e6012016-05-05 11:04:44 -0600231 << string_VkDescriptorType(rh_ds_layout->GetTypeFromBinding(binding.binding)) << "'";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600232 *error_msg = error_str.str();
233 return false;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600234 } else if (binding.stageFlags != rh_ds_layout->GetStageFlagsFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600235 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600236 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " has stageFlags "
237 << binding.stageFlags << " but binding " << binding.binding << " for DescriptorSetLayout "
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600238 << rh_ds_layout->GetDescriptorSetLayout() << " has stageFlags "
Tobin Ehlis664e6012016-05-05 11:04:44 -0600239 << rh_ds_layout->GetStageFlagsFromBinding(binding.binding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600240 *error_msg = error_str.str();
241 return false;
242 }
243 }
244 return true;
245}
246
247bool cvdescriptorset::DescriptorSetLayout::IsNextBindingConsistent(const uint32_t binding) const {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700248 if (!binding_to_index_map_.count(binding + 1)) return false;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600249 auto const &bi_itr = binding_to_index_map_.find(binding);
250 if (bi_itr != binding_to_index_map_.end()) {
251 const auto &next_bi_itr = binding_to_index_map_.find(binding + 1);
252 if (next_bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600253 auto type = bindings_[bi_itr->second].descriptorType;
254 auto stage_flags = bindings_[bi_itr->second].stageFlags;
255 auto immut_samp = bindings_[bi_itr->second].pImmutableSamplers ? true : false;
256 if ((type != bindings_[next_bi_itr->second].descriptorType) ||
257 (stage_flags != bindings_[next_bi_itr->second].stageFlags) ||
258 (immut_samp != (bindings_[next_bi_itr->second].pImmutableSamplers ? true : false))) {
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600259 return false;
260 }
261 return true;
262 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600263 }
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600264 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600265}
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600266// Starting at offset descriptor of given binding, parse over update_count
267// descriptor updates and verify that for any binding boundaries that are crossed, the next binding(s) are all consistent
268// Consistency means that their type, stage flags, and whether or not they use immutable samplers matches
269// If so, return true. If not, fill in error_msg and return false
270bool cvdescriptorset::DescriptorSetLayout::VerifyUpdateConsistency(uint32_t current_binding, uint32_t offset, uint32_t update_count,
271 const char *type, const VkDescriptorSet set,
272 std::string *error_msg) const {
273 // Verify consecutive bindings match (if needed)
274 auto orig_binding = current_binding;
275 // Track count of descriptors in the current_bindings that are remaining to be updated
276 auto binding_remaining = GetDescriptorCountFromBinding(current_binding);
277 // First, it's legal to offset beyond your own binding so handle that case
278 // Really this is just searching for the binding in which the update begins and adjusting offset accordingly
279 while (offset >= binding_remaining) {
280 // Advance to next binding, decrement offset by binding size
281 offset -= binding_remaining;
282 binding_remaining = GetDescriptorCountFromBinding(++current_binding);
283 }
284 binding_remaining -= offset;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700285 while (update_count > binding_remaining) { // While our updates overstep current binding
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600286 // Verify next consecutive binding matches type, stage flags & immutable sampler use
287 if (!IsNextBindingConsistent(current_binding++)) {
288 std::stringstream error_str;
289 error_str << "Attempting " << type << " descriptor set " << set << " binding #" << orig_binding << " with #"
290 << update_count << " descriptors being updated but this update oversteps the bounds of this binding and the "
291 "next binding is not consistent with current binding so this update is invalid.";
292 *error_msg = error_str.str();
293 return false;
294 }
295 // For sake of this check consider the bindings updated and grab count for next binding
296 update_count -= binding_remaining;
297 binding_remaining = GetDescriptorCountFromBinding(current_binding);
298 }
299 return true;
300}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600301
Tobin Ehlis68d0adf2016-06-01 11:33:50 -0600302cvdescriptorset::AllocateDescriptorSetsData::AllocateDescriptorSetsData(uint32_t count)
303 : required_descriptors_by_type{}, layout_nodes(count, nullptr) {}
304
Tobin Ehlis93f22372016-10-12 14:34:12 -0600305cvdescriptorset::DescriptorSet::DescriptorSet(const VkDescriptorSet set, const VkDescriptorPool pool,
306 const DescriptorSetLayout *layout, const core_validation::layer_data *dev_data)
Tobin Ehlis7ca20be2016-10-12 15:09:16 -0600307 : some_update_(false), set_(set), pool_state_(nullptr), p_layout_(layout), device_data_(dev_data) {
308 pool_state_ = getDescriptorPoolState(dev_data, pool);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600309 // Foreach binding, create default descriptors of given type
310 for (uint32_t i = 0; i < p_layout_->GetBindingCount(); ++i) {
311 auto type = p_layout_->GetTypeFromIndex(i);
312 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700313 case VK_DESCRIPTOR_TYPE_SAMPLER: {
314 auto immut_sampler = p_layout_->GetImmutableSamplerPtrFromIndex(i);
315 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
316 if (immut_sampler)
317 descriptors_.emplace_back(new SamplerDescriptor(immut_sampler + di));
318 else
319 descriptors_.emplace_back(new SamplerDescriptor());
320 }
321 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600322 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700323 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
324 auto immut = p_layout_->GetImmutableSamplerPtrFromIndex(i);
325 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
326 if (immut)
327 descriptors_.emplace_back(new ImageSamplerDescriptor(immut + di));
328 else
329 descriptors_.emplace_back(new ImageSamplerDescriptor());
330 }
331 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600332 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700333 // ImageDescriptors
334 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
335 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
336 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
337 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
338 descriptors_.emplace_back(new ImageDescriptor(type));
339 break;
340 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
341 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
342 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
343 descriptors_.emplace_back(new TexelDescriptor(type));
344 break;
345 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
346 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
347 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
348 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
349 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
350 descriptors_.emplace_back(new BufferDescriptor(type));
351 break;
352 default:
353 assert(0); // Bad descriptor type specified
354 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600355 }
356 }
357}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600358
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700359cvdescriptorset::DescriptorSet::~DescriptorSet() { InvalidateBoundCmdBuffers(); }
Chris Forbes57989132016-07-26 17:06:10 +1200360
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700361static std::string string_descriptor_req_view_type(descriptor_req req) {
362 std::string result("");
Chris Forbes57989132016-07-26 17:06:10 +1200363 for (unsigned i = 0; i <= VK_IMAGE_VIEW_TYPE_END_RANGE; i++) {
364 if (req & (1 << i)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700365 if (result.size()) result += ", ";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700366 result += string_VkImageViewType(VkImageViewType(i));
Chris Forbes57989132016-07-26 17:06:10 +1200367 }
368 }
369
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700370 if (!result.size()) result = "(none)";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700371
372 return result;
Chris Forbes57989132016-07-26 17:06:10 +1200373}
374
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600375// Is this sets underlying layout compatible with passed in layout according to "Pipeline Layout Compatibility" in spec?
376bool cvdescriptorset::DescriptorSet::IsCompatible(const DescriptorSetLayout *layout, std::string *error) const {
377 return layout->IsCompatible(p_layout_, error);
378}
Chris Forbes57989132016-07-26 17:06:10 +1200379
Tobin Ehlis3066db62016-08-22 08:12:23 -0600380// 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 -0600381// This includes validating that all descriptors in the given bindings are updated,
382// that any update buffers are valid, and that any dynamic offsets are within the bounds of their buffers.
383// Return true if state is acceptable, or false and write an error message into error string
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600384bool cvdescriptorset::DescriptorSet::ValidateDrawState(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600385 const std::vector<uint32_t> &dynamic_offsets, std::string *error) const {
Chris Forbesc7090a82016-07-25 18:10:41 +1200386 for (auto binding_pair : bindings) {
387 auto binding = binding_pair.first;
Tobin Ehlis58c59582016-06-21 12:34:33 -0600388 if (!p_layout_->HasBinding(binding)) {
389 std::stringstream error_str;
390 error_str << "Attempting to validate DrawState for binding #" << binding
391 << " which is an invalid binding for this descriptor set.";
392 *error = error_str.str();
393 return false;
394 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600395 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
Tobin Ehlis81f17852016-05-05 09:04:33 -0600396 if (descriptors_[start_idx]->IsImmutableSampler()) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600397 // Nothing to do for strictly immutable sampler
398 } else {
399 auto end_idx = p_layout_->GetGlobalEndIndexFromBinding(binding);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700400 auto array_idx = 0; // Track array idx if we're dealing with array descriptors
Tobin Ehlisa3525e02016-11-17 10:50:52 -0700401 for (uint32_t i = start_idx; i <= end_idx; ++i, ++array_idx) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600402 if (!descriptors_[i]->updated) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600403 std::stringstream error_str;
404 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
405 << " is being used in draw but has not been updated.";
406 *error = error_str.str();
407 return false;
408 } else {
Chris Forbes57989132016-07-26 17:06:10 +1200409 auto descriptor_class = descriptors_[i]->GetClass();
410 if (descriptor_class == GeneralBuffer) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600411 // Verify that buffers are valid
Tobin Ehlis81f17852016-05-05 09:04:33 -0600412 auto buffer = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetBuffer();
Tobin Ehlis4668dce2016-11-16 09:30:23 -0700413 auto buffer_node = getBufferState(device_data_, buffer);
Tobin Ehlis94bc5d22016-06-02 07:46:52 -0600414 if (!buffer_node) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600415 std::stringstream error_str;
416 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
417 << " references invalid buffer " << buffer << ".";
418 *error = error_str.str();
419 return false;
420 } else {
Tobin Ehlis640a81c2016-11-15 15:37:18 -0700421 for (auto mem_binding : buffer_node->GetBoundMemory()) {
422 if (!getMemObjInfo(device_data_, mem_binding)) {
423 std::stringstream error_str;
424 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
425 << " uses buffer " << buffer << " that references invalid memory " << mem_binding
426 << ".";
427 *error = error_str.str();
428 return false;
429 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600430 }
431 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600432 if (descriptors_[i]->IsDynamic()) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600433 // Validate that dynamic offsets are within the buffer
Tobin Ehlis94bc5d22016-06-02 07:46:52 -0600434 auto buffer_size = buffer_node->createInfo.size;
Tobin Ehlis81f17852016-05-05 09:04:33 -0600435 auto range = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetRange();
436 auto desc_offset = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetOffset();
Tobin Ehlisa3525e02016-11-17 10:50:52 -0700437 auto dyn_offset = dynamic_offsets[GetDynamicOffsetIndexFromBinding(binding) + array_idx];
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600438 if (VK_WHOLE_SIZE == range) {
439 if ((dyn_offset + desc_offset) > buffer_size) {
440 std::stringstream error_str;
441 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
442 << " uses buffer " << buffer
443 << " with update range of VK_WHOLE_SIZE has dynamic offset " << dyn_offset
444 << " combined with offset " << desc_offset << " that oversteps the buffer size of "
445 << buffer_size << ".";
446 *error = error_str.str();
447 return false;
448 }
449 } else {
450 if ((dyn_offset + desc_offset + range) > buffer_size) {
451 std::stringstream error_str;
452 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
453 << " uses buffer " << buffer << " with dynamic offset " << dyn_offset
454 << " combined with offset " << desc_offset << " and range " << range
455 << " that oversteps the buffer size of " << buffer_size << ".";
456 *error = error_str.str();
457 return false;
458 }
459 }
460 }
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700461 } else if (descriptor_class == ImageSampler || descriptor_class == Image) {
Chris Forbes57989132016-07-26 17:06:10 +1200462 auto image_view = (descriptor_class == ImageSampler)
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700463 ? static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetImageView()
464 : static_cast<ImageDescriptor *>(descriptors_[i].get())->GetImageView();
Chris Forbes57989132016-07-26 17:06:10 +1200465 auto reqs = binding_pair.second;
466
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600467 auto image_view_state = getImageViewState(device_data_, image_view);
468 assert(image_view_state);
469 auto image_view_ci = image_view_state->create_info;
Chris Forbes57989132016-07-26 17:06:10 +1200470
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600471 if ((reqs & DESCRIPTOR_REQ_ALL_VIEW_TYPE_BITS) && (~reqs & (1 << image_view_ci.viewType))) {
Chris Forbes57989132016-07-26 17:06:10 +1200472 // bad view type
473 std::stringstream error_str;
474 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700475 << " requires an image view of type " << string_descriptor_req_view_type(reqs) << " but got "
476 << string_VkImageViewType(image_view_ci.viewType) << ".";
Chris Forbes57989132016-07-26 17:06:10 +1200477 *error = error_str.str();
478 return false;
479 }
480
Tobin Ehlis30df15c2016-10-12 17:17:57 -0600481 auto image_node = getImageState(device_data_, image_view_ci.image);
Chris Forbes57989132016-07-26 17:06:10 +1200482 assert(image_node);
483
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700484 if ((reqs & DESCRIPTOR_REQ_SINGLE_SAMPLE) && image_node->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Chris Forbes57989132016-07-26 17:06:10 +1200485 std::stringstream error_str;
486 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
487 << " requires bound image to have VK_SAMPLE_COUNT_1_BIT but got "
488 << string_VkSampleCountFlagBits(image_node->createInfo.samples) << ".";
489 *error = error_str.str();
490 return false;
491 }
492
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700493 if ((reqs & DESCRIPTOR_REQ_MULTI_SAMPLE) && image_node->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Chris Forbes57989132016-07-26 17:06:10 +1200494 std::stringstream error_str;
495 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
496 << " requires bound image to have multiple samples, but got VK_SAMPLE_COUNT_1_BIT.";
497 *error = error_str.str();
498 return false;
499 }
500 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600501 }
502 }
503 }
504 }
505 return true;
506}
Chris Forbes57989132016-07-26 17:06:10 +1200507
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600508// For given bindings, place any update buffers or images into the passed-in unordered_sets
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600509uint32_t cvdescriptorset::DescriptorSet::GetStorageUpdates(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600510 std::unordered_set<VkBuffer> *buffer_set,
511 std::unordered_set<VkImageView> *image_set) const {
512 auto num_updates = 0;
Chris Forbesc7090a82016-07-25 18:10:41 +1200513 for (auto binding_pair : bindings) {
514 auto binding = binding_pair.first;
Tobin Ehlis58c59582016-06-21 12:34:33 -0600515 // If a binding doesn't exist, skip it
516 if (!p_layout_->HasBinding(binding)) {
517 continue;
518 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600519 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
Tobin Ehlis81f17852016-05-05 09:04:33 -0600520 if (descriptors_[start_idx]->IsStorage()) {
521 if (Image == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600522 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600523 if (descriptors_[start_idx + i]->updated) {
524 image_set->insert(static_cast<ImageDescriptor *>(descriptors_[start_idx + i].get())->GetImageView());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600525 num_updates++;
526 }
527 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600528 } else if (TexelBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600529 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600530 if (descriptors_[start_idx + i]->updated) {
531 auto bufferview = static_cast<TexelDescriptor *>(descriptors_[start_idx + i].get())->GetBufferView();
Tobin Ehlis8b872462016-09-14 08:12:08 -0600532 auto bv_state = getBufferViewState(device_data_, bufferview);
533 if (bv_state) {
534 buffer_set->insert(bv_state->create_info.buffer);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600535 num_updates++;
536 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600537 }
538 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600539 } else if (GeneralBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600540 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600541 if (descriptors_[start_idx + i]->updated) {
542 buffer_set->insert(static_cast<BufferDescriptor *>(descriptors_[start_idx + i].get())->GetBuffer());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600543 num_updates++;
544 }
545 }
546 }
547 }
548 }
549 return num_updates;
550}
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600551// Set is being deleted or updates so invalidate all bound cmd buffers
552void cvdescriptorset::DescriptorSet::InvalidateBoundCmdBuffers() {
Tobin Ehlisfe5731a2016-11-21 08:31:01 -0700553 core_validation::invalidateCommandBuffers(device_data_, cb_bindings,
Tobin Ehlis2556f5b2016-06-24 17:22:16 -0600554 {reinterpret_cast<uint64_t &>(set_), VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT});
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600555}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600556// Perform write update in given update struct
Tobin Ehlis300888c2016-05-18 13:43:26 -0600557void cvdescriptorset::DescriptorSet::PerformWriteUpdate(const VkWriteDescriptorSet *update) {
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700558 // Perform update on a per-binding basis as consecutive updates roll over to next binding
559 auto descriptors_remaining = update->descriptorCount;
560 auto binding_being_updated = update->dstBinding;
561 auto offset = update->dstArrayElement;
562 while (descriptors_remaining) {
563 uint32_t update_count = std::min(descriptors_remaining, GetDescriptorCountFromBinding(binding_being_updated));
564 auto global_idx = p_layout_->GetGlobalStartIndexFromBinding(binding_being_updated) + offset;
565 // Loop over the updates for a single binding at a time
566 for (uint32_t di = 0; di < update_count; ++di) {
567 descriptors_[global_idx + di]->WriteUpdate(update, di);
568 }
569 // Roll over to next binding in case of consecutive update
570 descriptors_remaining -= update_count;
571 offset = 0;
572 binding_being_updated++;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600573 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700574 if (update->descriptorCount) some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600575
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600576 InvalidateBoundCmdBuffers();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600577}
Tobin Ehlis300888c2016-05-18 13:43:26 -0600578// Validate Copy update
579bool cvdescriptorset::DescriptorSet::ValidateCopyUpdate(const debug_report_data *report_data, const VkCopyDescriptorSet *update,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600580 const DescriptorSet *src_set, UNIQUE_VALIDATION_ERROR_CODE *error_code,
581 std::string *error_msg) {
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600582 // Verify idle ds
583 if (in_use.load()) {
Tobin Ehlis2cb8eb22017-01-03 14:09:57 -0700584 // TODO : Re-using Free Idle error code, need copy update idle error code
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600585 *error_code = VALIDATION_ERROR_00919;
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600586 std::stringstream error_str;
587 error_str << "Cannot call vkUpdateDescriptorSets() to perform copy update on descriptor set " << set_
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700588 << " that is in use by a command buffer";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600589 *error_msg = error_str.str();
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600590 return false;
591 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600592 if (!p_layout_->HasBinding(update->dstBinding)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600593 *error_code = VALIDATION_ERROR_00966;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600594 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700595 error_str << "DescriptorSet " << set_ << " does not have copy update dest binding of " << update->dstBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600596 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600597 return false;
598 }
599 if (!src_set->HasBinding(update->srcBinding)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600600 *error_code = VALIDATION_ERROR_00964;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600601 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700602 error_str << "DescriptorSet " << set_ << " does not have copy update src binding of " << update->srcBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600603 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600604 return false;
605 }
606 // src & dst set bindings are valid
607 // Check bounds of src & dst
608 auto src_start_idx = src_set->GetGlobalStartIndexFromBinding(update->srcBinding) + update->srcArrayElement;
609 if ((src_start_idx + update->descriptorCount) > src_set->GetTotalDescriptorCount()) {
610 // SRC update out of bounds
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600611 *error_code = VALIDATION_ERROR_00965;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600612 std::stringstream error_str;
613 error_str << "Attempting copy update from descriptorSet " << update->srcSet << " binding#" << update->srcBinding
614 << " with offset index of " << src_set->GetGlobalStartIndexFromBinding(update->srcBinding)
615 << " plus update array offset of " << update->srcArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700616 << " descriptors oversteps total number of descriptors in set: " << src_set->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600617 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600618 return false;
619 }
620 auto dst_start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
621 if ((dst_start_idx + update->descriptorCount) > p_layout_->GetTotalDescriptorCount()) {
622 // DST update out of bounds
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600623 *error_code = VALIDATION_ERROR_00967;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600624 std::stringstream error_str;
625 error_str << "Attempting copy update to descriptorSet " << set_ << " binding#" << update->dstBinding
626 << " with offset index of " << p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding)
627 << " plus update array offset of " << update->dstArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700628 << " descriptors oversteps total number of descriptors in set: " << p_layout_->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600629 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600630 return false;
631 }
632 // Check that types match
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600633 // TODO : Base default error case going from here is VALIDATION_ERROR_00968 which covers all consistency issues, need more
634 // fine-grained error codes
635 *error_code = VALIDATION_ERROR_00968;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600636 auto src_type = src_set->GetTypeFromBinding(update->srcBinding);
637 auto dst_type = p_layout_->GetTypeFromBinding(update->dstBinding);
638 if (src_type != dst_type) {
639 std::stringstream error_str;
640 error_str << "Attempting copy update to descriptorSet " << set_ << " binding #" << update->dstBinding << " with type "
641 << string_VkDescriptorType(dst_type) << " from descriptorSet " << src_set->GetSet() << " binding #"
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700642 << update->srcBinding << " with type " << string_VkDescriptorType(src_type) << ". Types do not match";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600643 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600644 return false;
645 }
646 // Verify consistency of src & dst bindings if update crosses binding boundaries
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600647 if ((!src_set->GetLayout()->VerifyUpdateConsistency(update->srcBinding, update->srcArrayElement, update->descriptorCount,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600648 "copy update from", src_set->GetSet(), error_msg)) ||
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600649 (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "copy update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600650 set_, error_msg))) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600651 return false;
652 }
Tobin Ehlisd41e7b62016-05-19 07:56:18 -0600653 // First make sure source descriptors are updated
654 for (uint32_t i = 0; i < update->descriptorCount; ++i) {
655 if (!src_set->descriptors_[src_start_idx + i]) {
656 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700657 error_str << "Attempting copy update from descriptorSet " << src_set << " binding #" << update->srcBinding
658 << " but descriptor at array offset " << update->srcArrayElement + i << " has not been updated";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600659 *error_msg = error_str.str();
Tobin Ehlisd41e7b62016-05-19 07:56:18 -0600660 return false;
661 }
662 }
663 // Update parameters all look good and descriptor updated so verify update contents
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700664 if (!VerifyCopyUpdateContents(update, src_set, src_type, src_start_idx, error_code, error_msg)) return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -0600665
666 // All checks passed so update is good
667 return true;
668}
669// Perform Copy update
670void cvdescriptorset::DescriptorSet::PerformCopyUpdate(const VkCopyDescriptorSet *update, const DescriptorSet *src_set) {
Tobin Ehlis300888c2016-05-18 13:43:26 -0600671 auto src_start_idx = src_set->GetGlobalStartIndexFromBinding(update->srcBinding) + update->srcArrayElement;
672 auto dst_start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600673 // Update parameters all look good so perform update
674 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Tobin Ehlis300888c2016-05-18 13:43:26 -0600675 descriptors_[dst_start_idx + di]->CopyUpdate(src_set->descriptors_[src_start_idx + di].get());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600676 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700677 if (update->descriptorCount) some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600678
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600679 InvalidateBoundCmdBuffers();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600680}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600681
Tobin Ehlisf9519102016-08-17 09:49:13 -0600682// Bind cb_node to this set and this set to cb_node.
683// Prereq: This should be called for a set that has been confirmed to be active for the given cb_node, meaning it's going
684// to be used in a draw by the given cb_node
Tobin Ehlis276d3d32016-12-21 09:21:06 -0700685void cvdescriptorset::DescriptorSet::BindCommandBuffer(GLOBAL_CB_NODE *cb_node,
Tobin Ehlis022528b2016-12-29 12:22:32 -0700686 const std::map<uint32_t, descriptor_req> &binding_req_map) {
Tobin Ehlis9252c2b2016-07-21 14:40:22 -0600687 // bind cb to this descriptor set
688 cb_bindings.insert(cb_node);
Tobin Ehlis7ca20be2016-10-12 15:09:16 -0600689 // Add bindings for descriptor set, the set's pool, and individual objects in the set
Tobin Ehlis9252c2b2016-07-21 14:40:22 -0600690 cb_node->object_bindings.insert({reinterpret_cast<uint64_t &>(set_), VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT});
Tobin Ehlis7ca20be2016-10-12 15:09:16 -0600691 pool_state_->cb_bindings.insert(cb_node);
692 cb_node->object_bindings.insert(
693 {reinterpret_cast<uint64_t &>(pool_state_->pool), VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT});
Tobin Ehlisf9519102016-08-17 09:49:13 -0600694 // For the active slots, use set# to look up descriptorSet from boundDescriptorSets, and bind all of that descriptor set's
695 // resources
Tobin Ehlis022528b2016-12-29 12:22:32 -0700696 for (auto binding_req_pair : binding_req_map) {
697 auto binding = binding_req_pair.first;
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600698 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
699 auto end_idx = p_layout_->GetGlobalEndIndexFromBinding(binding);
700 for (uint32_t i = start_idx; i <= end_idx; ++i) {
701 descriptors_[i]->BindCommandBuffer(device_data_, cb_node);
702 }
703 }
Tobin Ehlis9252c2b2016-07-21 14:40:22 -0600704}
705
Tobin Ehlis300888c2016-05-18 13:43:26 -0600706cvdescriptorset::SamplerDescriptor::SamplerDescriptor() : sampler_(VK_NULL_HANDLE), immutable_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600707 updated = false;
708 descriptor_class = PlainSampler;
709};
710
Tobin Ehlis300888c2016-05-18 13:43:26 -0600711cvdescriptorset::SamplerDescriptor::SamplerDescriptor(const VkSampler *immut) : sampler_(VK_NULL_HANDLE), immutable_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600712 updated = false;
713 descriptor_class = PlainSampler;
714 if (immut) {
715 sampler_ = *immut;
716 immutable_ = true;
717 updated = true;
718 }
719}
Tobin Ehlise2f80292016-06-02 10:08:53 -0600720// Validate given sampler. Currently this only checks to make sure it exists in the samplerMap
721bool cvdescriptorset::ValidateSampler(const VkSampler sampler, const core_validation::layer_data *dev_data) {
Tobin Ehlisfad7adf2016-10-20 06:50:37 -0600722 return (getSamplerState(dev_data, sampler) != nullptr);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600723}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600724
Tobin Ehlis554bf382016-05-24 11:14:43 -0600725bool cvdescriptorset::ValidateImageUpdate(VkImageView image_view, VkImageLayout image_layout, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600726 const core_validation::layer_data *dev_data, UNIQUE_VALIDATION_ERROR_CODE *error_code,
727 std::string *error_msg) {
728 // TODO : Defaulting to 00943 for all cases here. Need to create new error codes for various cases.
729 *error_code = VALIDATION_ERROR_00943;
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600730 auto iv_state = getImageViewState(dev_data, image_view);
731 if (!iv_state) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600732 std::stringstream error_str;
733 error_str << "Invalid VkImageView: " << image_view;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600734 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600735 return false;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600736 }
Tobin Ehlis81280962016-07-20 14:04:20 -0600737 // 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 -0600738 // Validate that imageLayout is compatible with aspect_mask and image format
739 // and validate that image usage bits are correct for given usage
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600740 VkImageAspectFlags aspect_mask = iv_state->create_info.subresourceRange.aspectMask;
741 VkImage image = iv_state->create_info.image;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600742 VkFormat format = VK_FORMAT_MAX_ENUM;
743 VkImageUsageFlags usage = 0;
Tobin Ehlis30df15c2016-10-12 17:17:57 -0600744 auto image_node = getImageState(dev_data, image);
Tobin Ehlis1c9c55f2016-06-02 11:49:22 -0600745 if (image_node) {
746 format = image_node->createInfo.format;
747 usage = image_node->createInfo.usage;
Tobin Ehlis029d2fe2016-09-21 09:19:15 -0600748 // Validate that memory is bound to image
Tobin Ehlis2cb8eb22017-01-03 14:09:57 -0700749 // TODO: This should have its own valid usage id apart from 2524 which is from CreateImageView case. The only
750 // the error here occurs is if memory bound to a created imageView has been freed.
Tobin Ehlise1995fc2016-12-22 12:45:09 -0700751 if (ValidateMemoryIsBoundToImage(dev_data, image_node, "vkUpdateDescriptorSets()", VALIDATION_ERROR_02524)) {
Tobin Ehlisde1a0f92016-12-22 12:26:32 -0700752 *error_code = VALIDATION_ERROR_02524;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600753 *error_msg = "No memory bound to image.";
Tobin Ehlis029d2fe2016-09-21 09:19:15 -0600754 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -0600755 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600756 } else {
Tobin Ehlis1809f912016-05-25 09:24:36 -0600757 // Also need to check the swapchains.
Tobin Ehlis969a5262016-06-02 12:13:32 -0600758 auto swapchain = getSwapchainFromImage(dev_data, image);
759 if (swapchain) {
Tobin Ehlis4e380592016-06-02 12:41:47 -0600760 auto swapchain_node = getSwapchainNode(dev_data, swapchain);
761 if (swapchain_node) {
762 format = swapchain_node->createInfo.imageFormat;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600763 }
764 }
Tobin Ehlis1809f912016-05-25 09:24:36 -0600765 }
766 // First validate that format and layout are compatible
767 if (format == VK_FORMAT_MAX_ENUM) {
768 std::stringstream error_str;
769 error_str << "Invalid image (" << image << ") in imageView (" << image_view << ").";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600770 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600771 return false;
772 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600773 // TODO : The various image aspect and format checks here are based on general spec language in 11.5 Image Views section under
774 // vkCreateImageView(). What's the best way to create unique id for these cases?
Tobin Ehlis1809f912016-05-25 09:24:36 -0600775 bool ds = vk_format_is_depth_or_stencil(format);
776 switch (image_layout) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700777 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
778 // Only Color bit must be set
779 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobin Ehlis1809f912016-05-25 09:24:36 -0600780 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700781 error_str << "ImageView (" << image_view << ") uses layout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL but does "
782 "not have VK_IMAGE_ASPECT_COLOR_BIT set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600783 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600784 return false;
785 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700786 // format must NOT be DS
787 if (ds) {
788 std::stringstream error_str;
789 error_str << "ImageView (" << image_view
790 << ") uses layout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL but the image format is "
791 << string_VkFormat(format) << " which is not a color format.";
792 *error_msg = error_str.str();
793 return false;
794 }
795 break;
796 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
797 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
798 // Depth or stencil bit must be set, but both must NOT be set
Tobin Ehlisbbf3f912016-06-15 13:03:58 -0600799 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
800 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
801 // both must NOT be set
802 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700803 error_str << "ImageView (" << image_view << ") has both STENCIL and DEPTH aspects set";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600804 *error_msg = error_str.str();
Tobin Ehlisbbf3f912016-06-15 13:03:58 -0600805 return false;
806 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700807 } else if (!(aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
808 // Neither were set
809 std::stringstream error_str;
810 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
811 << " but does not have STENCIL or DEPTH aspects set";
812 *error_msg = error_str.str();
813 return false;
Tobin Ehlisbbf3f912016-06-15 13:03:58 -0600814 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700815 // format must be DS
816 if (!ds) {
817 std::stringstream error_str;
818 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
819 << " but the image format is " << string_VkFormat(format) << " which is not a depth/stencil format.";
820 *error_msg = error_str.str();
821 return false;
822 }
823 break;
824 default:
825 // For other layouts if the source is depth/stencil image, both aspect bits must not be set
826 if (ds) {
827 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
828 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
829 // both must NOT be set
830 std::stringstream error_str;
831 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
832 << " and is using depth/stencil image of format " << string_VkFormat(format)
833 << " but it has both STENCIL and DEPTH aspects set, which is illegal. When using a depth/stencil "
834 "image in a descriptor set, please only set either VK_IMAGE_ASPECT_DEPTH_BIT or "
835 "VK_IMAGE_ASPECT_STENCIL_BIT depending on whether it will be used for depth reads or stencil "
836 "reads respectively.";
837 *error_msg = error_str.str();
838 return false;
839 }
840 }
841 }
842 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600843 }
844 // Now validate that usage flags are correctly set for given type of update
Tobin Ehlisfb4cf712016-10-10 14:02:48 -0600845 // 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 -0600846 // TODO : The various image usage bit requirements are in general spec language for VkImageUsageFlags bit block in 11.3 Images
847 // under vkCreateImage()
848 // TODO : Need to also validate case VALIDATION_ERROR_00952 where STORAGE_IMAGE & INPUT_ATTACH types must have been created with
849 // identify swizzle
Tobin Ehlis1809f912016-05-25 09:24:36 -0600850 std::string error_usage_bit;
851 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700852 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
853 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
854 if (!(usage & VK_IMAGE_USAGE_SAMPLED_BIT)) {
855 error_usage_bit = "VK_IMAGE_USAGE_SAMPLED_BIT";
856 }
857 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600858 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700859 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
860 if (!(usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
861 error_usage_bit = "VK_IMAGE_USAGE_STORAGE_BIT";
862 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
863 std::stringstream error_str;
864 // TODO : Need to create custom enum error code for this case
865 error_str
866 << "ImageView (" << image_view << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type is being updated with layout "
867 << string_VkImageLayout(image_layout)
868 << " but according to spec section 13.1 Descriptor Types, 'Load and store operations on storage images can "
869 "only be done on images in VK_IMAGE_LAYOUT_GENERAL layout.'";
870 *error_msg = error_str.str();
871 return false;
872 }
873 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600874 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700875 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT: {
876 if (!(usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) {
877 error_usage_bit = "VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT";
878 }
879 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600880 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700881 default:
882 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600883 }
884 if (!error_usage_bit.empty()) {
885 std::stringstream error_str;
886 error_str << "ImageView (" << image_view << ") with usage mask 0x" << usage
887 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
888 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600889 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600890 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600891 }
892 return true;
893}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600894
Tobin Ehlis300888c2016-05-18 13:43:26 -0600895void cvdescriptorset::SamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
896 sampler_ = update->pImageInfo[index].sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600897 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600898}
899
Tobin Ehlis300888c2016-05-18 13:43:26 -0600900void cvdescriptorset::SamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600901 if (!immutable_) {
902 auto update_sampler = static_cast<const SamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600903 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600904 }
905 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600906}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600907
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600908void cvdescriptorset::SamplerDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
909 if (!immutable_) {
Tobin Ehlisfad7adf2016-10-20 06:50:37 -0600910 auto sampler_state = getSamplerState(dev_data, sampler_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700911 if (sampler_state) core_validation::AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600912 }
913}
914
Tobin Ehlis300888c2016-05-18 13:43:26 -0600915cvdescriptorset::ImageSamplerDescriptor::ImageSamplerDescriptor()
916 : sampler_(VK_NULL_HANDLE), immutable_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600917 updated = false;
918 descriptor_class = ImageSampler;
919}
920
Tobin Ehlis300888c2016-05-18 13:43:26 -0600921cvdescriptorset::ImageSamplerDescriptor::ImageSamplerDescriptor(const VkSampler *immut)
922 : sampler_(VK_NULL_HANDLE), immutable_(true), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600923 updated = false;
924 descriptor_class = ImageSampler;
925 if (immut) {
926 sampler_ = *immut;
927 immutable_ = true;
928 updated = true;
929 }
930}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600931
Tobin Ehlis300888c2016-05-18 13:43:26 -0600932void cvdescriptorset::ImageSamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600933 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600934 const auto &image_info = update->pImageInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -0600935 sampler_ = image_info.sampler;
936 image_view_ = image_info.imageView;
937 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600938}
939
Tobin Ehlis300888c2016-05-18 13:43:26 -0600940void cvdescriptorset::ImageSamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600941 if (!immutable_) {
942 auto update_sampler = static_cast<const ImageSamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600943 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600944 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600945 auto image_view = static_cast<const ImageSamplerDescriptor *>(src)->image_view_;
946 auto image_layout = static_cast<const ImageSamplerDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600947 updated = true;
948 image_view_ = image_view;
949 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600950}
951
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600952void cvdescriptorset::ImageSamplerDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data,
953 GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -0600954 // First add binding for any non-immutable sampler
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600955 if (!immutable_) {
Tobin Ehlisfad7adf2016-10-20 06:50:37 -0600956 auto sampler_state = getSamplerState(dev_data, sampler_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700957 if (sampler_state) core_validation::AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600958 }
Tobin Ehlis81e46372016-08-17 13:33:44 -0600959 // Add binding for image
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600960 auto iv_state = getImageViewState(dev_data, image_view_);
961 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -0600962 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -0600963 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600964}
965
Tobin Ehlis300888c2016-05-18 13:43:26 -0600966cvdescriptorset::ImageDescriptor::ImageDescriptor(const VkDescriptorType type)
967 : storage_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600968 updated = false;
969 descriptor_class = Image;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700970 if (VK_DESCRIPTOR_TYPE_STORAGE_IMAGE == type) storage_ = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600971};
972
Tobin Ehlis300888c2016-05-18 13:43:26 -0600973void cvdescriptorset::ImageDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600974 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600975 const auto &image_info = update->pImageInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -0600976 image_view_ = image_info.imageView;
977 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600978}
979
Tobin Ehlis300888c2016-05-18 13:43:26 -0600980void cvdescriptorset::ImageDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600981 auto image_view = static_cast<const ImageDescriptor *>(src)->image_view_;
982 auto image_layout = static_cast<const ImageDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600983 updated = true;
984 image_view_ = image_view;
985 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600986}
987
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600988void cvdescriptorset::ImageDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -0600989 // Add binding for image
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600990 auto iv_state = getImageViewState(dev_data, image_view_);
991 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -0600992 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -0600993 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600994}
995
Tobin Ehlis300888c2016-05-18 13:43:26 -0600996cvdescriptorset::BufferDescriptor::BufferDescriptor(const VkDescriptorType type)
997 : storage_(false), dynamic_(false), buffer_(VK_NULL_HANDLE), offset_(0), range_(0) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600998 updated = false;
999 descriptor_class = GeneralBuffer;
1000 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
1001 dynamic_ = true;
1002 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type) {
1003 storage_ = true;
1004 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
1005 dynamic_ = true;
1006 storage_ = true;
1007 }
1008}
Tobin Ehlis300888c2016-05-18 13:43:26 -06001009void cvdescriptorset::BufferDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001010 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001011 const auto &buffer_info = update->pBufferInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001012 buffer_ = buffer_info.buffer;
1013 offset_ = buffer_info.offset;
1014 range_ = buffer_info.range;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001015}
1016
Tobin Ehlis300888c2016-05-18 13:43:26 -06001017void cvdescriptorset::BufferDescriptor::CopyUpdate(const Descriptor *src) {
1018 auto buff_desc = static_cast<const BufferDescriptor *>(src);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001019 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001020 buffer_ = buff_desc->buffer_;
1021 offset_ = buff_desc->offset_;
1022 range_ = buff_desc->range_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001023}
1024
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001025void cvdescriptorset::BufferDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis4668dce2016-11-16 09:30:23 -07001026 auto buffer_node = getBufferState(dev_data, buffer_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001027 if (buffer_node) core_validation::AddCommandBufferBindingBuffer(dev_data, cb_node, buffer_node);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001028}
1029
Tobin Ehlis300888c2016-05-18 13:43:26 -06001030cvdescriptorset::TexelDescriptor::TexelDescriptor(const VkDescriptorType type) : buffer_view_(VK_NULL_HANDLE), storage_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001031 updated = false;
1032 descriptor_class = TexelBuffer;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001033 if (VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER == type) storage_ = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001034};
Tobin Ehlis56a30942016-05-19 08:00:00 -06001035
Tobin Ehlis300888c2016-05-18 13:43:26 -06001036void cvdescriptorset::TexelDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001037 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001038 buffer_view_ = update->pTexelBufferView[index];
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001039}
1040
Tobin Ehlis300888c2016-05-18 13:43:26 -06001041void cvdescriptorset::TexelDescriptor::CopyUpdate(const Descriptor *src) {
1042 updated = true;
1043 buffer_view_ = static_cast<const TexelDescriptor *>(src)->buffer_view_;
1044}
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001045
1046void cvdescriptorset::TexelDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis8b872462016-09-14 08:12:08 -06001047 auto bv_state = getBufferViewState(dev_data, buffer_view_);
1048 if (bv_state) {
Tobin Ehlis2515c0e2016-09-28 07:12:28 -06001049 core_validation::AddCommandBufferBindingBufferView(dev_data, cb_node, bv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001050 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001051}
1052
Tobin Ehlis300888c2016-05-18 13:43:26 -06001053// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1054// sets, and then calls their respective Validate[Write|Copy]Update functions.
1055// If the update hits an issue for which the callback returns "true", meaning that the call down the chain should
1056// be skipped, then true is returned.
1057// If there is no issue with the update, then false is returned.
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001058bool cvdescriptorset::ValidateUpdateDescriptorSets(const debug_report_data *report_data,
1059 const core_validation::layer_data *dev_data, uint32_t write_count,
1060 const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
1061 const VkCopyDescriptorSet *p_cds) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001062 bool skip_call = false;
1063 // Validate Write updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001064 for (uint32_t i = 0; i < write_count; i++) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001065 auto dest_set = p_wds[i].dstSet;
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001066 auto set_node = core_validation::getSetNode(dev_data, dest_set);
1067 if (!set_node) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001068 skip_call |=
1069 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
Tobin Ehlis56a30942016-05-19 08:00:00 -06001070 reinterpret_cast<uint64_t &>(dest_set), __LINE__, DRAWSTATE_INVALID_DESCRIPTOR_SET, "DS",
Tobin Ehlis300888c2016-05-18 13:43:26 -06001071 "Cannot call vkUpdateDescriptorSets() on descriptor set 0x%" PRIxLEAST64 " that has not been allocated.",
1072 reinterpret_cast<uint64_t &>(dest_set));
1073 } else {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001074 UNIQUE_VALIDATION_ERROR_CODE error_code;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001075 std::string error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001076 if (!set_node->ValidateWriteUpdate(report_data, &p_wds[i], &error_code, &error_str)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001077 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001078 reinterpret_cast<uint64_t &>(dest_set), __LINE__, error_code, "DS",
Tobin Ehlis300888c2016-05-18 13:43:26 -06001079 "vkUpdateDescriptorsSets() failed write update validation for Descriptor Set 0x%" PRIx64
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001080 " with error: %s. %s",
1081 reinterpret_cast<uint64_t &>(dest_set), error_str.c_str(), validation_error_map[error_code]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001082 }
1083 }
1084 }
1085 // Now validate copy updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001086 for (uint32_t i = 0; i < copy_count; ++i) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001087 auto dst_set = p_cds[i].dstSet;
1088 auto src_set = p_cds[i].srcSet;
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001089 auto src_node = core_validation::getSetNode(dev_data, src_set);
1090 auto dst_node = core_validation::getSetNode(dev_data, dst_set);
Tobin Ehlisa1712752017-01-04 09:41:47 -07001091 // Object_tracker verifies that src & dest descriptor set are valid
1092 assert(src_node);
1093 assert(dst_node);
1094 UNIQUE_VALIDATION_ERROR_CODE error_code;
1095 std::string error_str;
1096 if (!dst_node->ValidateCopyUpdate(report_data, &p_cds[i], src_node, &error_code, &error_str)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001097 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
Tobin Ehlisa1712752017-01-04 09:41:47 -07001098 reinterpret_cast<uint64_t &>(dst_set), __LINE__, error_code, "DS",
1099 "vkUpdateDescriptorsSets() failed copy update from Descriptor Set 0x%" PRIx64
1100 " to Descriptor Set 0x%" PRIx64 " with error: %s. %s",
1101 reinterpret_cast<uint64_t &>(src_set), reinterpret_cast<uint64_t &>(dst_set), error_str.c_str(),
1102 validation_error_map[error_code]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001103 }
1104 }
1105 return skip_call;
1106}
1107// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1108// sets, and then calls their respective Perform[Write|Copy]Update functions.
1109// Prerequisite : ValidateUpdateDescriptorSets() should be called and return "false" prior to calling PerformUpdateDescriptorSets()
1110// with the same set of updates.
1111// This is split from the validate code to allow validation prior to calling down the chain, and then update after
1112// calling down the chain.
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001113void cvdescriptorset::PerformUpdateDescriptorSets(const core_validation::layer_data *dev_data, uint32_t write_count,
1114 const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
1115 const VkCopyDescriptorSet *p_cds) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001116 // Write updates first
1117 uint32_t i = 0;
1118 for (i = 0; i < write_count; ++i) {
1119 auto dest_set = p_wds[i].dstSet;
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001120 auto set_node = core_validation::getSetNode(dev_data, dest_set);
1121 if (set_node) {
1122 set_node->PerformWriteUpdate(&p_wds[i]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001123 }
1124 }
1125 // Now copy updates
1126 for (i = 0; i < copy_count; ++i) {
1127 auto dst_set = p_cds[i].dstSet;
1128 auto src_set = p_cds[i].srcSet;
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001129 auto src_node = core_validation::getSetNode(dev_data, src_set);
1130 auto dst_node = core_validation::getSetNode(dev_data, dst_set);
1131 if (src_node && dst_node) {
1132 dst_node->PerformCopyUpdate(&p_cds[i], src_node);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001133 }
1134 }
1135}
1136// Validate the state for a given write update but don't actually perform the update
1137// If an error would occur for this update, return false and fill in details in error_msg string
1138bool cvdescriptorset::DescriptorSet::ValidateWriteUpdate(const debug_report_data *report_data, const VkWriteDescriptorSet *update,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001139 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001140 // Verify idle ds
1141 if (in_use.load()) {
Tobin Ehlis2cb8eb22017-01-03 14:09:57 -07001142 // TODO : Re-using Free Idle error code, need write update idle error code
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001143 *error_code = VALIDATION_ERROR_00919;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001144 std::stringstream error_str;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001145 error_str << "Cannot call vkUpdateDescriptorSets() to perform write update on descriptor set " << set_
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001146 << " that is in use by a command buffer";
Tobin Ehlis300888c2016-05-18 13:43:26 -06001147 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001148 return false;
1149 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001150 // Verify dst binding exists
1151 if (!p_layout_->HasBinding(update->dstBinding)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001152 *error_code = VALIDATION_ERROR_00936;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001153 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001154 error_str << "DescriptorSet " << set_ << " does not have binding " << update->dstBinding;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001155 *error_msg = error_str.str();
1156 return false;
Tobin Ehlis59a5efc2016-11-21 09:41:57 -07001157 } else {
1158 // Make sure binding isn't empty
1159 if (0 == p_layout_->GetDescriptorCountFromBinding(update->dstBinding)) {
1160 *error_code = VALIDATION_ERROR_02348;
1161 std::stringstream error_str;
1162 error_str << "DescriptorSet " << set_ << " cannot updated binding " << update->dstBinding << " that has 0 descriptors";
1163 *error_msg = error_str.str();
1164 return false;
1165 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001166 }
1167 // We know that binding is valid, verify update and do update on each descriptor
1168 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
1169 auto type = p_layout_->GetTypeFromBinding(update->dstBinding);
1170 if (type != update->descriptorType) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001171 *error_code = VALIDATION_ERROR_00937;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001172 std::stringstream error_str;
1173 error_str << "Attempting write update to descriptor set " << set_ << " binding #" << update->dstBinding << " with type "
1174 << string_VkDescriptorType(type) << " but update type is " << string_VkDescriptorType(update->descriptorType);
1175 *error_msg = error_str.str();
1176 return false;
1177 }
Tobin Ehlis7b402352016-12-15 07:51:20 -07001178 if (update->descriptorCount > (descriptors_.size() - start_idx)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001179 *error_code = VALIDATION_ERROR_00938;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001180 std::stringstream error_str;
1181 error_str << "Attempting write update to descriptor set " << set_ << " binding #" << update->dstBinding << " with "
Tobin Ehlis7b402352016-12-15 07:51:20 -07001182 << descriptors_.size() - start_idx
Tobin Ehlisf922ef82016-11-30 10:19:14 -07001183 << " descriptors in that binding and all successive bindings of the set, but update of "
1184 << update->descriptorCount << " descriptors combined with update array element offset of "
1185 << update->dstArrayElement << " oversteps the available number of consecutive descriptors";
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001186 *error_msg = error_str.str();
1187 return false;
1188 }
1189 // Verify consecutive bindings match (if needed)
1190 if (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "write update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001191 set_, error_msg)) {
Tobin Ehlis48fbd692017-01-04 09:17:01 -07001192 // TODO : Should break out "consecutive binding updates" language into valid usage statements
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001193 *error_code = VALIDATION_ERROR_00938;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001194 return false;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001195 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001196 // Update is within bounds and consistent so last step is to validate update contents
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001197 if (!VerifyWriteUpdateContents(update, start_idx, error_code, error_msg)) {
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001198 std::stringstream error_str;
1199 error_str << "Write update to descriptor in set " << set_ << " binding #" << update->dstBinding
1200 << " failed with error message: " << error_msg->c_str();
1201 *error_msg = error_str.str();
1202 return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001203 }
1204 // All checks passed, update is clean
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001205 return true;
Tobin Ehlis03d61de2016-05-17 08:31:46 -06001206}
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001207// For the given buffer, verify that its creation parameters are appropriate for the given type
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001208// 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 -07001209bool cvdescriptorset::DescriptorSet::ValidateBufferUsage(BUFFER_STATE const *buffer_node, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001210 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) const {
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001211 // Verify that usage bits set correctly for given type
Tobin Ehlis94bc5d22016-06-02 07:46:52 -06001212 auto usage = buffer_node->createInfo.usage;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001213 std::string error_usage_bit;
1214 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001215 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1216 if (!(usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT)) {
1217 *error_code = VALIDATION_ERROR_00950;
1218 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT";
1219 }
1220 break;
1221 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1222 if (!(usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT)) {
1223 *error_code = VALIDATION_ERROR_00951;
1224 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT";
1225 }
1226 break;
1227 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1228 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1229 if (!(usage & VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT)) {
1230 *error_code = VALIDATION_ERROR_00946;
1231 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT";
1232 }
1233 break;
1234 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1235 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1236 if (!(usage & VK_BUFFER_USAGE_STORAGE_BUFFER_BIT)) {
1237 *error_code = VALIDATION_ERROR_00947;
1238 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_BUFFER_BIT";
1239 }
1240 break;
1241 default:
1242 break;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001243 }
1244 if (!error_usage_bit.empty()) {
1245 std::stringstream error_str;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001246 error_str << "Buffer (" << buffer_node->buffer << ") with usage mask 0x" << usage
1247 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
1248 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001249 *error_msg = error_str.str();
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001250 return false;
1251 }
1252 return true;
1253}
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001254// For buffer descriptor updates, verify the buffer usage and VkDescriptorBufferInfo struct which includes:
1255// 1. buffer is valid
1256// 2. buffer was created with correct usage flags
1257// 3. offset is less than buffer size
1258// 4. range is either VK_WHOLE_SIZE or falls in (0, (buffer size - offset)]
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001259// 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 -06001260bool cvdescriptorset::DescriptorSet::ValidateBufferUpdate(VkDescriptorBufferInfo const *buffer_info, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001261 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) const {
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001262 // First make sure that buffer is valid
Tobin Ehlis4668dce2016-11-16 09:30:23 -07001263 auto buffer_node = getBufferState(device_data_, buffer_info->buffer);
Tobin Ehlisfa8b6182016-12-22 13:40:45 -07001264 // Any invalid buffer should already be caught by object_tracker
1265 assert(buffer_node);
Tobin Ehlise1995fc2016-12-22 12:45:09 -07001266 if (ValidateMemoryIsBoundToBuffer(device_data_, buffer_node, "vkUpdateDescriptorSets()", VALIDATION_ERROR_02525)) {
Tobin Ehlisde1a0f92016-12-22 12:26:32 -07001267 *error_code = VALIDATION_ERROR_02525;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001268 *error_msg = "No memory bound to buffer.";
Tobin Ehlis81280962016-07-20 14:04:20 -06001269 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001270 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001271 // Verify usage bits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001272 if (!ValidateBufferUsage(buffer_node, type, error_code, error_msg)) {
1273 // error_msg will have been updated by ValidateBufferUsage()
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001274 return false;
1275 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001276 // TODO : Need to also validate device limit offset requirements captured in VALIDATION_ERROR_00944,945
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001277 // offset must be less than buffer size
1278 if (buffer_info->offset > buffer_node->createInfo.size) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001279 *error_code = VALIDATION_ERROR_00959;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001280 std::stringstream error_str;
1281 error_str << "VkDescriptorBufferInfo offset of " << buffer_info->offset << " is greater than buffer " << buffer_node->buffer
1282 << " size of " << buffer_node->createInfo.size;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001283 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001284 return false;
1285 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001286 // TODO : Need to also validate device limit range requirements captured in VALIDATION_ERROR_00948,949
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001287 if (buffer_info->range != VK_WHOLE_SIZE) {
1288 // Range must be VK_WHOLE_SIZE or > 0
1289 if (!buffer_info->range) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001290 *error_code = VALIDATION_ERROR_00960;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001291 std::stringstream error_str;
1292 error_str << "VkDescriptorBufferInfo range is not VK_WHOLE_SIZE and is zero, which is not allowed.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001293 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001294 return false;
1295 }
1296 // Range must be VK_WHOLE_SIZE or <= (buffer size - offset)
1297 if (buffer_info->range > (buffer_node->createInfo.size - buffer_info->offset)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001298 *error_code = VALIDATION_ERROR_00961;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001299 std::stringstream error_str;
1300 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range << " which is greater than buffer size ("
1301 << buffer_node->createInfo.size << ") minus requested offset of " << buffer_info->offset;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001302 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001303 return false;
1304 }
1305 }
1306 return true;
1307}
1308
Tobin Ehlis300888c2016-05-18 13:43:26 -06001309// Verify that the contents of the update are ok, but don't perform actual update
1310bool cvdescriptorset::DescriptorSet::VerifyWriteUpdateContents(const VkWriteDescriptorSet *update, const uint32_t index,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001311 UNIQUE_VALIDATION_ERROR_CODE *error_code,
1312 std::string *error_msg) const {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001313 switch (update->descriptorType) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001314 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
1315 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1316 // Validate image
1317 auto image_view = update->pImageInfo[di].imageView;
1318 auto image_layout = update->pImageInfo[di].imageLayout;
1319 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001320 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001321 error_str << "Attempted write update to combined image sampler descriptor failed due to: "
1322 << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001323 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001324 return false;
1325 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001326 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001327 // Intentional fall-through to validate sampler
Tobin Ehlis300888c2016-05-18 13:43:26 -06001328 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001329 case VK_DESCRIPTOR_TYPE_SAMPLER: {
1330 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1331 if (!descriptors_[index + di].get()->IsImmutableSampler()) {
1332 if (!ValidateSampler(update->pImageInfo[di].sampler, device_data_)) {
1333 *error_code = VALIDATION_ERROR_00942;
1334 std::stringstream error_str;
1335 error_str << "Attempted write update to sampler descriptor with invalid sampler: "
1336 << update->pImageInfo[di].sampler << ".";
1337 *error_msg = error_str.str();
1338 return false;
1339 }
1340 } else {
1341 // TODO : Warn here
1342 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001343 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001344 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001345 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001346 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1347 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
1348 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
1349 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1350 auto image_view = update->pImageInfo[di].imageView;
1351 auto image_layout = update->pImageInfo[di].imageLayout;
1352 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, error_code, error_msg)) {
1353 std::stringstream error_str;
1354 error_str << "Attempted write update to image descriptor failed due to: " << error_msg->c_str();
1355 *error_msg = error_str.str();
1356 return false;
1357 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001358 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001359 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001360 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001361 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1362 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER: {
1363 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1364 auto buffer_view = update->pTexelBufferView[di];
1365 auto bv_state = getBufferViewState(device_data_, buffer_view);
1366 if (!bv_state) {
1367 *error_code = VALIDATION_ERROR_00940;
1368 std::stringstream error_str;
1369 error_str << "Attempted write update to texel buffer descriptor with invalid buffer view: " << buffer_view;
1370 *error_msg = error_str.str();
1371 return false;
1372 }
1373 auto buffer = bv_state->create_info.buffer;
1374 if (!ValidateBufferUsage(getBufferState(device_data_, buffer), update->descriptorType, error_code, error_msg)) {
1375 std::stringstream error_str;
1376 error_str << "Attempted write update to texel buffer descriptor failed due to: " << error_msg->c_str();
1377 *error_msg = error_str.str();
1378 return false;
1379 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001380 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001381 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001382 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001383 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1384 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1385 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1386 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC: {
1387 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1388 if (!ValidateBufferUpdate(update->pBufferInfo + di, update->descriptorType, error_code, error_msg)) {
1389 std::stringstream error_str;
1390 error_str << "Attempted write update to buffer descriptor failed due to: " << error_msg->c_str();
1391 *error_msg = error_str.str();
1392 return false;
1393 }
1394 }
1395 break;
1396 }
1397 default:
1398 assert(0); // We've already verified update type so should never get here
1399 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001400 }
1401 // All checks passed so update contents are good
1402 return true;
1403}
1404// Verify that the contents of the update are ok, but don't perform actual update
1405bool cvdescriptorset::DescriptorSet::VerifyCopyUpdateContents(const VkCopyDescriptorSet *update, const DescriptorSet *src_set,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001406 VkDescriptorType type, uint32_t index,
1407 UNIQUE_VALIDATION_ERROR_CODE *error_code,
1408 std::string *error_msg) const {
1409 // Note : Repurposing some Write update error codes here as specific details aren't called out for copy updates like they are
1410 // for write updates
Tobin Ehlis300888c2016-05-18 13:43:26 -06001411 switch (src_set->descriptors_[index]->descriptor_class) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001412 case PlainSampler: {
1413 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1414 if (!src_set->descriptors_[index + di]->IsImmutableSampler()) {
1415 auto update_sampler = static_cast<SamplerDescriptor *>(src_set->descriptors_[index + di].get())->GetSampler();
1416 if (!ValidateSampler(update_sampler, device_data_)) {
1417 *error_code = VALIDATION_ERROR_00942;
1418 std::stringstream error_str;
1419 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
1420 *error_msg = error_str.str();
1421 return false;
1422 }
1423 } else {
1424 // TODO : Warn here
1425 }
1426 }
1427 break;
1428 }
1429 case ImageSampler: {
1430 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1431 auto img_samp_desc = static_cast<const ImageSamplerDescriptor *>(src_set->descriptors_[index + di].get());
1432 // First validate sampler
1433 if (!img_samp_desc->IsImmutableSampler()) {
1434 auto update_sampler = img_samp_desc->GetSampler();
1435 if (!ValidateSampler(update_sampler, device_data_)) {
1436 *error_code = VALIDATION_ERROR_00942;
1437 std::stringstream error_str;
1438 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
1439 *error_msg = error_str.str();
1440 return false;
1441 }
1442 } else {
1443 // TODO : Warn here
1444 }
1445 // Validate image
1446 auto image_view = img_samp_desc->GetImageView();
1447 auto image_layout = img_samp_desc->GetImageLayout();
1448 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001449 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001450 error_str << "Attempted copy update to combined image sampler descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001451 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001452 return false;
1453 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001454 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001455 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001456 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001457 case Image: {
1458 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1459 auto img_desc = static_cast<const ImageDescriptor *>(src_set->descriptors_[index + di].get());
1460 auto image_view = img_desc->GetImageView();
1461 auto image_layout = img_desc->GetImageLayout();
1462 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001463 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001464 error_str << "Attempted copy update to image descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001465 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001466 return false;
1467 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001468 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001469 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001470 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001471 case TexelBuffer: {
1472 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1473 auto buffer_view = static_cast<TexelDescriptor *>(src_set->descriptors_[index + di].get())->GetBufferView();
1474 auto bv_state = getBufferViewState(device_data_, buffer_view);
1475 if (!bv_state) {
1476 *error_code = VALIDATION_ERROR_00940;
1477 std::stringstream error_str;
1478 error_str << "Attempted copy update to texel buffer descriptor with invalid buffer view: " << buffer_view;
1479 *error_msg = error_str.str();
1480 return false;
1481 }
1482 auto buffer = bv_state->create_info.buffer;
1483 if (!ValidateBufferUsage(getBufferState(device_data_, buffer), type, error_code, error_msg)) {
1484 std::stringstream error_str;
1485 error_str << "Attempted copy update to texel buffer descriptor failed due to: " << error_msg->c_str();
1486 *error_msg = error_str.str();
1487 return false;
1488 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001489 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001490 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001491 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001492 case GeneralBuffer: {
1493 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1494 auto buffer = static_cast<BufferDescriptor *>(src_set->descriptors_[index + di].get())->GetBuffer();
1495 if (!ValidateBufferUsage(getBufferState(device_data_, buffer), type, error_code, error_msg)) {
1496 std::stringstream error_str;
1497 error_str << "Attempted copy update to buffer descriptor failed due to: " << error_msg->c_str();
1498 *error_msg = error_str.str();
1499 return false;
1500 }
Tobin Ehliscbcf2342016-05-24 13:07:12 -06001501 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001502 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001503 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001504 default:
1505 assert(0); // We've already verified update type so should never get here
1506 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001507 }
1508 // All checks passed so update contents are good
1509 return true;
Chris Forbesb4e0bdb2016-05-31 16:34:40 +12001510}
Tobin Ehlisee471462016-05-26 11:21:59 -06001511// Verify that the state at allocate time is correct, but don't actually allocate the sets yet
Tobin Ehlis815e8132016-06-02 13:02:17 -06001512bool cvdescriptorset::ValidateAllocateDescriptorSets(const debug_report_data *report_data,
1513 const VkDescriptorSetAllocateInfo *p_alloc_info,
1514 const core_validation::layer_data *dev_data,
1515 AllocateDescriptorSetsData *ds_data) {
Tobin Ehlisee471462016-05-26 11:21:59 -06001516 bool skip_call = false;
Tobin Ehlisee471462016-05-26 11:21:59 -06001517
1518 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Tobin Ehlis815e8132016-06-02 13:02:17 -06001519 auto layout = getDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
1520 if (!layout) {
Tobin Ehlisee471462016-05-26 11:21:59 -06001521 skip_call |=
1522 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT,
1523 reinterpret_cast<const uint64_t &>(p_alloc_info->pSetLayouts[i]), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
1524 "Unable to find set layout node for layout 0x%" PRIxLEAST64 " specified in vkAllocateDescriptorSets() call",
1525 reinterpret_cast<const uint64_t &>(p_alloc_info->pSetLayouts[i]));
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001526 } else {
Tobin Ehlis815e8132016-06-02 13:02:17 -06001527 ds_data->layout_nodes[i] = layout;
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001528 // Count total descriptors required per type
Tobin Ehlis815e8132016-06-02 13:02:17 -06001529 for (uint32_t j = 0; j < layout->GetBindingCount(); ++j) {
1530 const auto &binding_layout = layout->GetDescriptorSetLayoutBindingPtrFromIndex(j);
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001531 uint32_t typeIndex = static_cast<uint32_t>(binding_layout->descriptorType);
1532 ds_data->required_descriptors_by_type[typeIndex] += binding_layout->descriptorCount;
1533 }
Tobin Ehlisee471462016-05-26 11:21:59 -06001534 }
1535 }
Tobin Ehlis15e6f792016-10-12 15:01:39 -06001536 auto pool_state = getDescriptorPoolState(dev_data, p_alloc_info->descriptorPool);
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001537 // Track number of descriptorSets allowable in this pool
Tobin Ehlis15e6f792016-10-12 15:01:39 -06001538 if (pool_state->availableSets < p_alloc_info->descriptorSetCount) {
Tobin Ehlisc4c4bed2016-11-23 12:23:32 -07001539 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT,
1540 reinterpret_cast<uint64_t &>(pool_state->pool), __LINE__, VALIDATION_ERROR_00911, "DS",
1541 "Unable to allocate %u descriptorSets from pool 0x%" PRIxLEAST64
1542 ". This pool only has %d descriptorSets remaining. %s",
1543 p_alloc_info->descriptorSetCount, reinterpret_cast<uint64_t &>(pool_state->pool),
1544 pool_state->availableSets, validation_error_map[VALIDATION_ERROR_00911]);
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001545 }
1546 // Determine whether descriptor counts are satisfiable
1547 for (uint32_t i = 0; i < VK_DESCRIPTOR_TYPE_RANGE_SIZE; i++) {
Tobin Ehlis15e6f792016-10-12 15:01:39 -06001548 if (ds_data->required_descriptors_by_type[i] > pool_state->availableDescriptorTypeCount[i]) {
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001549 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT,
Tobin Ehlisc4c4bed2016-11-23 12:23:32 -07001550 reinterpret_cast<const uint64_t &>(pool_state->pool), __LINE__, VALIDATION_ERROR_00912, "DS",
1551 "Unable to allocate %u descriptors of type %s from pool 0x%" PRIxLEAST64
1552 ". This pool only has %d descriptors of this type remaining. %s",
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001553 ds_data->required_descriptors_by_type[i], string_VkDescriptorType(VkDescriptorType(i)),
Tobin Ehlisc4c4bed2016-11-23 12:23:32 -07001554 reinterpret_cast<uint64_t &>(pool_state->pool), pool_state->availableDescriptorTypeCount[i],
1555 validation_error_map[VALIDATION_ERROR_00912]);
Tobin Ehlisee471462016-05-26 11:21:59 -06001556 }
1557 }
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001558
Tobin Ehlisee471462016-05-26 11:21:59 -06001559 return skip_call;
1560}
1561// Decrement allocated sets from the pool and insert new sets into set_map
Tobin Ehlis4e380592016-06-02 12:41:47 -06001562void cvdescriptorset::PerformAllocateDescriptorSets(const VkDescriptorSetAllocateInfo *p_alloc_info,
1563 const VkDescriptorSet *descriptor_sets,
1564 const AllocateDescriptorSetsData *ds_data,
Tobin Ehlisbd711bd2016-10-12 14:27:30 -06001565 std::unordered_map<VkDescriptorPool, DESCRIPTOR_POOL_STATE *> *pool_map,
Tobin Ehlis4e380592016-06-02 12:41:47 -06001566 std::unordered_map<VkDescriptorSet, cvdescriptorset::DescriptorSet *> *set_map,
1567 const core_validation::layer_data *dev_data) {
Tobin Ehlisee471462016-05-26 11:21:59 -06001568 auto pool_state = (*pool_map)[p_alloc_info->descriptorPool];
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001569 /* Account for sets and individual descriptors allocated from pool */
Tobin Ehlisee471462016-05-26 11:21:59 -06001570 pool_state->availableSets -= p_alloc_info->descriptorSetCount;
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001571 for (uint32_t i = 0; i < VK_DESCRIPTOR_TYPE_RANGE_SIZE; i++) {
1572 pool_state->availableDescriptorTypeCount[i] -= ds_data->required_descriptors_by_type[i];
1573 }
Tobin Ehlisee471462016-05-26 11:21:59 -06001574 /* Create tracking object for each descriptor set; insert into
1575 * global map and the pool's set.
1576 */
1577 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Tobin Ehlis93f22372016-10-12 14:34:12 -06001578 auto new_ds = new cvdescriptorset::DescriptorSet(descriptor_sets[i], p_alloc_info->descriptorPool, ds_data->layout_nodes[i],
1579 dev_data);
Tobin Ehlisee471462016-05-26 11:21:59 -06001580
1581 pool_state->sets.insert(new_ds);
1582 new_ds->in_use.store(0);
1583 (*set_map)[descriptor_sets[i]] = new_ds;
1584 }
1585}