blob: f7baeb0a39d65aaf87755dc71f7571bb000ffd54 [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;
Tobin Ehlis9637fb22016-12-12 15:59:34 -070040 uint32_t insert_index = 0; // Track vector index where we insert element
41 if (bindings_.empty() || binding_num > bindings_.back().binding) {
42 bindings_.push_back(safe_VkDescriptorSetLayoutBinding(&p_create_info->pBindings[i]));
43 insert_index = bindings_.size() - 1;
44 } else { // out-of-order binding number, need to insert into vector in-order
45 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 {
102 for (auto binding_index_pair : binding_to_index_map_)
103 binding_set->insert(binding_index_pair.first);
104}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600105
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600106VkDescriptorSetLayoutBinding const *
107cvdescriptorset::DescriptorSetLayout::GetDescriptorSetLayoutBindingPtrFromBinding(const uint32_t binding) const {
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600108 const auto &bi_itr = binding_to_index_map_.find(binding);
109 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600110 return bindings_[bi_itr->second].ptr();
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600111 }
112 return nullptr;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600113}
114VkDescriptorSetLayoutBinding const *
115cvdescriptorset::DescriptorSetLayout::GetDescriptorSetLayoutBindingPtrFromIndex(const uint32_t index) const {
116 if (index >= bindings_.size())
117 return nullptr;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600118 return bindings_[index].ptr();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600119}
120// Return descriptorCount for given binding, 0 if index is unavailable
121uint32_t cvdescriptorset::DescriptorSetLayout::GetDescriptorCountFromBinding(const uint32_t binding) const {
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600122 const auto &bi_itr = binding_to_index_map_.find(binding);
123 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600124 return bindings_[bi_itr->second].descriptorCount;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600125 }
126 return 0;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600127}
128// Return descriptorCount for given index, 0 if index is unavailable
129uint32_t cvdescriptorset::DescriptorSetLayout::GetDescriptorCountFromIndex(const uint32_t index) const {
130 if (index >= bindings_.size())
131 return 0;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600132 return bindings_[index].descriptorCount;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600133}
134// For the given binding, return descriptorType
135VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromBinding(const uint32_t binding) const {
136 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600137 const auto &bi_itr = binding_to_index_map_.find(binding);
138 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600139 return bindings_[bi_itr->second].descriptorType;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600140 }
141 return VK_DESCRIPTOR_TYPE_MAX_ENUM;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600142}
143// For the given index, return descriptorType
144VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromIndex(const uint32_t index) const {
145 assert(index < bindings_.size());
Tobin Ehlis664e6012016-05-05 11:04:44 -0600146 return bindings_[index].descriptorType;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600147}
148// For the given global index, return descriptorType
149// Currently just counting up through bindings_, may improve this in future
150VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromGlobalIndex(const uint32_t index) const {
151 uint32_t global_offset = 0;
152 for (auto binding : bindings_) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600153 global_offset += binding.descriptorCount;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600154 if (index < global_offset)
Tobin Ehlis664e6012016-05-05 11:04:44 -0600155 return binding.descriptorType;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600156 }
157 assert(0); // requested global index is out of bounds
158 return VK_DESCRIPTOR_TYPE_MAX_ENUM;
159}
160// For the given binding, return stageFlags
161VkShaderStageFlags cvdescriptorset::DescriptorSetLayout::GetStageFlagsFromBinding(const uint32_t binding) const {
162 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600163 const auto &bi_itr = binding_to_index_map_.find(binding);
164 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600165 return bindings_[bi_itr->second].stageFlags;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600166 }
167 return VkShaderStageFlags(0);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600168}
169// For the given binding, return start index
170uint32_t cvdescriptorset::DescriptorSetLayout::GetGlobalStartIndexFromBinding(const uint32_t binding) const {
171 assert(binding_to_global_start_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600172 const auto &btgsi_itr = binding_to_global_start_index_map_.find(binding);
173 if (btgsi_itr != binding_to_global_start_index_map_.end()) {
174 return btgsi_itr->second;
175 }
176 // In error case max uint32_t so index is out of bounds to break ASAP
Tobin Ehlis58c59582016-06-21 12:34:33 -0600177 assert(0);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600178 return 0xFFFFFFFF;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600179}
180// For the given binding, return end index
181uint32_t cvdescriptorset::DescriptorSetLayout::GetGlobalEndIndexFromBinding(const uint32_t binding) const {
182 assert(binding_to_global_end_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600183 const auto &btgei_itr = binding_to_global_end_index_map_.find(binding);
184 if (btgei_itr != binding_to_global_end_index_map_.end()) {
185 return btgei_itr->second;
186 }
187 // In error case max uint32_t so index is out of bounds to break ASAP
Tobin Ehlis58c59582016-06-21 12:34:33 -0600188 assert(0);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600189 return 0xFFFFFFFF;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600190}
191// For given binding, return ptr to ImmutableSampler array
192VkSampler const *cvdescriptorset::DescriptorSetLayout::GetImmutableSamplerPtrFromBinding(const uint32_t binding) const {
193 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600194 const auto &bi_itr = binding_to_index_map_.find(binding);
195 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600196 return bindings_[bi_itr->second].pImmutableSamplers;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600197 }
198 return nullptr;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600199}
200// For given index, return ptr to ImmutableSampler array
201VkSampler const *cvdescriptorset::DescriptorSetLayout::GetImmutableSamplerPtrFromIndex(const uint32_t index) const {
202 assert(index < bindings_.size());
Tobin Ehlis664e6012016-05-05 11:04:44 -0600203 return bindings_[index].pImmutableSamplers;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600204}
205// If our layout is compatible with rh_ds_layout, return true,
206// else return false and fill in error_msg will description of what causes incompatibility
207bool cvdescriptorset::DescriptorSetLayout::IsCompatible(const DescriptorSetLayout *rh_ds_layout, std::string *error_msg) const {
208 // Trivial case
209 if (layout_ == rh_ds_layout->GetDescriptorSetLayout())
210 return true;
211 if (descriptor_count_ != rh_ds_layout->descriptor_count_) {
212 std::stringstream error_str;
213 error_str << "DescriptorSetLayout " << layout_ << " has " << descriptor_count_ << " descriptors, but DescriptorSetLayout "
214 << rh_ds_layout->GetDescriptorSetLayout() << " has " << rh_ds_layout->descriptor_count_ << " descriptors.";
215 *error_msg = error_str.str();
216 return false; // trivial fail case
217 }
218 // Descriptor counts match so need to go through bindings one-by-one
219 // and verify that type and stageFlags match
220 for (auto binding : bindings_) {
221 // TODO : Do we also need to check immutable samplers?
222 // VkDescriptorSetLayoutBinding *rh_binding;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600223 if (binding.descriptorCount != rh_ds_layout->GetDescriptorCountFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600224 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600225 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " has a descriptorCount of "
226 << binding.descriptorCount << " but binding " << binding.binding << " for DescriptorSetLayout "
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600227 << rh_ds_layout->GetDescriptorSetLayout() << " has a descriptorCount of "
Tobin Ehlis664e6012016-05-05 11:04:44 -0600228 << rh_ds_layout->GetDescriptorCountFromBinding(binding.binding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600229 *error_msg = error_str.str();
230 return false;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600231 } else if (binding.descriptorType != rh_ds_layout->GetTypeFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600232 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600233 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " is type '"
234 << string_VkDescriptorType(binding.descriptorType) << "' but binding " << binding.binding
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600235 << " for DescriptorSetLayout " << rh_ds_layout->GetDescriptorSetLayout() << " is type '"
Tobin Ehlis664e6012016-05-05 11:04:44 -0600236 << string_VkDescriptorType(rh_ds_layout->GetTypeFromBinding(binding.binding)) << "'";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600237 *error_msg = error_str.str();
238 return false;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600239 } else if (binding.stageFlags != rh_ds_layout->GetStageFlagsFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600240 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600241 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " has stageFlags "
242 << binding.stageFlags << " but binding " << binding.binding << " for DescriptorSetLayout "
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600243 << rh_ds_layout->GetDescriptorSetLayout() << " has stageFlags "
Tobin Ehlis664e6012016-05-05 11:04:44 -0600244 << rh_ds_layout->GetStageFlagsFromBinding(binding.binding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600245 *error_msg = error_str.str();
246 return false;
247 }
248 }
249 return true;
250}
251
252bool cvdescriptorset::DescriptorSetLayout::IsNextBindingConsistent(const uint32_t binding) const {
253 if (!binding_to_index_map_.count(binding + 1))
254 return false;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600255 auto const &bi_itr = binding_to_index_map_.find(binding);
256 if (bi_itr != binding_to_index_map_.end()) {
257 const auto &next_bi_itr = binding_to_index_map_.find(binding + 1);
258 if (next_bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600259 auto type = bindings_[bi_itr->second].descriptorType;
260 auto stage_flags = bindings_[bi_itr->second].stageFlags;
261 auto immut_samp = bindings_[bi_itr->second].pImmutableSamplers ? true : false;
262 if ((type != bindings_[next_bi_itr->second].descriptorType) ||
263 (stage_flags != bindings_[next_bi_itr->second].stageFlags) ||
264 (immut_samp != (bindings_[next_bi_itr->second].pImmutableSamplers ? true : false))) {
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600265 return false;
266 }
267 return true;
268 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600269 }
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600270 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600271}
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600272// Starting at offset descriptor of given binding, parse over update_count
273// descriptor updates and verify that for any binding boundaries that are crossed, the next binding(s) are all consistent
274// Consistency means that their type, stage flags, and whether or not they use immutable samplers matches
275// If so, return true. If not, fill in error_msg and return false
276bool cvdescriptorset::DescriptorSetLayout::VerifyUpdateConsistency(uint32_t current_binding, uint32_t offset, uint32_t update_count,
277 const char *type, const VkDescriptorSet set,
278 std::string *error_msg) const {
279 // Verify consecutive bindings match (if needed)
280 auto orig_binding = current_binding;
281 // Track count of descriptors in the current_bindings that are remaining to be updated
282 auto binding_remaining = GetDescriptorCountFromBinding(current_binding);
283 // First, it's legal to offset beyond your own binding so handle that case
284 // Really this is just searching for the binding in which the update begins and adjusting offset accordingly
285 while (offset >= binding_remaining) {
286 // Advance to next binding, decrement offset by binding size
287 offset -= binding_remaining;
288 binding_remaining = GetDescriptorCountFromBinding(++current_binding);
289 }
290 binding_remaining -= offset;
291 while (update_count > binding_remaining) { // While our updates overstep current binding
292 // Verify next consecutive binding matches type, stage flags & immutable sampler use
293 if (!IsNextBindingConsistent(current_binding++)) {
294 std::stringstream error_str;
295 error_str << "Attempting " << type << " descriptor set " << set << " binding #" << orig_binding << " with #"
296 << update_count << " descriptors being updated but this update oversteps the bounds of this binding and the "
297 "next binding is not consistent with current binding so this update is invalid.";
298 *error_msg = error_str.str();
299 return false;
300 }
301 // For sake of this check consider the bindings updated and grab count for next binding
302 update_count -= binding_remaining;
303 binding_remaining = GetDescriptorCountFromBinding(current_binding);
304 }
305 return true;
306}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600307
Tobin Ehlis68d0adf2016-06-01 11:33:50 -0600308cvdescriptorset::AllocateDescriptorSetsData::AllocateDescriptorSetsData(uint32_t count)
309 : required_descriptors_by_type{}, layout_nodes(count, nullptr) {}
310
Tobin Ehlis93f22372016-10-12 14:34:12 -0600311cvdescriptorset::DescriptorSet::DescriptorSet(const VkDescriptorSet set, const VkDescriptorPool pool,
312 const DescriptorSetLayout *layout, const core_validation::layer_data *dev_data)
Tobin Ehlis7ca20be2016-10-12 15:09:16 -0600313 : some_update_(false), set_(set), pool_state_(nullptr), p_layout_(layout), device_data_(dev_data) {
314 pool_state_ = getDescriptorPoolState(dev_data, pool);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600315 // Foreach binding, create default descriptors of given type
316 for (uint32_t i = 0; i < p_layout_->GetBindingCount(); ++i) {
317 auto type = p_layout_->GetTypeFromIndex(i);
318 switch (type) {
319 case VK_DESCRIPTOR_TYPE_SAMPLER: {
320 auto immut_sampler = p_layout_->GetImmutableSamplerPtrFromIndex(i);
321 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
322 if (immut_sampler)
Chris Forbescb621ea2016-05-30 11:47:31 +1200323 descriptors_.emplace_back(new SamplerDescriptor(immut_sampler + di));
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600324 else
Chris Forbescb621ea2016-05-30 11:47:31 +1200325 descriptors_.emplace_back(new SamplerDescriptor());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600326 }
327 break;
328 }
329 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
330 auto immut = p_layout_->GetImmutableSamplerPtrFromIndex(i);
331 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
332 if (immut)
Chris Forbescb621ea2016-05-30 11:47:31 +1200333 descriptors_.emplace_back(new ImageSamplerDescriptor(immut + di));
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600334 else
Chris Forbescb621ea2016-05-30 11:47:31 +1200335 descriptors_.emplace_back(new ImageSamplerDescriptor());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600336 }
337 break;
338 }
339 // ImageDescriptors
340 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
341 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
342 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
343 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Chris Forbescb621ea2016-05-30 11:47:31 +1200344 descriptors_.emplace_back(new ImageDescriptor(type));
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600345 break;
346 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
347 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
348 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Chris Forbescb621ea2016-05-30 11:47:31 +1200349 descriptors_.emplace_back(new TexelDescriptor(type));
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600350 break;
351 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
352 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
353 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
354 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
355 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Chris Forbescb621ea2016-05-30 11:47:31 +1200356 descriptors_.emplace_back(new BufferDescriptor(type));
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600357 break;
358 default:
Tobin Ehlis81f17852016-05-05 09:04:33 -0600359 assert(0); // Bad descriptor type specified
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600360 break;
361 }
362 }
363}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600364
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600365cvdescriptorset::DescriptorSet::~DescriptorSet() {
366 InvalidateBoundCmdBuffers();
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600367}
Chris Forbes57989132016-07-26 17:06:10 +1200368
369
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700370static std::string string_descriptor_req_view_type(descriptor_req req) {
371 std::string result("");
Chris Forbes57989132016-07-26 17:06:10 +1200372 for (unsigned i = 0; i <= VK_IMAGE_VIEW_TYPE_END_RANGE; i++) {
373 if (req & (1 << i)) {
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700374 if (result.size()) result += ", ";
375 result += string_VkImageViewType(VkImageViewType(i));
Chris Forbes57989132016-07-26 17:06:10 +1200376 }
377 }
378
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700379 if (!result.size())
380 result = "(none)";
381
382 return result;
Chris Forbes57989132016-07-26 17:06:10 +1200383}
384
385
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600386// Is this sets underlying layout compatible with passed in layout according to "Pipeline Layout Compatibility" in spec?
387bool cvdescriptorset::DescriptorSet::IsCompatible(const DescriptorSetLayout *layout, std::string *error) const {
388 return layout->IsCompatible(p_layout_, error);
389}
Chris Forbes57989132016-07-26 17:06:10 +1200390
Tobin Ehlis3066db62016-08-22 08:12:23 -0600391// 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 -0600392// This includes validating that all descriptors in the given bindings are updated,
393// that any update buffers are valid, and that any dynamic offsets are within the bounds of their buffers.
394// Return true if state is acceptable, or false and write an error message into error string
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600395bool cvdescriptorset::DescriptorSet::ValidateDrawState(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600396 const std::vector<uint32_t> &dynamic_offsets, std::string *error) const {
Chris Forbesc7090a82016-07-25 18:10:41 +1200397 for (auto binding_pair : bindings) {
398 auto binding = binding_pair.first;
Tobin Ehlis58c59582016-06-21 12:34:33 -0600399 if (!p_layout_->HasBinding(binding)) {
400 std::stringstream error_str;
401 error_str << "Attempting to validate DrawState for binding #" << binding
402 << " which is an invalid binding for this descriptor set.";
403 *error = error_str.str();
404 return false;
405 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600406 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
Tobin Ehlis81f17852016-05-05 09:04:33 -0600407 if (descriptors_[start_idx]->IsImmutableSampler()) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600408 // Nothing to do for strictly immutable sampler
409 } else {
410 auto end_idx = p_layout_->GetGlobalEndIndexFromBinding(binding);
Tobin Ehlisa3525e02016-11-17 10:50:52 -0700411 auto array_idx = 0; // Track array idx if we're dealing with array descriptors
412 for (uint32_t i = start_idx; i <= end_idx; ++i, ++array_idx) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600413 if (!descriptors_[i]->updated) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600414 std::stringstream error_str;
415 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
416 << " is being used in draw but has not been updated.";
417 *error = error_str.str();
418 return false;
419 } else {
Chris Forbes57989132016-07-26 17:06:10 +1200420 auto descriptor_class = descriptors_[i]->GetClass();
421 if (descriptor_class == GeneralBuffer) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600422 // Verify that buffers are valid
Tobin Ehlis81f17852016-05-05 09:04:33 -0600423 auto buffer = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetBuffer();
Tobin Ehlis4668dce2016-11-16 09:30:23 -0700424 auto buffer_node = getBufferState(device_data_, buffer);
Tobin Ehlis94bc5d22016-06-02 07:46:52 -0600425 if (!buffer_node) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600426 std::stringstream error_str;
427 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
428 << " references invalid buffer " << buffer << ".";
429 *error = error_str.str();
430 return false;
431 } else {
Tobin Ehlis640a81c2016-11-15 15:37:18 -0700432 for (auto mem_binding : buffer_node->GetBoundMemory()) {
433 if (!getMemObjInfo(device_data_, mem_binding)) {
434 std::stringstream error_str;
435 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
436 << " uses buffer " << buffer << " that references invalid memory " << mem_binding
437 << ".";
438 *error = error_str.str();
439 return false;
440 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600441 }
442 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600443 if (descriptors_[i]->IsDynamic()) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600444 // Validate that dynamic offsets are within the buffer
Tobin Ehlis94bc5d22016-06-02 07:46:52 -0600445 auto buffer_size = buffer_node->createInfo.size;
Tobin Ehlis81f17852016-05-05 09:04:33 -0600446 auto range = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetRange();
447 auto desc_offset = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetOffset();
Tobin Ehlisa3525e02016-11-17 10:50:52 -0700448 auto dyn_offset = dynamic_offsets[GetDynamicOffsetIndexFromBinding(binding) + array_idx];
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600449 if (VK_WHOLE_SIZE == range) {
450 if ((dyn_offset + desc_offset) > buffer_size) {
451 std::stringstream error_str;
452 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
453 << " uses buffer " << buffer
454 << " with update range of VK_WHOLE_SIZE has dynamic offset " << dyn_offset
455 << " combined with offset " << desc_offset << " that oversteps the buffer size of "
456 << buffer_size << ".";
457 *error = error_str.str();
458 return false;
459 }
460 } else {
461 if ((dyn_offset + desc_offset + range) > buffer_size) {
462 std::stringstream error_str;
463 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
464 << " uses buffer " << buffer << " with dynamic offset " << dyn_offset
465 << " combined with offset " << desc_offset << " and range " << range
466 << " that oversteps the buffer size of " << buffer_size << ".";
467 *error = error_str.str();
468 return false;
469 }
470 }
471 }
472 }
Chris Forbes57989132016-07-26 17:06:10 +1200473 else if (descriptor_class == ImageSampler || descriptor_class == Image) {
474 auto image_view = (descriptor_class == ImageSampler)
475 ? static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetImageView()
476 : static_cast<ImageDescriptor *>(descriptors_[i].get())->GetImageView();
477 auto reqs = binding_pair.second;
478
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600479 auto image_view_state = getImageViewState(device_data_, image_view);
480 assert(image_view_state);
481 auto image_view_ci = image_view_state->create_info;
Chris Forbes57989132016-07-26 17:06:10 +1200482
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600483 if ((reqs & DESCRIPTOR_REQ_ALL_VIEW_TYPE_BITS) && (~reqs & (1 << image_view_ci.viewType))) {
Chris Forbes57989132016-07-26 17:06:10 +1200484 // bad view type
485 std::stringstream error_str;
486 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
487 << " requires an image view of type " << string_descriptor_req_view_type(reqs)
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600488 << " but got " << string_VkImageViewType(image_view_ci.viewType) << ".";
Chris Forbes57989132016-07-26 17:06:10 +1200489 *error = error_str.str();
490 return false;
491 }
492
Tobin Ehlis30df15c2016-10-12 17:17:57 -0600493 auto image_node = getImageState(device_data_, image_view_ci.image);
Chris Forbes57989132016-07-26 17:06:10 +1200494 assert(image_node);
495
496 if ((reqs & DESCRIPTOR_REQ_SINGLE_SAMPLE) &&
497 image_node->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
498 std::stringstream error_str;
499 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
500 << " requires bound image to have VK_SAMPLE_COUNT_1_BIT but got "
501 << string_VkSampleCountFlagBits(image_node->createInfo.samples) << ".";
502 *error = error_str.str();
503 return false;
504 }
505
506 if ((reqs & DESCRIPTOR_REQ_MULTI_SAMPLE) &&
507 image_node->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
508 std::stringstream error_str;
509 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
510 << " requires bound image to have multiple samples, but got VK_SAMPLE_COUNT_1_BIT.";
511 *error = error_str.str();
512 return false;
513 }
514 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600515 }
516 }
517 }
518 }
519 return true;
520}
Chris Forbes57989132016-07-26 17:06:10 +1200521
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600522// For given bindings, place any update buffers or images into the passed-in unordered_sets
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600523uint32_t cvdescriptorset::DescriptorSet::GetStorageUpdates(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600524 std::unordered_set<VkBuffer> *buffer_set,
525 std::unordered_set<VkImageView> *image_set) const {
526 auto num_updates = 0;
Chris Forbesc7090a82016-07-25 18:10:41 +1200527 for (auto binding_pair : bindings) {
528 auto binding = binding_pair.first;
Tobin Ehlis58c59582016-06-21 12:34:33 -0600529 // If a binding doesn't exist, skip it
530 if (!p_layout_->HasBinding(binding)) {
531 continue;
532 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600533 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
Tobin Ehlis81f17852016-05-05 09:04:33 -0600534 if (descriptors_[start_idx]->IsStorage()) {
535 if (Image == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600536 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600537 if (descriptors_[start_idx + i]->updated) {
538 image_set->insert(static_cast<ImageDescriptor *>(descriptors_[start_idx + i].get())->GetImageView());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600539 num_updates++;
540 }
541 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600542 } else if (TexelBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600543 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600544 if (descriptors_[start_idx + i]->updated) {
545 auto bufferview = static_cast<TexelDescriptor *>(descriptors_[start_idx + i].get())->GetBufferView();
Tobin Ehlis8b872462016-09-14 08:12:08 -0600546 auto bv_state = getBufferViewState(device_data_, bufferview);
547 if (bv_state) {
548 buffer_set->insert(bv_state->create_info.buffer);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600549 num_updates++;
550 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600551 }
552 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600553 } else if (GeneralBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600554 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600555 if (descriptors_[start_idx + i]->updated) {
556 buffer_set->insert(static_cast<BufferDescriptor *>(descriptors_[start_idx + i].get())->GetBuffer());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600557 num_updates++;
558 }
559 }
560 }
561 }
562 }
563 return num_updates;
564}
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600565// Set is being deleted or updates so invalidate all bound cmd buffers
566void cvdescriptorset::DescriptorSet::InvalidateBoundCmdBuffers() {
Tobin Ehlisfe5731a2016-11-21 08:31:01 -0700567 core_validation::invalidateCommandBuffers(device_data_, cb_bindings,
Tobin Ehlis2556f5b2016-06-24 17:22:16 -0600568 {reinterpret_cast<uint64_t &>(set_), VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT});
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600569}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600570// Perform write update in given update struct
Tobin Ehlis300888c2016-05-18 13:43:26 -0600571void cvdescriptorset::DescriptorSet::PerformWriteUpdate(const VkWriteDescriptorSet *update) {
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700572 // Perform update on a per-binding basis as consecutive updates roll over to next binding
573 auto descriptors_remaining = update->descriptorCount;
574 auto binding_being_updated = update->dstBinding;
575 auto offset = update->dstArrayElement;
576 while (descriptors_remaining) {
577 uint32_t update_count = std::min(descriptors_remaining, GetDescriptorCountFromBinding(binding_being_updated));
578 auto global_idx = p_layout_->GetGlobalStartIndexFromBinding(binding_being_updated) + offset;
579 // Loop over the updates for a single binding at a time
580 for (uint32_t di = 0; di < update_count; ++di) {
581 descriptors_[global_idx + di]->WriteUpdate(update, di);
582 }
583 // Roll over to next binding in case of consecutive update
584 descriptors_remaining -= update_count;
585 offset = 0;
586 binding_being_updated++;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600587 }
Tobin Ehlis56a30942016-05-19 08:00:00 -0600588 if (update->descriptorCount)
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600589 some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600590
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600591 InvalidateBoundCmdBuffers();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600592}
Tobin Ehlis300888c2016-05-18 13:43:26 -0600593// Validate Copy update
594bool cvdescriptorset::DescriptorSet::ValidateCopyUpdate(const debug_report_data *report_data, const VkCopyDescriptorSet *update,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600595 const DescriptorSet *src_set, UNIQUE_VALIDATION_ERROR_CODE *error_code,
596 std::string *error_msg) {
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600597 // Verify idle ds
598 if (in_use.load()) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600599 // TODO : Re-using Allocate Idle error code, need copy update idle error code
600 *error_code = VALIDATION_ERROR_00919;
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600601 std::stringstream error_str;
602 error_str << "Cannot call vkUpdateDescriptorSets() to perform copy update on descriptor set " << set_
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700603 << " that is in use by a command buffer";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600604 *error_msg = error_str.str();
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600605 return false;
606 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600607 if (!p_layout_->HasBinding(update->dstBinding)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600608 *error_code = VALIDATION_ERROR_00966;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600609 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700610 error_str << "DescriptorSet " << set_ << " does not have copy update dest binding of " << update->dstBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600611 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600612 return false;
613 }
614 if (!src_set->HasBinding(update->srcBinding)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600615 *error_code = VALIDATION_ERROR_00964;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600616 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700617 error_str << "DescriptorSet " << set_ << " does not have copy update src binding of " << update->srcBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600618 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600619 return false;
620 }
621 // src & dst set bindings are valid
622 // Check bounds of src & dst
623 auto src_start_idx = src_set->GetGlobalStartIndexFromBinding(update->srcBinding) + update->srcArrayElement;
624 if ((src_start_idx + update->descriptorCount) > src_set->GetTotalDescriptorCount()) {
625 // SRC update out of bounds
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600626 *error_code = VALIDATION_ERROR_00965;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600627 std::stringstream error_str;
628 error_str << "Attempting copy update from descriptorSet " << update->srcSet << " binding#" << update->srcBinding
629 << " with offset index of " << src_set->GetGlobalStartIndexFromBinding(update->srcBinding)
630 << " plus update array offset of " << update->srcArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700631 << " descriptors oversteps total number of descriptors in set: " << src_set->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600632 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600633 return false;
634 }
635 auto dst_start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
636 if ((dst_start_idx + update->descriptorCount) > p_layout_->GetTotalDescriptorCount()) {
637 // DST update out of bounds
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600638 *error_code = VALIDATION_ERROR_00967;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600639 std::stringstream error_str;
640 error_str << "Attempting copy update to descriptorSet " << set_ << " binding#" << update->dstBinding
641 << " with offset index of " << p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding)
642 << " plus update array offset of " << update->dstArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700643 << " descriptors oversteps total number of descriptors in set: " << p_layout_->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600644 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600645 return false;
646 }
647 // Check that types match
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600648 // TODO : Base default error case going from here is VALIDATION_ERROR_00968 which covers all consistency issues, need more
649 // fine-grained error codes
650 *error_code = VALIDATION_ERROR_00968;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600651 auto src_type = src_set->GetTypeFromBinding(update->srcBinding);
652 auto dst_type = p_layout_->GetTypeFromBinding(update->dstBinding);
653 if (src_type != dst_type) {
654 std::stringstream error_str;
655 error_str << "Attempting copy update to descriptorSet " << set_ << " binding #" << update->dstBinding << " with type "
656 << string_VkDescriptorType(dst_type) << " from descriptorSet " << src_set->GetSet() << " binding #"
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700657 << update->srcBinding << " with type " << string_VkDescriptorType(src_type) << ". Types do not match";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600658 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600659 return false;
660 }
661 // Verify consistency of src & dst bindings if update crosses binding boundaries
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600662 if ((!src_set->GetLayout()->VerifyUpdateConsistency(update->srcBinding, update->srcArrayElement, update->descriptorCount,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600663 "copy update from", src_set->GetSet(), error_msg)) ||
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600664 (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "copy update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600665 set_, error_msg))) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600666 return false;
667 }
Tobin Ehlisd41e7b62016-05-19 07:56:18 -0600668 // First make sure source descriptors are updated
669 for (uint32_t i = 0; i < update->descriptorCount; ++i) {
670 if (!src_set->descriptors_[src_start_idx + i]) {
671 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700672 error_str << "Attempting copy update from descriptorSet " << src_set << " binding #" << update->srcBinding
673 << " but descriptor at array offset " << update->srcArrayElement + i << " has not been updated";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600674 *error_msg = error_str.str();
Tobin Ehlisd41e7b62016-05-19 07:56:18 -0600675 return false;
676 }
677 }
678 // Update parameters all look good and descriptor updated so verify update contents
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600679 if (!VerifyCopyUpdateContents(update, src_set, src_type, src_start_idx, error_code, error_msg))
Tobin Ehlis300888c2016-05-18 13:43:26 -0600680 return false;
681
682 // All checks passed so update is good
683 return true;
684}
685// Perform Copy update
686void cvdescriptorset::DescriptorSet::PerformCopyUpdate(const VkCopyDescriptorSet *update, const DescriptorSet *src_set) {
Tobin Ehlis300888c2016-05-18 13:43:26 -0600687 auto src_start_idx = src_set->GetGlobalStartIndexFromBinding(update->srcBinding) + update->srcArrayElement;
688 auto dst_start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600689 // Update parameters all look good so perform update
690 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Tobin Ehlis300888c2016-05-18 13:43:26 -0600691 descriptors_[dst_start_idx + di]->CopyUpdate(src_set->descriptors_[src_start_idx + di].get());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600692 }
Tobin Ehlis56a30942016-05-19 08:00:00 -0600693 if (update->descriptorCount)
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600694 some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600695
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600696 InvalidateBoundCmdBuffers();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600697}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600698
Tobin Ehlisf9519102016-08-17 09:49:13 -0600699// Bind cb_node to this set and this set to cb_node.
700// Prereq: This should be called for a set that has been confirmed to be active for the given cb_node, meaning it's going
701// to be used in a draw by the given cb_node
Tobin Ehlisf9519102016-08-17 09:49:13 -0600702void cvdescriptorset::DescriptorSet::BindCommandBuffer(GLOBAL_CB_NODE *cb_node, const std::unordered_set<uint32_t> &bindings) {
Tobin Ehlis9252c2b2016-07-21 14:40:22 -0600703 // bind cb to this descriptor set
704 cb_bindings.insert(cb_node);
Tobin Ehlis7ca20be2016-10-12 15:09:16 -0600705 // Add bindings for descriptor set, the set's pool, and individual objects in the set
Tobin Ehlis9252c2b2016-07-21 14:40:22 -0600706 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 -0600707 pool_state_->cb_bindings.insert(cb_node);
708 cb_node->object_bindings.insert(
709 {reinterpret_cast<uint64_t &>(pool_state_->pool), VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT});
Tobin Ehlisf9519102016-08-17 09:49:13 -0600710 // For the active slots, use set# to look up descriptorSet from boundDescriptorSets, and bind all of that descriptor set's
711 // resources
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600712 for (auto binding : bindings) {
713 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
714 auto end_idx = p_layout_->GetGlobalEndIndexFromBinding(binding);
715 for (uint32_t i = start_idx; i <= end_idx; ++i) {
716 descriptors_[i]->BindCommandBuffer(device_data_, cb_node);
717 }
718 }
Tobin Ehlis9252c2b2016-07-21 14:40:22 -0600719}
720
Tobin Ehlis300888c2016-05-18 13:43:26 -0600721cvdescriptorset::SamplerDescriptor::SamplerDescriptor() : sampler_(VK_NULL_HANDLE), immutable_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600722 updated = false;
723 descriptor_class = PlainSampler;
724};
725
Tobin Ehlis300888c2016-05-18 13:43:26 -0600726cvdescriptorset::SamplerDescriptor::SamplerDescriptor(const VkSampler *immut) : sampler_(VK_NULL_HANDLE), immutable_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600727 updated = false;
728 descriptor_class = PlainSampler;
729 if (immut) {
730 sampler_ = *immut;
731 immutable_ = true;
732 updated = true;
733 }
734}
Tobin Ehlise2f80292016-06-02 10:08:53 -0600735// Validate given sampler. Currently this only checks to make sure it exists in the samplerMap
736bool cvdescriptorset::ValidateSampler(const VkSampler sampler, const core_validation::layer_data *dev_data) {
Tobin Ehlisfad7adf2016-10-20 06:50:37 -0600737 return (getSamplerState(dev_data, sampler) != nullptr);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600738}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600739
Tobin Ehlis554bf382016-05-24 11:14:43 -0600740bool cvdescriptorset::ValidateImageUpdate(VkImageView image_view, VkImageLayout image_layout, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600741 const core_validation::layer_data *dev_data, UNIQUE_VALIDATION_ERROR_CODE *error_code,
742 std::string *error_msg) {
743 // TODO : Defaulting to 00943 for all cases here. Need to create new error codes for various cases.
744 *error_code = VALIDATION_ERROR_00943;
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600745 auto iv_state = getImageViewState(dev_data, image_view);
746 if (!iv_state) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600747 std::stringstream error_str;
748 error_str << "Invalid VkImageView: " << image_view;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600749 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600750 return false;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600751 }
Tobin Ehlis81280962016-07-20 14:04:20 -0600752 // 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 -0600753 // Validate that imageLayout is compatible with aspect_mask and image format
754 // and validate that image usage bits are correct for given usage
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600755 VkImageAspectFlags aspect_mask = iv_state->create_info.subresourceRange.aspectMask;
756 VkImage image = iv_state->create_info.image;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600757 VkFormat format = VK_FORMAT_MAX_ENUM;
758 VkImageUsageFlags usage = 0;
Tobin Ehlis30df15c2016-10-12 17:17:57 -0600759 auto image_node = getImageState(dev_data, image);
Tobin Ehlis1c9c55f2016-06-02 11:49:22 -0600760 if (image_node) {
761 format = image_node->createInfo.format;
762 usage = image_node->createInfo.usage;
Tobin Ehlis029d2fe2016-09-21 09:19:15 -0600763 // Validate that memory is bound to image
Tobin Ehlisfed999f2016-09-21 15:09:45 -0600764 if (ValidateMemoryIsBoundToImage(dev_data, image_node, "vkUpdateDescriptorSets()")) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600765 // TODO : Need new code(s) for language in 11.6 Memory Association
766 *error_msg = "No memory bound to image.";
Tobin Ehlis029d2fe2016-09-21 09:19:15 -0600767 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -0600768 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600769 } else {
Tobin Ehlis1809f912016-05-25 09:24:36 -0600770 // Also need to check the swapchains.
Tobin Ehlis969a5262016-06-02 12:13:32 -0600771 auto swapchain = getSwapchainFromImage(dev_data, image);
772 if (swapchain) {
Tobin Ehlis4e380592016-06-02 12:41:47 -0600773 auto swapchain_node = getSwapchainNode(dev_data, swapchain);
774 if (swapchain_node) {
775 format = swapchain_node->createInfo.imageFormat;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600776 }
777 }
Tobin Ehlis1809f912016-05-25 09:24:36 -0600778 }
779 // First validate that format and layout are compatible
780 if (format == VK_FORMAT_MAX_ENUM) {
781 std::stringstream error_str;
782 error_str << "Invalid image (" << image << ") in imageView (" << image_view << ").";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600783 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600784 return false;
785 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600786 // TODO : The various image aspect and format checks here are based on general spec language in 11.5 Image Views section under
787 // vkCreateImageView(). What's the best way to create unique id for these cases?
Tobin Ehlis1809f912016-05-25 09:24:36 -0600788 bool ds = vk_format_is_depth_or_stencil(format);
789 switch (image_layout) {
790 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
791 // Only Color bit must be set
792 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600793 std::stringstream error_str;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600794 error_str << "ImageView (" << image_view << ") uses layout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL but does "
795 "not have VK_IMAGE_ASPECT_COLOR_BIT set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600796 *error_msg = error_str.str();
Tobin Ehlis554bf382016-05-24 11:14:43 -0600797 return false;
798 }
Tobin Ehlis1809f912016-05-25 09:24:36 -0600799 // format must NOT be DS
800 if (ds) {
801 std::stringstream error_str;
802 error_str << "ImageView (" << image_view
803 << ") uses layout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL but the image format is "
804 << string_VkFormat(format) << " which is not a color format.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600805 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600806 return false;
807 }
808 break;
809 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
810 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
811 // Depth or stencil bit must be set, but both must NOT be set
812 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
813 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
814 // both must NOT be set
815 std::stringstream error_str;
816 error_str << "ImageView (" << image_view << ") has both STENCIL and DEPTH aspects set";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600817 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600818 return false;
819 }
820 } else if (!(aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
821 // Neither were set
822 std::stringstream error_str;
823 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
824 << " but does not have STENCIL or DEPTH aspects set";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600825 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600826 return false;
827 }
828 // format must be DS
829 if (!ds) {
830 std::stringstream error_str;
831 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
832 << " but the image format is " << string_VkFormat(format) << " which is not a depth/stencil format.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600833 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600834 return false;
835 }
836 break;
837 default:
Mike Weiblencce7ec72016-10-17 19:33:05 -0600838 // For other layouts if the source is depth/stencil image, both aspect bits must not be set
Tobin Ehlisbbf3f912016-06-15 13:03:58 -0600839 if (ds) {
840 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
841 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
842 // both must NOT be set
843 std::stringstream error_str;
844 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
845 << " and is using depth/stencil image of format " << string_VkFormat(format)
846 << " but it has both STENCIL and DEPTH aspects set, which is illegal. When using a depth/stencil "
847 "image in a descriptor set, please only set either VK_IMAGE_ASPECT_DEPTH_BIT or "
848 "VK_IMAGE_ASPECT_STENCIL_BIT depending on whether it will be used for depth reads or stencil "
849 "reads respectively.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600850 *error_msg = error_str.str();
Tobin Ehlisbbf3f912016-06-15 13:03:58 -0600851 return false;
852 }
853 }
854 }
Tobin Ehlis1809f912016-05-25 09:24:36 -0600855 break;
856 }
857 // Now validate that usage flags are correctly set for given type of update
Tobin Ehlisfb4cf712016-10-10 14:02:48 -0600858 // 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 -0600859 // TODO : The various image usage bit requirements are in general spec language for VkImageUsageFlags bit block in 11.3 Images
860 // under vkCreateImage()
861 // TODO : Need to also validate case VALIDATION_ERROR_00952 where STORAGE_IMAGE & INPUT_ATTACH types must have been created with
862 // identify swizzle
Tobin Ehlis1809f912016-05-25 09:24:36 -0600863 std::string error_usage_bit;
864 switch (type) {
865 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
866 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
867 if (!(usage & VK_IMAGE_USAGE_SAMPLED_BIT)) {
868 error_usage_bit = "VK_IMAGE_USAGE_SAMPLED_BIT";
869 }
870 break;
871 }
872 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
873 if (!(usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
874 error_usage_bit = "VK_IMAGE_USAGE_STORAGE_BIT";
Tobin Ehlisfb4cf712016-10-10 14:02:48 -0600875 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
876 std::stringstream error_str;
877 // TODO : Need to create custom enum error code for this case
878 error_str << "ImageView (" << image_view << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type is being updated with layout "
879 << string_VkImageLayout(image_layout)
880 << " but according to spec section 13.1 Descriptor Types, 'Load and store operations on storage images can "
881 "only be done on images in VK_IMAGE_LAYOUT_GENERAL layout.'";
882 *error_msg = error_str.str();
883 return false;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600884 }
885 break;
886 }
887 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT: {
888 if (!(usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) {
889 error_usage_bit = "VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT";
890 }
891 break;
892 }
893 default:
894 break;
895 }
896 if (!error_usage_bit.empty()) {
897 std::stringstream error_str;
898 error_str << "ImageView (" << image_view << ") with usage mask 0x" << usage
899 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
900 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600901 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600902 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600903 }
904 return true;
905}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600906
Tobin Ehlis300888c2016-05-18 13:43:26 -0600907void cvdescriptorset::SamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
908 sampler_ = update->pImageInfo[index].sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600909 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600910}
911
Tobin Ehlis300888c2016-05-18 13:43:26 -0600912void cvdescriptorset::SamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600913 if (!immutable_) {
914 auto update_sampler = static_cast<const SamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600915 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600916 }
917 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600918}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600919
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600920void cvdescriptorset::SamplerDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
921 if (!immutable_) {
Tobin Ehlisfad7adf2016-10-20 06:50:37 -0600922 auto sampler_state = getSamplerState(dev_data, sampler_);
923 if (sampler_state)
924 core_validation::AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600925 }
926}
927
Tobin Ehlis300888c2016-05-18 13:43:26 -0600928cvdescriptorset::ImageSamplerDescriptor::ImageSamplerDescriptor()
929 : sampler_(VK_NULL_HANDLE), immutable_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600930 updated = false;
931 descriptor_class = ImageSampler;
932}
933
Tobin Ehlis300888c2016-05-18 13:43:26 -0600934cvdescriptorset::ImageSamplerDescriptor::ImageSamplerDescriptor(const VkSampler *immut)
935 : sampler_(VK_NULL_HANDLE), immutable_(true), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600936 updated = false;
937 descriptor_class = ImageSampler;
938 if (immut) {
939 sampler_ = *immut;
940 immutable_ = true;
941 updated = true;
942 }
943}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600944
Tobin Ehlis300888c2016-05-18 13:43:26 -0600945void cvdescriptorset::ImageSamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600946 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600947 const auto &image_info = update->pImageInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -0600948 sampler_ = image_info.sampler;
949 image_view_ = image_info.imageView;
950 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600951}
952
Tobin Ehlis300888c2016-05-18 13:43:26 -0600953void cvdescriptorset::ImageSamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600954 if (!immutable_) {
955 auto update_sampler = static_cast<const ImageSamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600956 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600957 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600958 auto image_view = static_cast<const ImageSamplerDescriptor *>(src)->image_view_;
959 auto image_layout = static_cast<const ImageSamplerDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600960 updated = true;
961 image_view_ = image_view;
962 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600963}
964
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600965void cvdescriptorset::ImageSamplerDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data,
966 GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -0600967 // First add binding for any non-immutable sampler
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600968 if (!immutable_) {
Tobin Ehlisfad7adf2016-10-20 06:50:37 -0600969 auto sampler_state = getSamplerState(dev_data, sampler_);
970 if (sampler_state)
971 core_validation::AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600972 }
Tobin Ehlis81e46372016-08-17 13:33:44 -0600973 // Add binding for image
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600974 auto iv_state = getImageViewState(dev_data, image_view_);
975 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -0600976 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -0600977 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600978}
979
Tobin Ehlis300888c2016-05-18 13:43:26 -0600980cvdescriptorset::ImageDescriptor::ImageDescriptor(const VkDescriptorType type)
981 : storage_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600982 updated = false;
983 descriptor_class = Image;
984 if (VK_DESCRIPTOR_TYPE_STORAGE_IMAGE == type)
985 storage_ = true;
986};
987
Tobin Ehlis300888c2016-05-18 13:43:26 -0600988void cvdescriptorset::ImageDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600989 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600990 const auto &image_info = update->pImageInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -0600991 image_view_ = image_info.imageView;
992 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600993}
994
Tobin Ehlis300888c2016-05-18 13:43:26 -0600995void cvdescriptorset::ImageDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600996 auto image_view = static_cast<const ImageDescriptor *>(src)->image_view_;
997 auto image_layout = static_cast<const ImageDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600998 updated = true;
999 image_view_ = image_view;
1000 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001001}
1002
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001003void cvdescriptorset::ImageDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -06001004 // Add binding for image
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001005 auto iv_state = getImageViewState(dev_data, image_view_);
1006 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -06001007 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001008 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001009}
1010
Tobin Ehlis300888c2016-05-18 13:43:26 -06001011cvdescriptorset::BufferDescriptor::BufferDescriptor(const VkDescriptorType type)
1012 : storage_(false), dynamic_(false), buffer_(VK_NULL_HANDLE), offset_(0), range_(0) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001013 updated = false;
1014 descriptor_class = GeneralBuffer;
1015 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
1016 dynamic_ = true;
1017 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type) {
1018 storage_ = true;
1019 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
1020 dynamic_ = true;
1021 storage_ = true;
1022 }
1023}
Tobin Ehlis300888c2016-05-18 13:43:26 -06001024void cvdescriptorset::BufferDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001025 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001026 const auto &buffer_info = update->pBufferInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001027 buffer_ = buffer_info.buffer;
1028 offset_ = buffer_info.offset;
1029 range_ = buffer_info.range;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001030}
1031
Tobin Ehlis300888c2016-05-18 13:43:26 -06001032void cvdescriptorset::BufferDescriptor::CopyUpdate(const Descriptor *src) {
1033 auto buff_desc = static_cast<const BufferDescriptor *>(src);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001034 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001035 buffer_ = buff_desc->buffer_;
1036 offset_ = buff_desc->offset_;
1037 range_ = buff_desc->range_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001038}
1039
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001040void cvdescriptorset::BufferDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis4668dce2016-11-16 09:30:23 -07001041 auto buffer_node = getBufferState(dev_data, buffer_);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001042 if (buffer_node)
1043 core_validation::AddCommandBufferBindingBuffer(dev_data, cb_node, buffer_node);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001044}
1045
Tobin Ehlis300888c2016-05-18 13:43:26 -06001046cvdescriptorset::TexelDescriptor::TexelDescriptor(const VkDescriptorType type) : buffer_view_(VK_NULL_HANDLE), storage_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001047 updated = false;
1048 descriptor_class = TexelBuffer;
1049 if (VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER == type)
1050 storage_ = true;
1051};
Tobin Ehlis56a30942016-05-19 08:00:00 -06001052
Tobin Ehlis300888c2016-05-18 13:43:26 -06001053void cvdescriptorset::TexelDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001054 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001055 buffer_view_ = update->pTexelBufferView[index];
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001056}
1057
Tobin Ehlis300888c2016-05-18 13:43:26 -06001058void cvdescriptorset::TexelDescriptor::CopyUpdate(const Descriptor *src) {
1059 updated = true;
1060 buffer_view_ = static_cast<const TexelDescriptor *>(src)->buffer_view_;
1061}
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001062
1063void cvdescriptorset::TexelDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis8b872462016-09-14 08:12:08 -06001064 auto bv_state = getBufferViewState(dev_data, buffer_view_);
1065 if (bv_state) {
Tobin Ehlis2515c0e2016-09-28 07:12:28 -06001066 core_validation::AddCommandBufferBindingBufferView(dev_data, cb_node, bv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001067 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001068}
1069
Tobin Ehlis300888c2016-05-18 13:43:26 -06001070// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1071// sets, and then calls their respective Validate[Write|Copy]Update functions.
1072// If the update hits an issue for which the callback returns "true", meaning that the call down the chain should
1073// be skipped, then true is returned.
1074// If there is no issue with the update, then false is returned.
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001075bool cvdescriptorset::ValidateUpdateDescriptorSets(const debug_report_data *report_data,
1076 const core_validation::layer_data *dev_data, uint32_t write_count,
1077 const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
1078 const VkCopyDescriptorSet *p_cds) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001079 bool skip_call = false;
1080 // Validate Write updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001081 for (uint32_t i = 0; i < write_count; i++) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001082 auto dest_set = p_wds[i].dstSet;
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001083 auto set_node = core_validation::getSetNode(dev_data, dest_set);
1084 if (!set_node) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001085 skip_call |=
1086 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 -06001087 reinterpret_cast<uint64_t &>(dest_set), __LINE__, DRAWSTATE_INVALID_DESCRIPTOR_SET, "DS",
Tobin Ehlis300888c2016-05-18 13:43:26 -06001088 "Cannot call vkUpdateDescriptorSets() on descriptor set 0x%" PRIxLEAST64 " that has not been allocated.",
1089 reinterpret_cast<uint64_t &>(dest_set));
1090 } else {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001091 UNIQUE_VALIDATION_ERROR_CODE error_code;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001092 std::string error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001093 if (!set_node->ValidateWriteUpdate(report_data, &p_wds[i], &error_code, &error_str)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001094 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 -06001095 reinterpret_cast<uint64_t &>(dest_set), __LINE__, error_code, "DS",
Tobin Ehlis300888c2016-05-18 13:43:26 -06001096 "vkUpdateDescriptorsSets() failed write update validation for Descriptor Set 0x%" PRIx64
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001097 " with error: %s. %s",
1098 reinterpret_cast<uint64_t &>(dest_set), error_str.c_str(), validation_error_map[error_code]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001099 }
1100 }
1101 }
1102 // Now validate copy updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001103 for (uint32_t i = 0; i < copy_count; ++i) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001104 auto dst_set = p_cds[i].dstSet;
1105 auto src_set = p_cds[i].srcSet;
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001106 auto src_node = core_validation::getSetNode(dev_data, src_set);
1107 auto dst_node = core_validation::getSetNode(dev_data, dst_set);
1108 if (!src_node) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001109 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 -06001110 reinterpret_cast<uint64_t &>(src_set), __LINE__, VALIDATION_ERROR_00971, "DS",
Tobin Ehlis300888c2016-05-18 13:43:26 -06001111 "Cannot call vkUpdateDescriptorSets() to copy from descriptor set 0x%" PRIxLEAST64
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001112 " that has not been allocated. %s",
1113 reinterpret_cast<uint64_t &>(src_set), validation_error_map[VALIDATION_ERROR_00971]);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001114 } else if (!dst_node) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001115 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 -06001116 reinterpret_cast<uint64_t &>(dst_set), __LINE__, VALIDATION_ERROR_00972, "DS",
Tobin Ehlis300888c2016-05-18 13:43:26 -06001117 "Cannot call vkUpdateDescriptorSets() to copy to descriptor set 0x%" PRIxLEAST64
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001118 " that has not been allocated. %s",
1119 reinterpret_cast<uint64_t &>(dst_set), validation_error_map[VALIDATION_ERROR_00972]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001120 } else {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001121 UNIQUE_VALIDATION_ERROR_CODE error_code;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001122 std::string error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001123 if (!dst_node->ValidateCopyUpdate(report_data, &p_cds[i], src_node, &error_code, &error_str)) {
1124 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
1125 reinterpret_cast<uint64_t &>(dst_set), __LINE__, error_code, "DS",
1126 "vkUpdateDescriptorsSets() failed copy update from Descriptor Set 0x%" PRIx64
1127 " to Descriptor Set 0x%" PRIx64 " with error: %s. %s",
1128 reinterpret_cast<uint64_t &>(src_set), reinterpret_cast<uint64_t &>(dst_set),
1129 error_str.c_str(), validation_error_map[error_code]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001130 }
1131 }
1132 }
1133 return skip_call;
1134}
1135// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1136// sets, and then calls their respective Perform[Write|Copy]Update functions.
1137// Prerequisite : ValidateUpdateDescriptorSets() should be called and return "false" prior to calling PerformUpdateDescriptorSets()
1138// with the same set of updates.
1139// This is split from the validate code to allow validation prior to calling down the chain, and then update after
1140// calling down the chain.
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001141void cvdescriptorset::PerformUpdateDescriptorSets(const core_validation::layer_data *dev_data, uint32_t write_count,
1142 const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
1143 const VkCopyDescriptorSet *p_cds) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001144 // Write updates first
1145 uint32_t i = 0;
1146 for (i = 0; i < write_count; ++i) {
1147 auto dest_set = p_wds[i].dstSet;
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001148 auto set_node = core_validation::getSetNode(dev_data, dest_set);
1149 if (set_node) {
1150 set_node->PerformWriteUpdate(&p_wds[i]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001151 }
1152 }
1153 // Now copy updates
1154 for (i = 0; i < copy_count; ++i) {
1155 auto dst_set = p_cds[i].dstSet;
1156 auto src_set = p_cds[i].srcSet;
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001157 auto src_node = core_validation::getSetNode(dev_data, src_set);
1158 auto dst_node = core_validation::getSetNode(dev_data, dst_set);
1159 if (src_node && dst_node) {
1160 dst_node->PerformCopyUpdate(&p_cds[i], src_node);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001161 }
1162 }
1163}
1164// Validate the state for a given write update but don't actually perform the update
1165// If an error would occur for this update, return false and fill in details in error_msg string
1166bool cvdescriptorset::DescriptorSet::ValidateWriteUpdate(const debug_report_data *report_data, const VkWriteDescriptorSet *update,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001167 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001168 // Verify idle ds
1169 if (in_use.load()) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001170 // TODO : Re-using Allocate Idle error code, need write update idle error code
1171 *error_code = VALIDATION_ERROR_00919;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001172 std::stringstream error_str;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001173 error_str << "Cannot call vkUpdateDescriptorSets() to perform write update on descriptor set " << set_
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001174 << " that is in use by a command buffer";
Tobin Ehlis300888c2016-05-18 13:43:26 -06001175 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001176 return false;
1177 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001178 // Verify dst binding exists
1179 if (!p_layout_->HasBinding(update->dstBinding)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001180 *error_code = VALIDATION_ERROR_00936;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001181 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001182 error_str << "DescriptorSet " << set_ << " does not have binding " << update->dstBinding;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001183 *error_msg = error_str.str();
1184 return false;
Tobin Ehlis59a5efc2016-11-21 09:41:57 -07001185 } else {
1186 // Make sure binding isn't empty
1187 if (0 == p_layout_->GetDescriptorCountFromBinding(update->dstBinding)) {
1188 *error_code = VALIDATION_ERROR_02348;
1189 std::stringstream error_str;
1190 error_str << "DescriptorSet " << set_ << " cannot updated binding " << update->dstBinding << " that has 0 descriptors";
1191 *error_msg = error_str.str();
1192 return false;
1193 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001194 }
1195 // We know that binding is valid, verify update and do update on each descriptor
1196 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
1197 auto type = p_layout_->GetTypeFromBinding(update->dstBinding);
1198 if (type != update->descriptorType) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001199 *error_code = VALIDATION_ERROR_00937;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001200 std::stringstream error_str;
1201 error_str << "Attempting write update to descriptor set " << set_ << " binding #" << update->dstBinding << " with type "
1202 << string_VkDescriptorType(type) << " but update type is " << string_VkDescriptorType(update->descriptorType);
1203 *error_msg = error_str.str();
1204 return false;
1205 }
Tobin Ehlis7b402352016-12-15 07:51:20 -07001206 if (update->descriptorCount > (descriptors_.size() - start_idx)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001207 *error_code = VALIDATION_ERROR_00938;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001208 std::stringstream error_str;
1209 error_str << "Attempting write update to descriptor set " << set_ << " binding #" << update->dstBinding << " with "
Tobin Ehlis7b402352016-12-15 07:51:20 -07001210 << descriptors_.size() - start_idx
Tobin Ehlisf922ef82016-11-30 10:19:14 -07001211 << " descriptors in that binding and all successive bindings of the set, but update of "
1212 << update->descriptorCount << " descriptors combined with update array element offset of "
1213 << update->dstArrayElement << " oversteps the available number of consecutive descriptors";
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001214 *error_msg = error_str.str();
1215 return false;
1216 }
1217 // Verify consecutive bindings match (if needed)
1218 if (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "write update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001219 set_, error_msg)) {
1220 *error_code = VALIDATION_ERROR_00938;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001221 return false;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001222 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001223 // Update is within bounds and consistent so last step is to validate update contents
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001224 if (!VerifyWriteUpdateContents(update, start_idx, error_code, error_msg)) {
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001225 std::stringstream error_str;
1226 error_str << "Write update to descriptor in set " << set_ << " binding #" << update->dstBinding
1227 << " failed with error message: " << error_msg->c_str();
1228 *error_msg = error_str.str();
1229 return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001230 }
1231 // All checks passed, update is clean
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001232 return true;
Tobin Ehlis03d61de2016-05-17 08:31:46 -06001233}
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001234// For the given buffer, verify that its creation parameters are appropriate for the given type
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001235// 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 -07001236bool cvdescriptorset::DescriptorSet::ValidateBufferUsage(BUFFER_STATE const *buffer_node, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001237 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) const {
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001238 // Verify that usage bits set correctly for given type
Tobin Ehlis94bc5d22016-06-02 07:46:52 -06001239 auto usage = buffer_node->createInfo.usage;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001240 std::string error_usage_bit;
1241 switch (type) {
1242 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1243 if (!(usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001244 *error_code = VALIDATION_ERROR_00950;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001245 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT";
1246 }
1247 break;
1248 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1249 if (!(usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001250 *error_code = VALIDATION_ERROR_00951;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001251 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT";
1252 }
1253 break;
1254 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1255 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1256 if (!(usage & VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001257 *error_code = VALIDATION_ERROR_00946;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001258 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT";
1259 }
1260 break;
1261 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1262 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1263 if (!(usage & VK_BUFFER_USAGE_STORAGE_BUFFER_BIT)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001264 *error_code = VALIDATION_ERROR_00947;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001265 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_BUFFER_BIT";
1266 }
1267 break;
1268 default:
1269 break;
1270 }
1271 if (!error_usage_bit.empty()) {
1272 std::stringstream error_str;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001273 error_str << "Buffer (" << buffer_node->buffer << ") with usage mask 0x" << usage
1274 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
1275 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001276 *error_msg = error_str.str();
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001277 return false;
1278 }
1279 return true;
1280}
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001281// For buffer descriptor updates, verify the buffer usage and VkDescriptorBufferInfo struct which includes:
1282// 1. buffer is valid
1283// 2. buffer was created with correct usage flags
1284// 3. offset is less than buffer size
1285// 4. range is either VK_WHOLE_SIZE or falls in (0, (buffer size - offset)]
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001286// 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 -06001287bool cvdescriptorset::DescriptorSet::ValidateBufferUpdate(VkDescriptorBufferInfo const *buffer_info, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001288 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) const {
1289 // TODO : Defaulting to 00962 for all cases here. Need to create new error codes for a few cases below.
1290 *error_code = VALIDATION_ERROR_00962;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001291 // First make sure that buffer is valid
Tobin Ehlis4668dce2016-11-16 09:30:23 -07001292 auto buffer_node = getBufferState(device_data_, buffer_info->buffer);
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001293 if (!buffer_node) {
1294 std::stringstream error_str;
1295 error_str << "Invalid VkBuffer: " << buffer_info->buffer;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001296 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001297 return false;
1298 }
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001299 if (ValidateMemoryIsBoundToBuffer(device_data_, buffer_node, "vkUpdateDescriptorSets()")) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001300 // TODO : This is a repeat code, need new code(s) for language in 11.6 Memory Association
1301 *error_msg = "No memory bound to buffer.";
Tobin Ehlis81280962016-07-20 14:04:20 -06001302 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001303 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001304 // Verify usage bits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001305 if (!ValidateBufferUsage(buffer_node, type, error_code, error_msg)) {
1306 // error_msg will have been updated by ValidateBufferUsage()
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001307 return false;
1308 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001309 // TODO : Need to also validate device limit offset requirements captured in VALIDATION_ERROR_00944,945
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001310 // offset must be less than buffer size
1311 if (buffer_info->offset > buffer_node->createInfo.size) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001312 *error_code = VALIDATION_ERROR_00959;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001313 std::stringstream error_str;
1314 error_str << "VkDescriptorBufferInfo offset of " << buffer_info->offset << " is greater than buffer " << buffer_node->buffer
1315 << " size of " << buffer_node->createInfo.size;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001316 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001317 return false;
1318 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001319 // TODO : Need to also validate device limit range requirements captured in VALIDATION_ERROR_00948,949
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001320 if (buffer_info->range != VK_WHOLE_SIZE) {
1321 // Range must be VK_WHOLE_SIZE or > 0
1322 if (!buffer_info->range) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001323 *error_code = VALIDATION_ERROR_00960;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001324 std::stringstream error_str;
1325 error_str << "VkDescriptorBufferInfo range is not VK_WHOLE_SIZE and is zero, which is not allowed.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001326 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001327 return false;
1328 }
1329 // Range must be VK_WHOLE_SIZE or <= (buffer size - offset)
1330 if (buffer_info->range > (buffer_node->createInfo.size - buffer_info->offset)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001331 *error_code = VALIDATION_ERROR_00961;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001332 std::stringstream error_str;
1333 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range << " which is greater than buffer size ("
1334 << buffer_node->createInfo.size << ") minus requested offset of " << buffer_info->offset;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001335 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001336 return false;
1337 }
1338 }
1339 return true;
1340}
1341
Tobin Ehlis300888c2016-05-18 13:43:26 -06001342// Verify that the contents of the update are ok, but don't perform actual update
1343bool cvdescriptorset::DescriptorSet::VerifyWriteUpdateContents(const VkWriteDescriptorSet *update, const uint32_t index,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001344 UNIQUE_VALIDATION_ERROR_CODE *error_code,
1345 std::string *error_msg) const {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001346 switch (update->descriptorType) {
1347 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
1348 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1349 // Validate image
1350 auto image_view = update->pImageInfo[di].imageView;
1351 auto image_layout = update->pImageInfo[di].imageLayout;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001352 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001353 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001354 error_str << "Attempted write update to combined image sampler descriptor failed due to: " << error_msg->c_str();
1355 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001356 return false;
1357 }
1358 }
1359 // Intentional fall-through to validate sampler
1360 }
1361 case VK_DESCRIPTOR_TYPE_SAMPLER: {
1362 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1363 if (!descriptors_[index + di].get()->IsImmutableSampler()) {
Tobin Ehlise2f80292016-06-02 10:08:53 -06001364 if (!ValidateSampler(update->pImageInfo[di].sampler, device_data_)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001365 *error_code = VALIDATION_ERROR_00942;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001366 std::stringstream error_str;
1367 error_str << "Attempted write update to sampler descriptor with invalid sampler: "
1368 << update->pImageInfo[di].sampler << ".";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001369 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001370 return false;
1371 }
1372 } else {
1373 // TODO : Warn here
1374 }
1375 }
1376 break;
1377 }
1378 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1379 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
1380 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
1381 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1382 auto image_view = update->pImageInfo[di].imageView;
1383 auto image_layout = update->pImageInfo[di].imageLayout;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001384 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001385 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001386 error_str << "Attempted write update to image descriptor failed due to: " << error_msg->c_str();
1387 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001388 return false;
1389 }
1390 }
1391 break;
1392 }
1393 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1394 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER: {
1395 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1396 auto buffer_view = update->pTexelBufferView[di];
Tobin Ehlis8b872462016-09-14 08:12:08 -06001397 auto bv_state = getBufferViewState(device_data_, buffer_view);
1398 if (!bv_state) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001399 *error_code = VALIDATION_ERROR_00940;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001400 std::stringstream error_str;
1401 error_str << "Attempted write update to texel buffer descriptor with invalid buffer view: " << buffer_view;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001402 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001403 return false;
1404 }
Tobin Ehlis8b872462016-09-14 08:12:08 -06001405 auto buffer = bv_state->create_info.buffer;
Tobin Ehlis4668dce2016-11-16 09:30:23 -07001406 if (!ValidateBufferUsage(getBufferState(device_data_, buffer), update->descriptorType, error_code, error_msg)) {
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001407 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001408 error_str << "Attempted write update to texel buffer descriptor failed due to: " << error_msg->c_str();
1409 *error_msg = error_str.str();
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001410 return false;
1411 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001412 }
1413 break;
1414 }
1415 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1416 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1417 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1418 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC: {
1419 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001420 if (!ValidateBufferUpdate(update->pBufferInfo + di, update->descriptorType, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001421 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001422 error_str << "Attempted write update to buffer descriptor failed due to: " << error_msg->c_str();
1423 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001424 return false;
1425 }
1426 }
1427 break;
1428 }
1429 default:
1430 assert(0); // We've already verified update type so should never get here
1431 break;
1432 }
1433 // All checks passed so update contents are good
1434 return true;
1435}
1436// Verify that the contents of the update are ok, but don't perform actual update
1437bool cvdescriptorset::DescriptorSet::VerifyCopyUpdateContents(const VkCopyDescriptorSet *update, const DescriptorSet *src_set,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001438 VkDescriptorType type, uint32_t index,
1439 UNIQUE_VALIDATION_ERROR_CODE *error_code,
1440 std::string *error_msg) const {
1441 // Note : Repurposing some Write update error codes here as specific details aren't called out for copy updates like they are
1442 // for write updates
Tobin Ehlis300888c2016-05-18 13:43:26 -06001443 switch (src_set->descriptors_[index]->descriptor_class) {
1444 case PlainSampler: {
1445 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1446 if (!src_set->descriptors_[index + di]->IsImmutableSampler()) {
1447 auto update_sampler = static_cast<SamplerDescriptor *>(src_set->descriptors_[index + di].get())->GetSampler();
Tobin Ehlise2f80292016-06-02 10:08:53 -06001448 if (!ValidateSampler(update_sampler, device_data_)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001449 *error_code = VALIDATION_ERROR_00942;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001450 std::stringstream error_str;
1451 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001452 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001453 return false;
1454 }
1455 } else {
1456 // TODO : Warn here
1457 }
1458 }
1459 break;
1460 }
1461 case ImageSampler: {
1462 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1463 auto img_samp_desc = static_cast<const ImageSamplerDescriptor *>(src_set->descriptors_[index + di].get());
1464 // First validate sampler
1465 if (!img_samp_desc->IsImmutableSampler()) {
1466 auto update_sampler = img_samp_desc->GetSampler();
Tobin Ehlise2f80292016-06-02 10:08:53 -06001467 if (!ValidateSampler(update_sampler, device_data_)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001468 *error_code = VALIDATION_ERROR_00942;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001469 std::stringstream error_str;
1470 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001471 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001472 return false;
1473 }
1474 } else {
1475 // TODO : Warn here
1476 }
1477 // Validate image
1478 auto image_view = img_samp_desc->GetImageView();
1479 auto image_layout = img_samp_desc->GetImageLayout();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001480 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001481 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001482 error_str << "Attempted copy update to combined image sampler descriptor failed due to: " << error_msg->c_str();
1483 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001484 return false;
1485 }
1486 }
Alex Smithd8f14792016-09-23 12:18:51 +01001487 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001488 }
1489 case Image: {
1490 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1491 auto img_desc = static_cast<const ImageDescriptor *>(src_set->descriptors_[index + di].get());
1492 auto image_view = img_desc->GetImageView();
1493 auto image_layout = img_desc->GetImageLayout();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001494 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001495 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001496 error_str << "Attempted copy update to image descriptor failed due to: " << error_msg->c_str();
1497 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001498 return false;
1499 }
1500 }
1501 break;
1502 }
1503 case TexelBuffer: {
1504 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1505 auto buffer_view = static_cast<TexelDescriptor *>(src_set->descriptors_[index + di].get())->GetBufferView();
Tobin Ehlis8b872462016-09-14 08:12:08 -06001506 auto bv_state = getBufferViewState(device_data_, buffer_view);
1507 if (!bv_state) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001508 *error_code = VALIDATION_ERROR_00940;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001509 std::stringstream error_str;
Tobin Ehliscbcf2342016-05-24 13:07:12 -06001510 error_str << "Attempted copy update to texel buffer descriptor with invalid buffer view: " << buffer_view;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001511 *error_msg = error_str.str();
Tobin Ehliscbcf2342016-05-24 13:07:12 -06001512 return false;
1513 }
Tobin Ehlis8b872462016-09-14 08:12:08 -06001514 auto buffer = bv_state->create_info.buffer;
Tobin Ehlis4668dce2016-11-16 09:30:23 -07001515 if (!ValidateBufferUsage(getBufferState(device_data_, buffer), type, error_code, error_msg)) {
Tobin Ehliscbcf2342016-05-24 13:07:12 -06001516 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001517 error_str << "Attempted copy update to texel buffer descriptor failed due to: " << error_msg->c_str();
1518 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001519 return false;
1520 }
1521 }
1522 break;
1523 }
1524 case GeneralBuffer: {
1525 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1526 auto buffer = static_cast<BufferDescriptor *>(src_set->descriptors_[index + di].get())->GetBuffer();
Tobin Ehlis4668dce2016-11-16 09:30:23 -07001527 if (!ValidateBufferUsage(getBufferState(device_data_, buffer), type, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001528 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001529 error_str << "Attempted copy update to buffer descriptor failed due to: " << error_msg->c_str();
1530 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001531 return false;
1532 }
1533 }
1534 break;
1535 }
1536 default:
1537 assert(0); // We've already verified update type so should never get here
1538 break;
1539 }
1540 // All checks passed so update contents are good
1541 return true;
Chris Forbesb4e0bdb2016-05-31 16:34:40 +12001542}
Tobin Ehlisee471462016-05-26 11:21:59 -06001543// Verify that the state at allocate time is correct, but don't actually allocate the sets yet
Tobin Ehlis815e8132016-06-02 13:02:17 -06001544bool cvdescriptorset::ValidateAllocateDescriptorSets(const debug_report_data *report_data,
1545 const VkDescriptorSetAllocateInfo *p_alloc_info,
1546 const core_validation::layer_data *dev_data,
1547 AllocateDescriptorSetsData *ds_data) {
Tobin Ehlisee471462016-05-26 11:21:59 -06001548 bool skip_call = false;
Tobin Ehlisee471462016-05-26 11:21:59 -06001549
1550 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Tobin Ehlis815e8132016-06-02 13:02:17 -06001551 auto layout = getDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
1552 if (!layout) {
Tobin Ehlisee471462016-05-26 11:21:59 -06001553 skip_call |=
1554 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT,
1555 reinterpret_cast<const uint64_t &>(p_alloc_info->pSetLayouts[i]), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
1556 "Unable to find set layout node for layout 0x%" PRIxLEAST64 " specified in vkAllocateDescriptorSets() call",
1557 reinterpret_cast<const uint64_t &>(p_alloc_info->pSetLayouts[i]));
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001558 } else {
Tobin Ehlis815e8132016-06-02 13:02:17 -06001559 ds_data->layout_nodes[i] = layout;
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001560 // Count total descriptors required per type
Tobin Ehlis815e8132016-06-02 13:02:17 -06001561 for (uint32_t j = 0; j < layout->GetBindingCount(); ++j) {
1562 const auto &binding_layout = layout->GetDescriptorSetLayoutBindingPtrFromIndex(j);
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001563 uint32_t typeIndex = static_cast<uint32_t>(binding_layout->descriptorType);
1564 ds_data->required_descriptors_by_type[typeIndex] += binding_layout->descriptorCount;
1565 }
Tobin Ehlisee471462016-05-26 11:21:59 -06001566 }
1567 }
Tobin Ehlis15e6f792016-10-12 15:01:39 -06001568 auto pool_state = getDescriptorPoolState(dev_data, p_alloc_info->descriptorPool);
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001569 // Track number of descriptorSets allowable in this pool
Tobin Ehlis15e6f792016-10-12 15:01:39 -06001570 if (pool_state->availableSets < p_alloc_info->descriptorSetCount) {
Tobin Ehlisc4c4bed2016-11-23 12:23:32 -07001571 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT,
1572 reinterpret_cast<uint64_t &>(pool_state->pool), __LINE__, VALIDATION_ERROR_00911, "DS",
1573 "Unable to allocate %u descriptorSets from pool 0x%" PRIxLEAST64
1574 ". This pool only has %d descriptorSets remaining. %s",
1575 p_alloc_info->descriptorSetCount, reinterpret_cast<uint64_t &>(pool_state->pool),
1576 pool_state->availableSets, validation_error_map[VALIDATION_ERROR_00911]);
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001577 }
1578 // Determine whether descriptor counts are satisfiable
1579 for (uint32_t i = 0; i < VK_DESCRIPTOR_TYPE_RANGE_SIZE; i++) {
Tobin Ehlis15e6f792016-10-12 15:01:39 -06001580 if (ds_data->required_descriptors_by_type[i] > pool_state->availableDescriptorTypeCount[i]) {
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001581 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 -07001582 reinterpret_cast<const uint64_t &>(pool_state->pool), __LINE__, VALIDATION_ERROR_00912, "DS",
1583 "Unable to allocate %u descriptors of type %s from pool 0x%" PRIxLEAST64
1584 ". This pool only has %d descriptors of this type remaining. %s",
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001585 ds_data->required_descriptors_by_type[i], string_VkDescriptorType(VkDescriptorType(i)),
Tobin Ehlisc4c4bed2016-11-23 12:23:32 -07001586 reinterpret_cast<uint64_t &>(pool_state->pool), pool_state->availableDescriptorTypeCount[i],
1587 validation_error_map[VALIDATION_ERROR_00912]);
Tobin Ehlisee471462016-05-26 11:21:59 -06001588 }
1589 }
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001590
Tobin Ehlisee471462016-05-26 11:21:59 -06001591 return skip_call;
1592}
1593// Decrement allocated sets from the pool and insert new sets into set_map
Tobin Ehlis4e380592016-06-02 12:41:47 -06001594void cvdescriptorset::PerformAllocateDescriptorSets(const VkDescriptorSetAllocateInfo *p_alloc_info,
1595 const VkDescriptorSet *descriptor_sets,
1596 const AllocateDescriptorSetsData *ds_data,
Tobin Ehlisbd711bd2016-10-12 14:27:30 -06001597 std::unordered_map<VkDescriptorPool, DESCRIPTOR_POOL_STATE *> *pool_map,
Tobin Ehlis4e380592016-06-02 12:41:47 -06001598 std::unordered_map<VkDescriptorSet, cvdescriptorset::DescriptorSet *> *set_map,
1599 const core_validation::layer_data *dev_data) {
Tobin Ehlisee471462016-05-26 11:21:59 -06001600 auto pool_state = (*pool_map)[p_alloc_info->descriptorPool];
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001601 /* Account for sets and individual descriptors allocated from pool */
Tobin Ehlisee471462016-05-26 11:21:59 -06001602 pool_state->availableSets -= p_alloc_info->descriptorSetCount;
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001603 for (uint32_t i = 0; i < VK_DESCRIPTOR_TYPE_RANGE_SIZE; i++) {
1604 pool_state->availableDescriptorTypeCount[i] -= ds_data->required_descriptors_by_type[i];
1605 }
Tobin Ehlisee471462016-05-26 11:21:59 -06001606 /* Create tracking object for each descriptor set; insert into
1607 * global map and the pool's set.
1608 */
1609 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Tobin Ehlis93f22372016-10-12 14:34:12 -06001610 auto new_ds = new cvdescriptorset::DescriptorSet(descriptor_sets[i], p_alloc_info->descriptorPool, ds_data->layout_nodes[i],
1611 dev_data);
Tobin Ehlisee471462016-05-26 11:21:59 -06001612
1613 pool_state->sets.insert(new_ds);
1614 new_ds->in_use.store(0);
1615 (*set_map)[descriptor_sets[i]] = new_ds;
1616 }
1617}