blob: 84663c4b18bef298bf227577d0f61df9b2b6cba9 [file] [log] [blame]
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001/* Copyright (c) 2015-2016 The Khronos Group Inc.
2 * Copyright (c) 2015-2016 Valve Corporation
3 * Copyright (c) 2015-2016 LunarG, Inc.
4 * Copyright (C) 2015-2016 Google Inc.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Tobin Ehlis <tobine@google.com>
19 */
20
Tobin Ehlisf922ef82016-11-30 10:19:14 -070021// Allow use of STL min and max functions in Windows
22#define NOMINMAX
23
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060024#include "descriptor_sets.h"
25#include "vk_enum_string_helper.h"
26#include "vk_safe_struct.h"
27#include <sstream>
Mark Lobodzinski2eee5d82016-12-02 15:33:18 -070028#include <algorithm>
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060029
30// Construct DescriptorSetLayout instance from given create info
Tobin Ehlis154c2692016-10-25 09:36:53 -060031cvdescriptorset::DescriptorSetLayout::DescriptorSetLayout(const VkDescriptorSetLayoutCreateInfo *p_create_info,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060032 const VkDescriptorSetLayout layout)
33 : layout_(layout), binding_count_(p_create_info->bindingCount), descriptor_count_(0), dynamic_descriptor_count_(0) {
Tobin Ehlisa3525e02016-11-17 10:50:52 -070034 // Dyn array indicies are ordered by binding # and array index of any array within the binding
35 // so we store up bindings w/ count in ordered map in order to create dyn array mappings below
36 std::map<uint32_t, uint32_t> binding_to_dyn_count;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060037 for (uint32_t i = 0; i < binding_count_; ++i) {
Tobin Ehlis9637fb22016-12-12 15:59:34 -070038 auto binding_num = p_create_info->pBindings[i].binding;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060039 descriptor_count_ += p_create_info->pBindings[i].descriptorCount;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -070040 uint32_t insert_index = 0; // Track vector index where we insert element
Tobin Ehlis9637fb22016-12-12 15:59:34 -070041 if (bindings_.empty() || binding_num > bindings_.back().binding) {
42 bindings_.push_back(safe_VkDescriptorSetLayoutBinding(&p_create_info->pBindings[i]));
Jamie Madill3f5fd492016-12-19 15:59:18 -050043 insert_index = static_cast<uint32_t>(bindings_.size()) - 1;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -070044 } else { // out-of-order binding number, need to insert into vector in-order
Tobin Ehlis9637fb22016-12-12 15:59:34 -070045 auto it = bindings_.begin();
46 // Find currently binding's spot in vector
47 while (binding_num > it->binding) {
48 assert(it != bindings_.end());
49 ++insert_index;
50 ++it;
51 }
52 bindings_.insert(it, safe_VkDescriptorSetLayoutBinding(&p_create_info->pBindings[i]));
53 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060054 // In cases where we should ignore pImmutableSamplers make sure it's NULL
55 if ((p_create_info->pBindings[i].pImmutableSamplers) &&
56 ((p_create_info->pBindings[i].descriptorType != VK_DESCRIPTOR_TYPE_SAMPLER) &&
57 (p_create_info->pBindings[i].descriptorType != VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER))) {
Tobin Ehlis9637fb22016-12-12 15:59:34 -070058 bindings_[insert_index].pImmutableSamplers = nullptr;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060059 }
60 if (p_create_info->pBindings[i].descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
61 p_create_info->pBindings[i].descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC) {
Tobin Ehlisa3525e02016-11-17 10:50:52 -070062 binding_to_dyn_count[p_create_info->pBindings[i].binding] = p_create_info->pBindings[i].descriptorCount;
Tobin Ehlisef0de162016-06-20 13:07:34 -060063 dynamic_descriptor_count_ += p_create_info->pBindings[i].descriptorCount;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060064 }
65 }
Tobin Ehlis9637fb22016-12-12 15:59:34 -070066 assert(bindings_.size() == binding_count_);
67 uint32_t global_index = 0;
68 // Vector order is finalized so create maps of bindings to indices
69 for (uint32_t i = 0; i < binding_count_; ++i) {
70 auto binding_num = bindings_[i].binding;
71 binding_to_index_map_[binding_num] = i;
72 binding_to_global_start_index_map_[binding_num] = global_index;
73 global_index += bindings_[i].descriptorCount ? bindings_[i].descriptorCount - 1 : 0;
74 binding_to_global_end_index_map_[binding_num] = global_index;
75 global_index += bindings_[i].descriptorCount ? 1 : 0;
76 }
Tobin Ehlisa3525e02016-11-17 10:50:52 -070077 // Now create dyn offset array mapping for any dynamic descriptors
78 uint32_t dyn_array_idx = 0;
79 for (const auto &bc_pair : binding_to_dyn_count) {
80 binding_to_dynamic_array_idx_map_[bc_pair.first] = dyn_array_idx;
81 dyn_array_idx += bc_pair.second;
82 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060083}
Tobin Ehlis154c2692016-10-25 09:36:53 -060084
85// Validate descriptor set layout create info
86bool cvdescriptorset::DescriptorSetLayout::ValidateCreateInfo(debug_report_data *report_data,
87 const VkDescriptorSetLayoutCreateInfo *create_info) {
88 bool skip = false;
89 std::unordered_set<uint32_t> bindings;
90 for (uint32_t i = 0; i < create_info->bindingCount; ++i) {
Tobin Ehlisfdcb63f2016-10-25 20:56:47 -060091 if (!bindings.insert(create_info->pBindings[i].binding).second) {
Tobin Ehlis154c2692016-10-25 09:36:53 -060092 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
93 VALIDATION_ERROR_02345, "DS", "duplicated binding number in VkDescriptorSetLayoutBinding. %s",
94 validation_error_map[VALIDATION_ERROR_02345]);
95 }
Tobin Ehlis154c2692016-10-25 09:36:53 -060096 }
97 return skip;
98}
99
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600100// put all bindings into the given set
101void cvdescriptorset::DescriptorSetLayout::FillBindingSet(std::unordered_set<uint32_t> *binding_set) const {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700102 for (auto binding_index_pair : binding_to_index_map_) binding_set->insert(binding_index_pair.first);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600103}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600104
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700105VkDescriptorSetLayoutBinding const *cvdescriptorset::DescriptorSetLayout::GetDescriptorSetLayoutBindingPtrFromBinding(
106 const uint32_t binding) const {
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600107 const auto &bi_itr = binding_to_index_map_.find(binding);
108 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600109 return bindings_[bi_itr->second].ptr();
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600110 }
111 return nullptr;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600112}
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700113VkDescriptorSetLayoutBinding const *cvdescriptorset::DescriptorSetLayout::GetDescriptorSetLayoutBindingPtrFromIndex(
114 const uint32_t index) const {
115 if (index >= bindings_.size()) return nullptr;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600116 return bindings_[index].ptr();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600117}
118// Return descriptorCount for given binding, 0 if index is unavailable
119uint32_t cvdescriptorset::DescriptorSetLayout::GetDescriptorCountFromBinding(const uint32_t binding) const {
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600120 const auto &bi_itr = binding_to_index_map_.find(binding);
121 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600122 return bindings_[bi_itr->second].descriptorCount;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600123 }
124 return 0;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600125}
126// Return descriptorCount for given index, 0 if index is unavailable
127uint32_t cvdescriptorset::DescriptorSetLayout::GetDescriptorCountFromIndex(const uint32_t index) const {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700128 if (index >= bindings_.size()) return 0;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600129 return bindings_[index].descriptorCount;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600130}
131// For the given binding, return descriptorType
132VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromBinding(const uint32_t binding) const {
133 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600134 const auto &bi_itr = binding_to_index_map_.find(binding);
135 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600136 return bindings_[bi_itr->second].descriptorType;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600137 }
138 return VK_DESCRIPTOR_TYPE_MAX_ENUM;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600139}
140// For the given index, return descriptorType
141VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromIndex(const uint32_t index) const {
142 assert(index < bindings_.size());
Tobin Ehlis664e6012016-05-05 11:04:44 -0600143 return bindings_[index].descriptorType;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600144}
145// For the given global index, return descriptorType
146// Currently just counting up through bindings_, may improve this in future
147VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromGlobalIndex(const uint32_t index) const {
148 uint32_t global_offset = 0;
149 for (auto binding : bindings_) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600150 global_offset += binding.descriptorCount;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700151 if (index < global_offset) return binding.descriptorType;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600152 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700153 assert(0); // requested global index is out of bounds
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600154 return VK_DESCRIPTOR_TYPE_MAX_ENUM;
155}
156// For the given binding, return stageFlags
157VkShaderStageFlags cvdescriptorset::DescriptorSetLayout::GetStageFlagsFromBinding(const uint32_t binding) const {
158 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600159 const auto &bi_itr = binding_to_index_map_.find(binding);
160 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600161 return bindings_[bi_itr->second].stageFlags;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600162 }
163 return VkShaderStageFlags(0);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600164}
165// For the given binding, return start index
166uint32_t cvdescriptorset::DescriptorSetLayout::GetGlobalStartIndexFromBinding(const uint32_t binding) const {
167 assert(binding_to_global_start_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600168 const auto &btgsi_itr = binding_to_global_start_index_map_.find(binding);
169 if (btgsi_itr != binding_to_global_start_index_map_.end()) {
170 return btgsi_itr->second;
171 }
172 // In error case max uint32_t so index is out of bounds to break ASAP
Tobin Ehlis58c59582016-06-21 12:34:33 -0600173 assert(0);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600174 return 0xFFFFFFFF;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600175}
176// For the given binding, return end index
177uint32_t cvdescriptorset::DescriptorSetLayout::GetGlobalEndIndexFromBinding(const uint32_t binding) const {
178 assert(binding_to_global_end_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600179 const auto &btgei_itr = binding_to_global_end_index_map_.find(binding);
180 if (btgei_itr != binding_to_global_end_index_map_.end()) {
181 return btgei_itr->second;
182 }
183 // In error case max uint32_t so index is out of bounds to break ASAP
Tobin Ehlis58c59582016-06-21 12:34:33 -0600184 assert(0);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600185 return 0xFFFFFFFF;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600186}
187// For given binding, return ptr to ImmutableSampler array
188VkSampler const *cvdescriptorset::DescriptorSetLayout::GetImmutableSamplerPtrFromBinding(const uint32_t binding) const {
189 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600190 const auto &bi_itr = binding_to_index_map_.find(binding);
191 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600192 return bindings_[bi_itr->second].pImmutableSamplers;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600193 }
194 return nullptr;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600195}
Mark Lobodzinski4aa479d2017-03-10 09:14:00 -0700196// Move to next valid binding having a non-zero binding count
197uint32_t cvdescriptorset::DescriptorSetLayout::GetNextValidBinding(const uint32_t binding) const {
198 uint32_t new_binding = binding;
199 do {
200 new_binding++;
201 } while (GetDescriptorCountFromBinding(new_binding) == 0);
202 return new_binding;
203}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600204// For given index, return ptr to ImmutableSampler array
205VkSampler const *cvdescriptorset::DescriptorSetLayout::GetImmutableSamplerPtrFromIndex(const uint32_t index) const {
206 assert(index < bindings_.size());
Tobin Ehlis664e6012016-05-05 11:04:44 -0600207 return bindings_[index].pImmutableSamplers;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600208}
209// If our layout is compatible with rh_ds_layout, return true,
210// else return false and fill in error_msg will description of what causes incompatibility
211bool cvdescriptorset::DescriptorSetLayout::IsCompatible(const DescriptorSetLayout *rh_ds_layout, std::string *error_msg) const {
212 // Trivial case
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700213 if (layout_ == rh_ds_layout->GetDescriptorSetLayout()) return true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600214 if (descriptor_count_ != rh_ds_layout->descriptor_count_) {
215 std::stringstream error_str;
216 error_str << "DescriptorSetLayout " << layout_ << " has " << descriptor_count_ << " descriptors, but DescriptorSetLayout "
217 << rh_ds_layout->GetDescriptorSetLayout() << " has " << rh_ds_layout->descriptor_count_ << " descriptors.";
218 *error_msg = error_str.str();
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700219 return false; // trivial fail case
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600220 }
221 // Descriptor counts match so need to go through bindings one-by-one
222 // and verify that type and stageFlags match
223 for (auto binding : bindings_) {
224 // TODO : Do we also need to check immutable samplers?
225 // VkDescriptorSetLayoutBinding *rh_binding;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600226 if (binding.descriptorCount != rh_ds_layout->GetDescriptorCountFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600227 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600228 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " has a descriptorCount of "
229 << binding.descriptorCount << " but binding " << binding.binding << " for DescriptorSetLayout "
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600230 << rh_ds_layout->GetDescriptorSetLayout() << " has a descriptorCount of "
Tobin Ehlis664e6012016-05-05 11:04:44 -0600231 << rh_ds_layout->GetDescriptorCountFromBinding(binding.binding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600232 *error_msg = error_str.str();
233 return false;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600234 } else if (binding.descriptorType != rh_ds_layout->GetTypeFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600235 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600236 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " is type '"
237 << string_VkDescriptorType(binding.descriptorType) << "' but binding " << binding.binding
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600238 << " for DescriptorSetLayout " << rh_ds_layout->GetDescriptorSetLayout() << " is type '"
Tobin Ehlis664e6012016-05-05 11:04:44 -0600239 << string_VkDescriptorType(rh_ds_layout->GetTypeFromBinding(binding.binding)) << "'";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600240 *error_msg = error_str.str();
241 return false;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600242 } else if (binding.stageFlags != rh_ds_layout->GetStageFlagsFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600243 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600244 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " has stageFlags "
245 << binding.stageFlags << " but binding " << binding.binding << " for DescriptorSetLayout "
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600246 << rh_ds_layout->GetDescriptorSetLayout() << " has stageFlags "
Tobin Ehlis664e6012016-05-05 11:04:44 -0600247 << rh_ds_layout->GetStageFlagsFromBinding(binding.binding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600248 *error_msg = error_str.str();
249 return false;
250 }
251 }
252 return true;
253}
254
255bool cvdescriptorset::DescriptorSetLayout::IsNextBindingConsistent(const uint32_t binding) const {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700256 if (!binding_to_index_map_.count(binding + 1)) return false;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600257 auto const &bi_itr = binding_to_index_map_.find(binding);
258 if (bi_itr != binding_to_index_map_.end()) {
259 const auto &next_bi_itr = binding_to_index_map_.find(binding + 1);
260 if (next_bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600261 auto type = bindings_[bi_itr->second].descriptorType;
262 auto stage_flags = bindings_[bi_itr->second].stageFlags;
263 auto immut_samp = bindings_[bi_itr->second].pImmutableSamplers ? true : false;
264 if ((type != bindings_[next_bi_itr->second].descriptorType) ||
265 (stage_flags != bindings_[next_bi_itr->second].stageFlags) ||
266 (immut_samp != (bindings_[next_bi_itr->second].pImmutableSamplers ? true : false))) {
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600267 return false;
268 }
269 return true;
270 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600271 }
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600272 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600273}
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600274// Starting at offset descriptor of given binding, parse over update_count
275// descriptor updates and verify that for any binding boundaries that are crossed, the next binding(s) are all consistent
276// Consistency means that their type, stage flags, and whether or not they use immutable samplers matches
277// If so, return true. If not, fill in error_msg and return false
278bool cvdescriptorset::DescriptorSetLayout::VerifyUpdateConsistency(uint32_t current_binding, uint32_t offset, uint32_t update_count,
279 const char *type, const VkDescriptorSet set,
280 std::string *error_msg) const {
281 // Verify consecutive bindings match (if needed)
282 auto orig_binding = current_binding;
283 // Track count of descriptors in the current_bindings that are remaining to be updated
284 auto binding_remaining = GetDescriptorCountFromBinding(current_binding);
285 // First, it's legal to offset beyond your own binding so handle that case
286 // Really this is just searching for the binding in which the update begins and adjusting offset accordingly
287 while (offset >= binding_remaining) {
288 // Advance to next binding, decrement offset by binding size
289 offset -= binding_remaining;
290 binding_remaining = GetDescriptorCountFromBinding(++current_binding);
291 }
292 binding_remaining -= offset;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700293 while (update_count > binding_remaining) { // While our updates overstep current binding
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600294 // Verify next consecutive binding matches type, stage flags & immutable sampler use
295 if (!IsNextBindingConsistent(current_binding++)) {
296 std::stringstream error_str;
297 error_str << "Attempting " << type << " descriptor set " << set << " binding #" << orig_binding << " with #"
298 << update_count << " descriptors being updated but this update oversteps the bounds of this binding and the "
299 "next binding is not consistent with current binding so this update is invalid.";
300 *error_msg = error_str.str();
301 return false;
302 }
303 // For sake of this check consider the bindings updated and grab count for next binding
304 update_count -= binding_remaining;
305 binding_remaining = GetDescriptorCountFromBinding(current_binding);
306 }
307 return true;
308}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600309
Tobin Ehlis68d0adf2016-06-01 11:33:50 -0600310cvdescriptorset::AllocateDescriptorSetsData::AllocateDescriptorSetsData(uint32_t count)
311 : required_descriptors_by_type{}, layout_nodes(count, nullptr) {}
312
Tobin Ehlis93f22372016-10-12 14:34:12 -0600313cvdescriptorset::DescriptorSet::DescriptorSet(const VkDescriptorSet set, const VkDescriptorPool pool,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700314 const DescriptorSetLayout *layout, const layer_data *dev_data)
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -0700315 : some_update_(false),
316 set_(set),
317 pool_state_(nullptr),
318 p_layout_(layout),
319 device_data_(dev_data),
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700320 limits_(GetPhysDevProperties(dev_data)->properties.limits) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700321 pool_state_ = GetDescriptorPoolState(dev_data, pool);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600322 // Foreach binding, create default descriptors of given type
323 for (uint32_t i = 0; i < p_layout_->GetBindingCount(); ++i) {
324 auto type = p_layout_->GetTypeFromIndex(i);
325 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700326 case VK_DESCRIPTOR_TYPE_SAMPLER: {
327 auto immut_sampler = p_layout_->GetImmutableSamplerPtrFromIndex(i);
328 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
329 if (immut_sampler)
330 descriptors_.emplace_back(new SamplerDescriptor(immut_sampler + di));
331 else
332 descriptors_.emplace_back(new SamplerDescriptor());
333 }
334 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600335 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700336 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
337 auto immut = p_layout_->GetImmutableSamplerPtrFromIndex(i);
338 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
339 if (immut)
340 descriptors_.emplace_back(new ImageSamplerDescriptor(immut + di));
341 else
342 descriptors_.emplace_back(new ImageSamplerDescriptor());
343 }
344 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600345 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700346 // ImageDescriptors
347 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
348 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
349 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
350 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
351 descriptors_.emplace_back(new ImageDescriptor(type));
352 break;
353 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
354 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
355 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
356 descriptors_.emplace_back(new TexelDescriptor(type));
357 break;
358 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
359 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
360 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
361 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
362 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
363 descriptors_.emplace_back(new BufferDescriptor(type));
364 break;
365 default:
366 assert(0); // Bad descriptor type specified
367 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600368 }
369 }
370}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600371
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700372cvdescriptorset::DescriptorSet::~DescriptorSet() { InvalidateBoundCmdBuffers(); }
Chris Forbes57989132016-07-26 17:06:10 +1200373
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700374static std::string string_descriptor_req_view_type(descriptor_req req) {
375 std::string result("");
Chris Forbes57989132016-07-26 17:06:10 +1200376 for (unsigned i = 0; i <= VK_IMAGE_VIEW_TYPE_END_RANGE; i++) {
377 if (req & (1 << i)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700378 if (result.size()) result += ", ";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700379 result += string_VkImageViewType(VkImageViewType(i));
Chris Forbes57989132016-07-26 17:06:10 +1200380 }
381 }
382
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700383 if (!result.size()) result = "(none)";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700384
385 return result;
Chris Forbes57989132016-07-26 17:06:10 +1200386}
387
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600388// Is this sets underlying layout compatible with passed in layout according to "Pipeline Layout Compatibility" in spec?
389bool cvdescriptorset::DescriptorSet::IsCompatible(const DescriptorSetLayout *layout, std::string *error) const {
390 return layout->IsCompatible(p_layout_, error);
391}
Chris Forbes57989132016-07-26 17:06:10 +1200392
Tobin Ehlis3066db62016-08-22 08:12:23 -0600393// 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 -0600394// This includes validating that all descriptors in the given bindings are updated,
395// that any update buffers are valid, and that any dynamic offsets are within the bounds of their buffers.
396// Return true if state is acceptable, or false and write an error message into error string
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600397bool cvdescriptorset::DescriptorSet::ValidateDrawState(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600398 const std::vector<uint32_t> &dynamic_offsets, std::string *error) const {
Chris Forbesc7090a82016-07-25 18:10:41 +1200399 for (auto binding_pair : bindings) {
400 auto binding = binding_pair.first;
Tobin Ehlis58c59582016-06-21 12:34:33 -0600401 if (!p_layout_->HasBinding(binding)) {
402 std::stringstream error_str;
403 error_str << "Attempting to validate DrawState for binding #" << binding
404 << " which is an invalid binding for this descriptor set.";
405 *error = error_str.str();
406 return false;
407 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600408 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
Tobin Ehlis81f17852016-05-05 09:04:33 -0600409 if (descriptors_[start_idx]->IsImmutableSampler()) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600410 // Nothing to do for strictly immutable sampler
411 } else {
412 auto end_idx = p_layout_->GetGlobalEndIndexFromBinding(binding);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700413 auto array_idx = 0; // Track array idx if we're dealing with array descriptors
Tobin Ehlisa3525e02016-11-17 10:50:52 -0700414 for (uint32_t i = start_idx; i <= end_idx; ++i, ++array_idx) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600415 if (!descriptors_[i]->updated) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600416 std::stringstream error_str;
417 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
418 << " is being used in draw but has not been updated.";
419 *error = error_str.str();
420 return false;
421 } else {
Chris Forbes57989132016-07-26 17:06:10 +1200422 auto descriptor_class = descriptors_[i]->GetClass();
423 if (descriptor_class == GeneralBuffer) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600424 // Verify that buffers are valid
Tobin Ehlis81f17852016-05-05 09:04:33 -0600425 auto buffer = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetBuffer();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700426 auto buffer_node = GetBufferState(device_data_, buffer);
Tobin Ehlis94bc5d22016-06-02 07:46:52 -0600427 if (!buffer_node) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600428 std::stringstream error_str;
429 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
430 << " references invalid buffer " << buffer << ".";
431 *error = error_str.str();
432 return false;
433 } else {
Tobin Ehlis640a81c2016-11-15 15:37:18 -0700434 for (auto mem_binding : buffer_node->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700435 if (!GetMemObjInfo(device_data_, mem_binding)) {
Tobin Ehlis640a81c2016-11-15 15:37:18 -0700436 std::stringstream error_str;
437 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
438 << " uses buffer " << buffer << " that references invalid memory " << mem_binding
439 << ".";
440 *error = error_str.str();
441 return false;
442 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600443 }
444 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600445 if (descriptors_[i]->IsDynamic()) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600446 // Validate that dynamic offsets are within the buffer
Tobin Ehlis94bc5d22016-06-02 07:46:52 -0600447 auto buffer_size = buffer_node->createInfo.size;
Tobin Ehlis81f17852016-05-05 09:04:33 -0600448 auto range = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetRange();
449 auto desc_offset = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetOffset();
Tobin Ehlisa3525e02016-11-17 10:50:52 -0700450 auto dyn_offset = dynamic_offsets[GetDynamicOffsetIndexFromBinding(binding) + array_idx];
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600451 if (VK_WHOLE_SIZE == range) {
452 if ((dyn_offset + desc_offset) > buffer_size) {
453 std::stringstream error_str;
454 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
455 << " uses buffer " << buffer
456 << " with update range of VK_WHOLE_SIZE has dynamic offset " << dyn_offset
457 << " combined with offset " << desc_offset << " that oversteps the buffer size of "
458 << buffer_size << ".";
459 *error = error_str.str();
460 return false;
461 }
462 } else {
463 if ((dyn_offset + desc_offset + range) > buffer_size) {
464 std::stringstream error_str;
465 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
466 << " uses buffer " << buffer << " with dynamic offset " << dyn_offset
467 << " combined with offset " << desc_offset << " and range " << range
468 << " that oversteps the buffer size of " << buffer_size << ".";
469 *error = error_str.str();
470 return false;
471 }
472 }
473 }
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700474 } else if (descriptor_class == ImageSampler || descriptor_class == Image) {
Chris Forbes57989132016-07-26 17:06:10 +1200475 auto image_view = (descriptor_class == ImageSampler)
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700476 ? static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetImageView()
477 : static_cast<ImageDescriptor *>(descriptors_[i].get())->GetImageView();
Chris Forbes57989132016-07-26 17:06:10 +1200478 auto reqs = binding_pair.second;
479
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700480 auto image_view_state = GetImageViewState(device_data_, image_view);
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600481 assert(image_view_state);
482 auto image_view_ci = image_view_state->create_info;
Chris Forbes57989132016-07-26 17:06:10 +1200483
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600484 if ((reqs & DESCRIPTOR_REQ_ALL_VIEW_TYPE_BITS) && (~reqs & (1 << image_view_ci.viewType))) {
Chris Forbes57989132016-07-26 17:06:10 +1200485 // bad view type
486 std::stringstream error_str;
487 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700488 << " requires an image view of type " << string_descriptor_req_view_type(reqs) << " but got "
489 << string_VkImageViewType(image_view_ci.viewType) << ".";
Chris Forbes57989132016-07-26 17:06:10 +1200490 *error = error_str.str();
491 return false;
492 }
493
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700494 auto image_node = GetImageState(device_data_, image_view_ci.image);
Chris Forbes57989132016-07-26 17:06:10 +1200495 assert(image_node);
496
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700497 if ((reqs & DESCRIPTOR_REQ_SINGLE_SAMPLE) && image_node->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Chris Forbes57989132016-07-26 17:06:10 +1200498 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
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700506 if ((reqs & DESCRIPTOR_REQ_MULTI_SAMPLE) && image_node->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Chris Forbes57989132016-07-26 17:06:10 +1200507 std::stringstream error_str;
508 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
509 << " requires bound image to have multiple samples, but got VK_SAMPLE_COUNT_1_BIT.";
510 *error = error_str.str();
511 return false;
512 }
513 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600514 }
515 }
516 }
517 }
518 return true;
519}
Chris Forbes57989132016-07-26 17:06:10 +1200520
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600521// For given bindings, place any update buffers or images into the passed-in unordered_sets
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600522uint32_t cvdescriptorset::DescriptorSet::GetStorageUpdates(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600523 std::unordered_set<VkBuffer> *buffer_set,
524 std::unordered_set<VkImageView> *image_set) const {
525 auto num_updates = 0;
Chris Forbesc7090a82016-07-25 18:10:41 +1200526 for (auto binding_pair : bindings) {
527 auto binding = binding_pair.first;
Tobin Ehlis58c59582016-06-21 12:34:33 -0600528 // If a binding doesn't exist, skip it
529 if (!p_layout_->HasBinding(binding)) {
530 continue;
531 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600532 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
Tobin Ehlis81f17852016-05-05 09:04:33 -0600533 if (descriptors_[start_idx]->IsStorage()) {
534 if (Image == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600535 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600536 if (descriptors_[start_idx + i]->updated) {
537 image_set->insert(static_cast<ImageDescriptor *>(descriptors_[start_idx + i].get())->GetImageView());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600538 num_updates++;
539 }
540 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600541 } else if (TexelBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600542 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600543 if (descriptors_[start_idx + i]->updated) {
544 auto bufferview = static_cast<TexelDescriptor *>(descriptors_[start_idx + i].get())->GetBufferView();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700545 auto bv_state = GetBufferViewState(device_data_, bufferview);
Tobin Ehlis8b872462016-09-14 08:12:08 -0600546 if (bv_state) {
547 buffer_set->insert(bv_state->create_info.buffer);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600548 num_updates++;
549 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600550 }
551 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600552 } else if (GeneralBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600553 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600554 if (descriptors_[start_idx + i]->updated) {
555 buffer_set->insert(static_cast<BufferDescriptor *>(descriptors_[start_idx + i].get())->GetBuffer());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600556 num_updates++;
557 }
558 }
559 }
560 }
561 }
562 return num_updates;
563}
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600564// Set is being deleted or updates so invalidate all bound cmd buffers
565void cvdescriptorset::DescriptorSet::InvalidateBoundCmdBuffers() {
Tobin Ehlisfe5731a2016-11-21 08:31:01 -0700566 core_validation::invalidateCommandBuffers(device_data_, cb_bindings,
Tobin Ehlis2556f5b2016-06-24 17:22:16 -0600567 {reinterpret_cast<uint64_t &>(set_), VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT});
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600568}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600569// Perform write update in given update struct
Tobin Ehlis300888c2016-05-18 13:43:26 -0600570void cvdescriptorset::DescriptorSet::PerformWriteUpdate(const VkWriteDescriptorSet *update) {
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700571 // Perform update on a per-binding basis as consecutive updates roll over to next binding
572 auto descriptors_remaining = update->descriptorCount;
573 auto binding_being_updated = update->dstBinding;
574 auto offset = update->dstArrayElement;
575 while (descriptors_remaining) {
576 uint32_t update_count = std::min(descriptors_remaining, GetDescriptorCountFromBinding(binding_being_updated));
577 auto global_idx = p_layout_->GetGlobalStartIndexFromBinding(binding_being_updated) + offset;
578 // Loop over the updates for a single binding at a time
579 for (uint32_t di = 0; di < update_count; ++di) {
580 descriptors_[global_idx + di]->WriteUpdate(update, di);
581 }
582 // Roll over to next binding in case of consecutive update
583 descriptors_remaining -= update_count;
584 offset = 0;
585 binding_being_updated++;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600586 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700587 if (update->descriptorCount) some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600588
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600589 InvalidateBoundCmdBuffers();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600590}
Tobin Ehlis300888c2016-05-18 13:43:26 -0600591// Validate Copy update
592bool cvdescriptorset::DescriptorSet::ValidateCopyUpdate(const debug_report_data *report_data, const VkCopyDescriptorSet *update,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600593 const DescriptorSet *src_set, UNIQUE_VALIDATION_ERROR_CODE *error_code,
594 std::string *error_msg) {
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600595 // Verify idle ds
596 if (in_use.load()) {
Tobin Ehlis2cb8eb22017-01-03 14:09:57 -0700597 // TODO : Re-using Free Idle error code, need copy update idle error code
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600598 *error_code = VALIDATION_ERROR_00919;
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600599 std::stringstream error_str;
600 error_str << "Cannot call vkUpdateDescriptorSets() to perform copy update on descriptor set " << set_
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700601 << " that is in use by a command buffer";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600602 *error_msg = error_str.str();
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600603 return false;
604 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600605 if (!p_layout_->HasBinding(update->dstBinding)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600606 *error_code = VALIDATION_ERROR_00966;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600607 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700608 error_str << "DescriptorSet " << set_ << " does not have copy update dest binding of " << update->dstBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600609 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600610 return false;
611 }
612 if (!src_set->HasBinding(update->srcBinding)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600613 *error_code = VALIDATION_ERROR_00964;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600614 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700615 error_str << "DescriptorSet " << set_ << " does not have copy update src binding of " << update->srcBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600616 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600617 return false;
618 }
619 // src & dst set bindings are valid
620 // Check bounds of src & dst
621 auto src_start_idx = src_set->GetGlobalStartIndexFromBinding(update->srcBinding) + update->srcArrayElement;
622 if ((src_start_idx + update->descriptorCount) > src_set->GetTotalDescriptorCount()) {
623 // SRC update out of bounds
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600624 *error_code = VALIDATION_ERROR_00965;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600625 std::stringstream error_str;
626 error_str << "Attempting copy update from descriptorSet " << update->srcSet << " binding#" << update->srcBinding
627 << " with offset index of " << src_set->GetGlobalStartIndexFromBinding(update->srcBinding)
628 << " plus update array offset of " << update->srcArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700629 << " descriptors oversteps total number of descriptors in set: " << src_set->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600630 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600631 return false;
632 }
633 auto dst_start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
634 if ((dst_start_idx + update->descriptorCount) > p_layout_->GetTotalDescriptorCount()) {
635 // DST update out of bounds
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600636 *error_code = VALIDATION_ERROR_00967;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600637 std::stringstream error_str;
638 error_str << "Attempting copy update to descriptorSet " << set_ << " binding#" << update->dstBinding
639 << " with offset index of " << p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding)
640 << " plus update array offset of " << update->dstArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700641 << " descriptors oversteps total number of descriptors in set: " << p_layout_->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600642 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600643 return false;
644 }
645 // Check that types match
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600646 // TODO : Base default error case going from here is VALIDATION_ERROR_00968 which covers all consistency issues, need more
647 // fine-grained error codes
648 *error_code = VALIDATION_ERROR_00968;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600649 auto src_type = src_set->GetTypeFromBinding(update->srcBinding);
650 auto dst_type = p_layout_->GetTypeFromBinding(update->dstBinding);
651 if (src_type != dst_type) {
652 std::stringstream error_str;
653 error_str << "Attempting copy update to descriptorSet " << set_ << " binding #" << update->dstBinding << " with type "
654 << string_VkDescriptorType(dst_type) << " from descriptorSet " << src_set->GetSet() << " binding #"
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700655 << update->srcBinding << " with type " << string_VkDescriptorType(src_type) << ". Types do not match";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600656 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600657 return false;
658 }
659 // Verify consistency of src & dst bindings if update crosses binding boundaries
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600660 if ((!src_set->GetLayout()->VerifyUpdateConsistency(update->srcBinding, update->srcArrayElement, update->descriptorCount,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600661 "copy update from", src_set->GetSet(), error_msg)) ||
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600662 (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "copy update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600663 set_, error_msg))) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600664 return false;
665 }
Tobin Ehlisd41e7b62016-05-19 07:56:18 -0600666 // First make sure source descriptors are updated
667 for (uint32_t i = 0; i < update->descriptorCount; ++i) {
668 if (!src_set->descriptors_[src_start_idx + i]) {
669 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700670 error_str << "Attempting copy update from descriptorSet " << src_set << " binding #" << update->srcBinding
671 << " but descriptor at array offset " << update->srcArrayElement + i << " has not been updated";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600672 *error_msg = error_str.str();
Tobin Ehlisd41e7b62016-05-19 07:56:18 -0600673 return false;
674 }
675 }
676 // Update parameters all look good and descriptor updated so verify update contents
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700677 if (!VerifyCopyUpdateContents(update, src_set, src_type, src_start_idx, error_code, error_msg)) return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -0600678
679 // All checks passed so update is good
680 return true;
681}
682// Perform Copy update
683void cvdescriptorset::DescriptorSet::PerformCopyUpdate(const VkCopyDescriptorSet *update, const DescriptorSet *src_set) {
Tobin Ehlis300888c2016-05-18 13:43:26 -0600684 auto src_start_idx = src_set->GetGlobalStartIndexFromBinding(update->srcBinding) + update->srcArrayElement;
685 auto dst_start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600686 // Update parameters all look good so perform update
687 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Tobin Ehlis300888c2016-05-18 13:43:26 -0600688 descriptors_[dst_start_idx + di]->CopyUpdate(src_set->descriptors_[src_start_idx + di].get());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600689 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700690 if (update->descriptorCount) some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600691
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600692 InvalidateBoundCmdBuffers();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600693}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600694
Tobin Ehlisf9519102016-08-17 09:49:13 -0600695// Bind cb_node to this set and this set to cb_node.
696// Prereq: This should be called for a set that has been confirmed to be active for the given cb_node, meaning it's going
697// to be used in a draw by the given cb_node
Tobin Ehlis276d3d32016-12-21 09:21:06 -0700698void cvdescriptorset::DescriptorSet::BindCommandBuffer(GLOBAL_CB_NODE *cb_node,
Tobin Ehlis022528b2016-12-29 12:22:32 -0700699 const std::map<uint32_t, descriptor_req> &binding_req_map) {
Tobin Ehlis9252c2b2016-07-21 14:40:22 -0600700 // bind cb to this descriptor set
701 cb_bindings.insert(cb_node);
Tobin Ehlis7ca20be2016-10-12 15:09:16 -0600702 // Add bindings for descriptor set, the set's pool, and individual objects in the set
Tobin Ehlis9252c2b2016-07-21 14:40:22 -0600703 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 -0600704 pool_state_->cb_bindings.insert(cb_node);
705 cb_node->object_bindings.insert(
706 {reinterpret_cast<uint64_t &>(pool_state_->pool), VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT});
Tobin Ehlisf9519102016-08-17 09:49:13 -0600707 // For the active slots, use set# to look up descriptorSet from boundDescriptorSets, and bind all of that descriptor set's
708 // resources
Tobin Ehlis022528b2016-12-29 12:22:32 -0700709 for (auto binding_req_pair : binding_req_map) {
710 auto binding = binding_req_pair.first;
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600711 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
712 auto end_idx = p_layout_->GetGlobalEndIndexFromBinding(binding);
713 for (uint32_t i = start_idx; i <= end_idx; ++i) {
714 descriptors_[i]->BindCommandBuffer(device_data_, cb_node);
715 }
716 }
Tobin Ehlis9252c2b2016-07-21 14:40:22 -0600717}
718
Tobin Ehlis300888c2016-05-18 13:43:26 -0600719cvdescriptorset::SamplerDescriptor::SamplerDescriptor() : sampler_(VK_NULL_HANDLE), immutable_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600720 updated = false;
721 descriptor_class = PlainSampler;
722};
723
Tobin Ehlis300888c2016-05-18 13:43:26 -0600724cvdescriptorset::SamplerDescriptor::SamplerDescriptor(const VkSampler *immut) : sampler_(VK_NULL_HANDLE), immutable_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600725 updated = false;
726 descriptor_class = PlainSampler;
727 if (immut) {
728 sampler_ = *immut;
729 immutable_ = true;
730 updated = true;
731 }
732}
Tobin Ehlise2f80292016-06-02 10:08:53 -0600733// Validate given sampler. Currently this only checks to make sure it exists in the samplerMap
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700734bool cvdescriptorset::ValidateSampler(const VkSampler sampler, const layer_data *dev_data) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700735 return (GetSamplerState(dev_data, sampler) != nullptr);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600736}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600737
Tobin Ehlis554bf382016-05-24 11:14:43 -0600738bool cvdescriptorset::ValidateImageUpdate(VkImageView image_view, VkImageLayout image_layout, VkDescriptorType type,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700739 const layer_data *dev_data, UNIQUE_VALIDATION_ERROR_CODE *error_code,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600740 std::string *error_msg) {
741 // TODO : Defaulting to 00943 for all cases here. Need to create new error codes for various cases.
742 *error_code = VALIDATION_ERROR_00943;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700743 auto iv_state = GetImageViewState(dev_data, image_view);
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600744 if (!iv_state) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600745 std::stringstream error_str;
746 error_str << "Invalid VkImageView: " << image_view;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600747 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600748 return false;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600749 }
Tobin Ehlis81280962016-07-20 14:04:20 -0600750 // 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 -0600751 // Validate that imageLayout is compatible with aspect_mask and image format
752 // and validate that image usage bits are correct for given usage
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600753 VkImageAspectFlags aspect_mask = iv_state->create_info.subresourceRange.aspectMask;
754 VkImage image = iv_state->create_info.image;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600755 VkFormat format = VK_FORMAT_MAX_ENUM;
756 VkImageUsageFlags usage = 0;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700757 auto image_node = GetImageState(dev_data, image);
Tobin Ehlis1c9c55f2016-06-02 11:49:22 -0600758 if (image_node) {
759 format = image_node->createInfo.format;
760 usage = image_node->createInfo.usage;
Tobin Ehlis029d2fe2016-09-21 09:19:15 -0600761 // Validate that memory is bound to image
Tobin Ehlis2cb8eb22017-01-03 14:09:57 -0700762 // TODO: This should have its own valid usage id apart from 2524 which is from CreateImageView case. The only
763 // the error here occurs is if memory bound to a created imageView has been freed.
Tobin Ehlise1995fc2016-12-22 12:45:09 -0700764 if (ValidateMemoryIsBoundToImage(dev_data, image_node, "vkUpdateDescriptorSets()", VALIDATION_ERROR_02524)) {
Tobin Ehlisde1a0f92016-12-22 12:26:32 -0700765 *error_code = VALIDATION_ERROR_02524;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600766 *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 Ehlisb2e1e2c2017-02-08 09:16:32 -0700771 auto swapchain = GetSwapchainFromImage(dev_data, image);
Tobin Ehlis969a5262016-06-02 12:13:32 -0600772 if (swapchain) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700773 auto swapchain_node = GetSwapchainNode(dev_data, swapchain);
Tobin Ehlis4e380592016-06-02 12:41:47 -0600774 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?
Dave Houlton1d2022c2017-03-29 11:43:58 -0600788 bool ds = FormatIsDepthOrStencil(format);
Tobin Ehlis1809f912016-05-25 09:24:36 -0600789 switch (image_layout) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700790 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 Ehlis1809f912016-05-25 09:24:36 -0600793 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700794 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 Ehlis1809f912016-05-25 09:24:36 -0600797 return false;
798 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700799 // 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.";
805 *error_msg = error_str.str();
806 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
Tobin Ehlisbbf3f912016-06-15 13:03:58 -0600812 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;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700816 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 Ehlisbbf3f912016-06-15 13:03:58 -0600818 return false;
819 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700820 } 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";
825 *error_msg = error_str.str();
826 return false;
Tobin Ehlisbbf3f912016-06-15 13:03:58 -0600827 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700828 // 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.";
833 *error_msg = error_str.str();
834 return false;
835 }
836 break;
837 default:
838 // For other layouts if the source is depth/stencil image, both aspect bits must not be set
839 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.";
850 *error_msg = error_str.str();
851 return false;
852 }
853 }
854 }
855 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600856 }
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) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700865 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;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600871 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700872 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
873 if (!(usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
874 error_usage_bit = "VK_IMAGE_USAGE_STORAGE_BIT";
875 } 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
879 << "ImageView (" << image_view << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type is being updated with layout "
880 << string_VkImageLayout(image_layout)
881 << " but according to spec section 13.1 Descriptor Types, 'Load and store operations on storage images can "
882 "only be done on images in VK_IMAGE_LAYOUT_GENERAL layout.'";
883 *error_msg = error_str.str();
884 return false;
885 }
886 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600887 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700888 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT: {
889 if (!(usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) {
890 error_usage_bit = "VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT";
891 }
892 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600893 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700894 default:
895 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600896 }
897 if (!error_usage_bit.empty()) {
898 std::stringstream error_str;
899 error_str << "ImageView (" << image_view << ") with usage mask 0x" << usage
900 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
901 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600902 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600903 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600904 }
905 return true;
906}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600907
Tobin Ehlis300888c2016-05-18 13:43:26 -0600908void cvdescriptorset::SamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
909 sampler_ = update->pImageInfo[index].sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600910 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600911}
912
Tobin Ehlis300888c2016-05-18 13:43:26 -0600913void cvdescriptorset::SamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600914 if (!immutable_) {
915 auto update_sampler = static_cast<const SamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600916 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600917 }
918 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600919}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600920
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700921void cvdescriptorset::SamplerDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600922 if (!immutable_) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700923 auto sampler_state = GetSamplerState(dev_data, sampler_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700924 if (sampler_state) 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 Ehlis58c884f2017-02-08 12:15:27 -0700965void cvdescriptorset::ImageSamplerDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -0600966 // First add binding for any non-immutable sampler
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600967 if (!immutable_) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700968 auto sampler_state = GetSamplerState(dev_data, sampler_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700969 if (sampler_state) core_validation::AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600970 }
Tobin Ehlis81e46372016-08-17 13:33:44 -0600971 // Add binding for image
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700972 auto iv_state = GetImageViewState(dev_data, image_view_);
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600973 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -0600974 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -0600975 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600976}
977
Tobin Ehlis300888c2016-05-18 13:43:26 -0600978cvdescriptorset::ImageDescriptor::ImageDescriptor(const VkDescriptorType type)
979 : storage_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600980 updated = false;
981 descriptor_class = Image;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700982 if (VK_DESCRIPTOR_TYPE_STORAGE_IMAGE == type) storage_ = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600983};
984
Tobin Ehlis300888c2016-05-18 13:43:26 -0600985void cvdescriptorset::ImageDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600986 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600987 const auto &image_info = update->pImageInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -0600988 image_view_ = image_info.imageView;
989 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600990}
991
Tobin Ehlis300888c2016-05-18 13:43:26 -0600992void cvdescriptorset::ImageDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600993 auto image_view = static_cast<const ImageDescriptor *>(src)->image_view_;
994 auto image_layout = static_cast<const ImageDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600995 updated = true;
996 image_view_ = image_view;
997 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600998}
999
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001000void cvdescriptorset::ImageDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -06001001 // Add binding for image
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001002 auto iv_state = GetImageViewState(dev_data, image_view_);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001003 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -06001004 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001005 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001006}
1007
Tobin Ehlis300888c2016-05-18 13:43:26 -06001008cvdescriptorset::BufferDescriptor::BufferDescriptor(const VkDescriptorType type)
1009 : storage_(false), dynamic_(false), buffer_(VK_NULL_HANDLE), offset_(0), range_(0) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001010 updated = false;
1011 descriptor_class = GeneralBuffer;
1012 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
1013 dynamic_ = true;
1014 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type) {
1015 storage_ = true;
1016 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
1017 dynamic_ = true;
1018 storage_ = true;
1019 }
1020}
Tobin Ehlis300888c2016-05-18 13:43:26 -06001021void cvdescriptorset::BufferDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001022 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001023 const auto &buffer_info = update->pBufferInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001024 buffer_ = buffer_info.buffer;
1025 offset_ = buffer_info.offset;
1026 range_ = buffer_info.range;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001027}
1028
Tobin Ehlis300888c2016-05-18 13:43:26 -06001029void cvdescriptorset::BufferDescriptor::CopyUpdate(const Descriptor *src) {
1030 auto buff_desc = static_cast<const BufferDescriptor *>(src);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001031 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001032 buffer_ = buff_desc->buffer_;
1033 offset_ = buff_desc->offset_;
1034 range_ = buff_desc->range_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001035}
1036
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001037void cvdescriptorset::BufferDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001038 auto buffer_node = GetBufferState(dev_data, buffer_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001039 if (buffer_node) core_validation::AddCommandBufferBindingBuffer(dev_data, cb_node, buffer_node);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001040}
1041
Tobin Ehlis300888c2016-05-18 13:43:26 -06001042cvdescriptorset::TexelDescriptor::TexelDescriptor(const VkDescriptorType type) : buffer_view_(VK_NULL_HANDLE), storage_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001043 updated = false;
1044 descriptor_class = TexelBuffer;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001045 if (VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER == type) storage_ = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001046};
Tobin Ehlis56a30942016-05-19 08:00:00 -06001047
Tobin Ehlis300888c2016-05-18 13:43:26 -06001048void cvdescriptorset::TexelDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001049 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001050 buffer_view_ = update->pTexelBufferView[index];
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001051}
1052
Tobin Ehlis300888c2016-05-18 13:43:26 -06001053void cvdescriptorset::TexelDescriptor::CopyUpdate(const Descriptor *src) {
1054 updated = true;
1055 buffer_view_ = static_cast<const TexelDescriptor *>(src)->buffer_view_;
1056}
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001057
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001058void cvdescriptorset::TexelDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001059 auto bv_state = GetBufferViewState(dev_data, buffer_view_);
Tobin Ehlis8b872462016-09-14 08:12:08 -06001060 if (bv_state) {
Tobin Ehlis2515c0e2016-09-28 07:12:28 -06001061 core_validation::AddCommandBufferBindingBufferView(dev_data, cb_node, bv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001062 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001063}
1064
Tobin Ehlis300888c2016-05-18 13:43:26 -06001065// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1066// sets, and then calls their respective Validate[Write|Copy]Update functions.
1067// If the update hits an issue for which the callback returns "true", meaning that the call down the chain should
1068// be skipped, then true is returned.
1069// If there is no issue with the update, then false is returned.
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001070bool cvdescriptorset::ValidateUpdateDescriptorSets(const debug_report_data *report_data, const layer_data *dev_data,
1071 uint32_t write_count, const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001072 const VkCopyDescriptorSet *p_cds) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001073 bool skip_call = false;
1074 // Validate Write updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001075 for (uint32_t i = 0; i < write_count; i++) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001076 auto dest_set = p_wds[i].dstSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001077 auto set_node = core_validation::GetSetNode(dev_data, dest_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001078 if (!set_node) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001079 skip_call |=
1080 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 -06001081 reinterpret_cast<uint64_t &>(dest_set), __LINE__, DRAWSTATE_INVALID_DESCRIPTOR_SET, "DS",
Tobin Ehlis300888c2016-05-18 13:43:26 -06001082 "Cannot call vkUpdateDescriptorSets() on descriptor set 0x%" PRIxLEAST64 " that has not been allocated.",
1083 reinterpret_cast<uint64_t &>(dest_set));
1084 } else {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001085 UNIQUE_VALIDATION_ERROR_CODE error_code;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001086 std::string error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001087 if (!set_node->ValidateWriteUpdate(report_data, &p_wds[i], &error_code, &error_str)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001088 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 -06001089 reinterpret_cast<uint64_t &>(dest_set), __LINE__, error_code, "DS",
Tobin Ehlis300888c2016-05-18 13:43:26 -06001090 "vkUpdateDescriptorsSets() failed write update validation for Descriptor Set 0x%" PRIx64
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001091 " with error: %s. %s",
1092 reinterpret_cast<uint64_t &>(dest_set), error_str.c_str(), validation_error_map[error_code]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001093 }
1094 }
1095 }
1096 // Now validate copy updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001097 for (uint32_t i = 0; i < copy_count; ++i) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001098 auto dst_set = p_cds[i].dstSet;
1099 auto src_set = p_cds[i].srcSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001100 auto src_node = core_validation::GetSetNode(dev_data, src_set);
1101 auto dst_node = core_validation::GetSetNode(dev_data, dst_set);
Tobin Ehlisa1712752017-01-04 09:41:47 -07001102 // Object_tracker verifies that src & dest descriptor set are valid
1103 assert(src_node);
1104 assert(dst_node);
1105 UNIQUE_VALIDATION_ERROR_CODE error_code;
1106 std::string error_str;
1107 if (!dst_node->ValidateCopyUpdate(report_data, &p_cds[i], src_node, &error_code, &error_str)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001108 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
Tobin Ehlisa1712752017-01-04 09:41:47 -07001109 reinterpret_cast<uint64_t &>(dst_set), __LINE__, error_code, "DS",
1110 "vkUpdateDescriptorsSets() failed copy update from Descriptor Set 0x%" PRIx64
1111 " to Descriptor Set 0x%" PRIx64 " with error: %s. %s",
1112 reinterpret_cast<uint64_t &>(src_set), reinterpret_cast<uint64_t &>(dst_set), error_str.c_str(),
1113 validation_error_map[error_code]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001114 }
1115 }
1116 return skip_call;
1117}
1118// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1119// sets, and then calls their respective Perform[Write|Copy]Update functions.
1120// Prerequisite : ValidateUpdateDescriptorSets() should be called and return "false" prior to calling PerformUpdateDescriptorSets()
1121// with the same set of updates.
1122// This is split from the validate code to allow validation prior to calling down the chain, and then update after
1123// calling down the chain.
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001124void cvdescriptorset::PerformUpdateDescriptorSets(const layer_data *dev_data, uint32_t write_count,
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001125 const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
1126 const VkCopyDescriptorSet *p_cds) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001127 // Write updates first
1128 uint32_t i = 0;
1129 for (i = 0; i < write_count; ++i) {
1130 auto dest_set = p_wds[i].dstSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001131 auto set_node = core_validation::GetSetNode(dev_data, dest_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001132 if (set_node) {
1133 set_node->PerformWriteUpdate(&p_wds[i]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001134 }
1135 }
1136 // Now copy updates
1137 for (i = 0; i < copy_count; ++i) {
1138 auto dst_set = p_cds[i].dstSet;
1139 auto src_set = p_cds[i].srcSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001140 auto src_node = core_validation::GetSetNode(dev_data, src_set);
1141 auto dst_node = core_validation::GetSetNode(dev_data, dst_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001142 if (src_node && dst_node) {
1143 dst_node->PerformCopyUpdate(&p_cds[i], src_node);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001144 }
1145 }
1146}
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001147// This helper function carries out the state updates for descriptor updates peformed via update templates. It basically collects
1148// data and leverages the PerformUpdateDescriptor helper functions to do this.
1149void cvdescriptorset::PerformUpdateDescriptorSetsWithTemplateKHR(layer_data *device_data, VkDescriptorSet descriptorSet,
1150 std::unique_ptr<TEMPLATE_STATE> const &template_state,
1151 const void *pData) {
1152 auto const &create_info = template_state->create_info;
1153
1154 // Create a vector of write structs
1155 std::vector<VkWriteDescriptorSet> desc_writes;
1156 auto layout_obj = GetDescriptorSetLayout(device_data, create_info.descriptorSetLayout);
1157
1158 // Create a WriteDescriptorSet struct for each template update entry
1159 for (uint32_t i = 0; i < create_info.descriptorUpdateEntryCount; i++) {
1160 auto binding_count = layout_obj->GetDescriptorCountFromBinding(create_info.pDescriptorUpdateEntries[i].dstBinding);
1161 auto binding_being_updated = create_info.pDescriptorUpdateEntries[i].dstBinding;
1162 auto dst_array_element = create_info.pDescriptorUpdateEntries[i].dstArrayElement;
1163
1164 for (uint32_t j = 0; j < create_info.pDescriptorUpdateEntries[i].descriptorCount; j++) {
1165 desc_writes.emplace_back();
1166 auto &write_entry = desc_writes.back();
1167
1168 size_t offset = create_info.pDescriptorUpdateEntries[i].offset + j * create_info.pDescriptorUpdateEntries[i].stride;
1169 char *update_entry = (char *)(pData) + offset;
1170
1171 if (dst_array_element >= binding_count) {
1172 dst_array_element = 0;
Mark Lobodzinski4aa479d2017-03-10 09:14:00 -07001173 binding_being_updated = layout_obj->GetNextValidBinding(binding_being_updated);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001174 }
1175
1176 write_entry.sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
1177 write_entry.pNext = NULL;
1178 write_entry.dstSet = descriptorSet;
1179 write_entry.dstBinding = binding_being_updated;
1180 write_entry.dstArrayElement = dst_array_element;
1181 write_entry.descriptorCount = 1;
1182 write_entry.descriptorType = create_info.pDescriptorUpdateEntries[i].descriptorType;
1183
1184 switch (create_info.pDescriptorUpdateEntries[i].descriptorType) {
1185 case VK_DESCRIPTOR_TYPE_SAMPLER:
1186 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
1187 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1188 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
1189 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
1190 write_entry.pImageInfo = reinterpret_cast<VkDescriptorImageInfo *>(update_entry);
1191 break;
1192
1193 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1194 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1195 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1196 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1197 write_entry.pBufferInfo = reinterpret_cast<VkDescriptorBufferInfo *>(update_entry);
1198 break;
1199
1200 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1201 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1202 write_entry.pTexelBufferView = reinterpret_cast<VkBufferView *>(update_entry);
1203 break;
1204 default:
1205 assert(0);
1206 break;
1207 }
1208 dst_array_element++;
1209 }
1210 }
1211 PerformUpdateDescriptorSets(device_data, static_cast<uint32_t>(desc_writes.size()), desc_writes.data(), 0, NULL);
1212}
Tobin Ehlis300888c2016-05-18 13:43:26 -06001213// Validate the state for a given write update but don't actually perform the update
1214// If an error would occur for this update, return false and fill in details in error_msg string
1215bool cvdescriptorset::DescriptorSet::ValidateWriteUpdate(const debug_report_data *report_data, const VkWriteDescriptorSet *update,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001216 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001217 // Verify idle ds
1218 if (in_use.load()) {
Tobin Ehlis2cb8eb22017-01-03 14:09:57 -07001219 // TODO : Re-using Free Idle error code, need write update idle error code
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001220 *error_code = VALIDATION_ERROR_00919;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001221 std::stringstream error_str;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001222 error_str << "Cannot call vkUpdateDescriptorSets() to perform write update on descriptor set " << set_
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001223 << " that is in use by a command buffer";
Tobin Ehlis300888c2016-05-18 13:43:26 -06001224 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001225 return false;
1226 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001227 // Verify dst binding exists
1228 if (!p_layout_->HasBinding(update->dstBinding)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001229 *error_code = VALIDATION_ERROR_00936;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001230 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001231 error_str << "DescriptorSet " << set_ << " does not have binding " << update->dstBinding;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001232 *error_msg = error_str.str();
1233 return false;
Tobin Ehlis59a5efc2016-11-21 09:41:57 -07001234 } else {
1235 // Make sure binding isn't empty
1236 if (0 == p_layout_->GetDescriptorCountFromBinding(update->dstBinding)) {
1237 *error_code = VALIDATION_ERROR_02348;
1238 std::stringstream error_str;
1239 error_str << "DescriptorSet " << set_ << " cannot updated binding " << update->dstBinding << " that has 0 descriptors";
1240 *error_msg = error_str.str();
1241 return false;
1242 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001243 }
1244 // We know that binding is valid, verify update and do update on each descriptor
1245 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
1246 auto type = p_layout_->GetTypeFromBinding(update->dstBinding);
1247 if (type != update->descriptorType) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001248 *error_code = VALIDATION_ERROR_00937;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001249 std::stringstream error_str;
1250 error_str << "Attempting write update to descriptor set " << set_ << " binding #" << update->dstBinding << " with type "
1251 << string_VkDescriptorType(type) << " but update type is " << string_VkDescriptorType(update->descriptorType);
1252 *error_msg = error_str.str();
1253 return false;
1254 }
Tobin Ehlis7b402352016-12-15 07:51:20 -07001255 if (update->descriptorCount > (descriptors_.size() - start_idx)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001256 *error_code = VALIDATION_ERROR_00938;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001257 std::stringstream error_str;
1258 error_str << "Attempting write update to descriptor set " << set_ << " binding #" << update->dstBinding << " with "
Tobin Ehlis7b402352016-12-15 07:51:20 -07001259 << descriptors_.size() - start_idx
Tobin Ehlisf922ef82016-11-30 10:19:14 -07001260 << " descriptors in that binding and all successive bindings of the set, but update of "
1261 << update->descriptorCount << " descriptors combined with update array element offset of "
1262 << update->dstArrayElement << " oversteps the available number of consecutive descriptors";
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001263 *error_msg = error_str.str();
1264 return false;
1265 }
1266 // Verify consecutive bindings match (if needed)
1267 if (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "write update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001268 set_, error_msg)) {
Tobin Ehlis48fbd692017-01-04 09:17:01 -07001269 // TODO : Should break out "consecutive binding updates" language into valid usage statements
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001270 *error_code = VALIDATION_ERROR_00938;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001271 return false;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001272 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001273 // Update is within bounds and consistent so last step is to validate update contents
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001274 if (!VerifyWriteUpdateContents(update, start_idx, error_code, error_msg)) {
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001275 std::stringstream error_str;
1276 error_str << "Write update to descriptor in set " << set_ << " binding #" << update->dstBinding
1277 << " failed with error message: " << error_msg->c_str();
1278 *error_msg = error_str.str();
1279 return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001280 }
1281 // All checks passed, update is clean
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001282 return true;
Tobin Ehlis03d61de2016-05-17 08:31:46 -06001283}
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001284// For the given buffer, verify that its creation parameters are appropriate for the given type
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001285// 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 -07001286bool cvdescriptorset::DescriptorSet::ValidateBufferUsage(BUFFER_STATE const *buffer_node, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001287 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) const {
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001288 // Verify that usage bits set correctly for given type
Tobin Ehlis94bc5d22016-06-02 07:46:52 -06001289 auto usage = buffer_node->createInfo.usage;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001290 std::string error_usage_bit;
1291 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001292 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1293 if (!(usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT)) {
1294 *error_code = VALIDATION_ERROR_00950;
1295 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT";
1296 }
1297 break;
1298 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1299 if (!(usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT)) {
1300 *error_code = VALIDATION_ERROR_00951;
1301 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT";
1302 }
1303 break;
1304 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1305 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1306 if (!(usage & VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT)) {
1307 *error_code = VALIDATION_ERROR_00946;
1308 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT";
1309 }
1310 break;
1311 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1312 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1313 if (!(usage & VK_BUFFER_USAGE_STORAGE_BUFFER_BIT)) {
1314 *error_code = VALIDATION_ERROR_00947;
1315 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_BUFFER_BIT";
1316 }
1317 break;
1318 default:
1319 break;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001320 }
1321 if (!error_usage_bit.empty()) {
1322 std::stringstream error_str;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001323 error_str << "Buffer (" << buffer_node->buffer << ") with usage mask 0x" << usage
1324 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
1325 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001326 *error_msg = error_str.str();
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001327 return false;
1328 }
1329 return true;
1330}
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001331// For buffer descriptor updates, verify the buffer usage and VkDescriptorBufferInfo struct which includes:
1332// 1. buffer is valid
1333// 2. buffer was created with correct usage flags
1334// 3. offset is less than buffer size
1335// 4. range is either VK_WHOLE_SIZE or falls in (0, (buffer size - offset)]
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001336// 5. range and offset are within the device's limits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001337// 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 -06001338bool cvdescriptorset::DescriptorSet::ValidateBufferUpdate(VkDescriptorBufferInfo const *buffer_info, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001339 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) const {
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001340 // First make sure that buffer is valid
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001341 auto buffer_node = GetBufferState(device_data_, buffer_info->buffer);
Tobin Ehlisfa8b6182016-12-22 13:40:45 -07001342 // Any invalid buffer should already be caught by object_tracker
1343 assert(buffer_node);
Tobin Ehlise1995fc2016-12-22 12:45:09 -07001344 if (ValidateMemoryIsBoundToBuffer(device_data_, buffer_node, "vkUpdateDescriptorSets()", VALIDATION_ERROR_02525)) {
Tobin Ehlisde1a0f92016-12-22 12:26:32 -07001345 *error_code = VALIDATION_ERROR_02525;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001346 *error_msg = "No memory bound to buffer.";
Tobin Ehlis81280962016-07-20 14:04:20 -06001347 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001348 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001349 // Verify usage bits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001350 if (!ValidateBufferUsage(buffer_node, type, error_code, error_msg)) {
1351 // error_msg will have been updated by ValidateBufferUsage()
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001352 return false;
1353 }
1354 // offset must be less than buffer size
Jeremy Hayesd1a6a822017-03-09 14:39:45 -07001355 if (buffer_info->offset >= buffer_node->createInfo.size) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001356 *error_code = VALIDATION_ERROR_00959;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001357 std::stringstream error_str;
Jeremy Hayesd1a6a822017-03-09 14:39:45 -07001358 error_str << "VkDescriptorBufferInfo offset of " << buffer_info->offset << " is greater than or equal to buffer "
1359 << buffer_node->buffer << " size of " << buffer_node->createInfo.size;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001360 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001361 return false;
1362 }
1363 if (buffer_info->range != VK_WHOLE_SIZE) {
1364 // Range must be VK_WHOLE_SIZE or > 0
1365 if (!buffer_info->range) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001366 *error_code = VALIDATION_ERROR_00960;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001367 std::stringstream error_str;
1368 error_str << "VkDescriptorBufferInfo range is not VK_WHOLE_SIZE and is zero, which is not allowed.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001369 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001370 return false;
1371 }
1372 // Range must be VK_WHOLE_SIZE or <= (buffer size - offset)
1373 if (buffer_info->range > (buffer_node->createInfo.size - buffer_info->offset)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001374 *error_code = VALIDATION_ERROR_00961;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001375 std::stringstream error_str;
1376 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range << " which is greater than buffer size ("
1377 << buffer_node->createInfo.size << ") minus requested offset of " << buffer_info->offset;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001378 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001379 return false;
1380 }
1381 }
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001382 // Check buffer update sizes against device limits
1383 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER == type || VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
1384 auto max_ub_range = limits_.maxUniformBufferRange;
1385 // TODO : If range is WHOLE_SIZE, need to make sure underlying buffer size doesn't exceed device max
1386 if (buffer_info->range != VK_WHOLE_SIZE && buffer_info->range > max_ub_range) {
1387 *error_code = VALIDATION_ERROR_00948;
1388 std::stringstream error_str;
1389 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range
1390 << " which is greater than this device's maxUniformBufferRange (" << max_ub_range << ")";
1391 *error_msg = error_str.str();
1392 return false;
1393 }
1394 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type || VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
1395 auto max_sb_range = limits_.maxStorageBufferRange;
1396 // TODO : If range is WHOLE_SIZE, need to make sure underlying buffer size doesn't exceed device max
1397 if (buffer_info->range != VK_WHOLE_SIZE && buffer_info->range > max_sb_range) {
1398 *error_code = VALIDATION_ERROR_00949;
1399 std::stringstream error_str;
1400 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range
1401 << " which is greater than this device's maxStorageBufferRange (" << max_sb_range << ")";
1402 *error_msg = error_str.str();
1403 return false;
1404 }
1405 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001406 return true;
1407}
1408
Tobin Ehlis300888c2016-05-18 13:43:26 -06001409// Verify that the contents of the update are ok, but don't perform actual update
1410bool cvdescriptorset::DescriptorSet::VerifyWriteUpdateContents(const VkWriteDescriptorSet *update, const uint32_t index,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001411 UNIQUE_VALIDATION_ERROR_CODE *error_code,
1412 std::string *error_msg) const {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001413 switch (update->descriptorType) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001414 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
1415 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1416 // Validate image
1417 auto image_view = update->pImageInfo[di].imageView;
1418 auto image_layout = update->pImageInfo[di].imageLayout;
1419 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001420 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001421 error_str << "Attempted write update to combined image sampler descriptor failed due to: "
1422 << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001423 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001424 return false;
1425 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001426 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001427 // Intentional fall-through to validate sampler
Tobin Ehlis300888c2016-05-18 13:43:26 -06001428 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001429 case VK_DESCRIPTOR_TYPE_SAMPLER: {
1430 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1431 if (!descriptors_[index + di].get()->IsImmutableSampler()) {
1432 if (!ValidateSampler(update->pImageInfo[di].sampler, device_data_)) {
1433 *error_code = VALIDATION_ERROR_00942;
1434 std::stringstream error_str;
1435 error_str << "Attempted write update to sampler descriptor with invalid sampler: "
1436 << update->pImageInfo[di].sampler << ".";
1437 *error_msg = error_str.str();
1438 return false;
1439 }
1440 } else {
1441 // TODO : Warn here
1442 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001443 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001444 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001445 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001446 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1447 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
1448 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
1449 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1450 auto image_view = update->pImageInfo[di].imageView;
1451 auto image_layout = update->pImageInfo[di].imageLayout;
1452 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, error_code, error_msg)) {
1453 std::stringstream error_str;
1454 error_str << "Attempted write update to image descriptor failed due to: " << error_msg->c_str();
1455 *error_msg = error_str.str();
1456 return false;
1457 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001458 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001459 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001460 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001461 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1462 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER: {
1463 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1464 auto buffer_view = update->pTexelBufferView[di];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001465 auto bv_state = GetBufferViewState(device_data_, buffer_view);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001466 if (!bv_state) {
1467 *error_code = VALIDATION_ERROR_00940;
1468 std::stringstream error_str;
1469 error_str << "Attempted write update to texel buffer descriptor with invalid buffer view: " << buffer_view;
1470 *error_msg = error_str.str();
1471 return false;
1472 }
1473 auto buffer = bv_state->create_info.buffer;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001474 if (!ValidateBufferUsage(GetBufferState(device_data_, buffer), update->descriptorType, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001475 std::stringstream error_str;
1476 error_str << "Attempted write update to texel buffer descriptor failed due to: " << error_msg->c_str();
1477 *error_msg = error_str.str();
1478 return false;
1479 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001480 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001481 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001482 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001483 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1484 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1485 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1486 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC: {
1487 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1488 if (!ValidateBufferUpdate(update->pBufferInfo + di, update->descriptorType, error_code, error_msg)) {
1489 std::stringstream error_str;
1490 error_str << "Attempted write update to buffer descriptor failed due to: " << error_msg->c_str();
1491 *error_msg = error_str.str();
1492 return false;
1493 }
1494 }
1495 break;
1496 }
1497 default:
1498 assert(0); // We've already verified update type so should never get here
1499 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001500 }
1501 // All checks passed so update contents are good
1502 return true;
1503}
1504// Verify that the contents of the update are ok, but don't perform actual update
1505bool cvdescriptorset::DescriptorSet::VerifyCopyUpdateContents(const VkCopyDescriptorSet *update, const DescriptorSet *src_set,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001506 VkDescriptorType type, uint32_t index,
1507 UNIQUE_VALIDATION_ERROR_CODE *error_code,
1508 std::string *error_msg) const {
1509 // Note : Repurposing some Write update error codes here as specific details aren't called out for copy updates like they are
1510 // for write updates
Tobin Ehlis300888c2016-05-18 13:43:26 -06001511 switch (src_set->descriptors_[index]->descriptor_class) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001512 case PlainSampler: {
1513 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1514 if (!src_set->descriptors_[index + di]->IsImmutableSampler()) {
1515 auto update_sampler = static_cast<SamplerDescriptor *>(src_set->descriptors_[index + di].get())->GetSampler();
1516 if (!ValidateSampler(update_sampler, device_data_)) {
1517 *error_code = VALIDATION_ERROR_00942;
1518 std::stringstream error_str;
1519 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
1520 *error_msg = error_str.str();
1521 return false;
1522 }
1523 } else {
1524 // TODO : Warn here
1525 }
1526 }
1527 break;
1528 }
1529 case ImageSampler: {
1530 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1531 auto img_samp_desc = static_cast<const ImageSamplerDescriptor *>(src_set->descriptors_[index + di].get());
1532 // First validate sampler
1533 if (!img_samp_desc->IsImmutableSampler()) {
1534 auto update_sampler = img_samp_desc->GetSampler();
1535 if (!ValidateSampler(update_sampler, device_data_)) {
1536 *error_code = VALIDATION_ERROR_00942;
1537 std::stringstream error_str;
1538 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
1539 *error_msg = error_str.str();
1540 return false;
1541 }
1542 } else {
1543 // TODO : Warn here
1544 }
1545 // Validate image
1546 auto image_view = img_samp_desc->GetImageView();
1547 auto image_layout = img_samp_desc->GetImageLayout();
1548 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001549 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001550 error_str << "Attempted copy update to combined image sampler descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001551 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001552 return false;
1553 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001554 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001555 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001556 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001557 case Image: {
1558 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1559 auto img_desc = static_cast<const ImageDescriptor *>(src_set->descriptors_[index + di].get());
1560 auto image_view = img_desc->GetImageView();
1561 auto image_layout = img_desc->GetImageLayout();
1562 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001563 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001564 error_str << "Attempted copy update to image descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001565 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001566 return false;
1567 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001568 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001569 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001570 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001571 case TexelBuffer: {
1572 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1573 auto buffer_view = static_cast<TexelDescriptor *>(src_set->descriptors_[index + di].get())->GetBufferView();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001574 auto bv_state = GetBufferViewState(device_data_, buffer_view);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001575 if (!bv_state) {
1576 *error_code = VALIDATION_ERROR_00940;
1577 std::stringstream error_str;
1578 error_str << "Attempted copy update to texel buffer descriptor with invalid buffer view: " << buffer_view;
1579 *error_msg = error_str.str();
1580 return false;
1581 }
1582 auto buffer = bv_state->create_info.buffer;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001583 if (!ValidateBufferUsage(GetBufferState(device_data_, buffer), type, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001584 std::stringstream error_str;
1585 error_str << "Attempted copy update to texel buffer descriptor failed due to: " << error_msg->c_str();
1586 *error_msg = error_str.str();
1587 return false;
1588 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001589 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001590 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001591 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001592 case GeneralBuffer: {
1593 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1594 auto buffer = static_cast<BufferDescriptor *>(src_set->descriptors_[index + di].get())->GetBuffer();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001595 if (!ValidateBufferUsage(GetBufferState(device_data_, buffer), type, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001596 std::stringstream error_str;
1597 error_str << "Attempted copy update to buffer descriptor failed due to: " << error_msg->c_str();
1598 *error_msg = error_str.str();
1599 return false;
1600 }
Tobin Ehliscbcf2342016-05-24 13:07:12 -06001601 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001602 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001603 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001604 default:
1605 assert(0); // We've already verified update type so should never get here
1606 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001607 }
1608 // All checks passed so update contents are good
1609 return true;
Chris Forbesb4e0bdb2016-05-31 16:34:40 +12001610}
Tobin Ehlisf320b192017-03-14 11:22:50 -06001611// Update the common AllocateDescriptorSetsData
1612void cvdescriptorset::UpdateAllocateDescriptorSetsData(const layer_data *dev_data, const VkDescriptorSetAllocateInfo *p_alloc_info,
1613 AllocateDescriptorSetsData *ds_data) {
1614 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
1615 auto layout = GetDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
1616 if (layout) {
1617 ds_data->layout_nodes[i] = layout;
1618 // Count total descriptors required per type
1619 for (uint32_t j = 0; j < layout->GetBindingCount(); ++j) {
1620 const auto &binding_layout = layout->GetDescriptorSetLayoutBindingPtrFromIndex(j);
1621 uint32_t typeIndex = static_cast<uint32_t>(binding_layout->descriptorType);
1622 ds_data->required_descriptors_by_type[typeIndex] += binding_layout->descriptorCount;
1623 }
1624 }
1625 // Any unknown layouts will be flagged as errors during ValidateAllocateDescriptorSets() call
1626 }
1627};
Tobin Ehlisee471462016-05-26 11:21:59 -06001628// Verify that the state at allocate time is correct, but don't actually allocate the sets yet
Tobin Ehlisf320b192017-03-14 11:22:50 -06001629bool cvdescriptorset::ValidateAllocateDescriptorSets(const core_validation::layer_data *dev_data,
1630 const VkDescriptorSetAllocateInfo *p_alloc_info,
1631 const AllocateDescriptorSetsData *ds_data) {
Tobin Ehlisee471462016-05-26 11:21:59 -06001632 bool skip_call = false;
Tobin Ehlisf320b192017-03-14 11:22:50 -06001633 auto report_data = core_validation::GetReportData(dev_data);
Tobin Ehlisee471462016-05-26 11:21:59 -06001634
1635 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001636 auto layout = GetDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
Tobin Ehlis815e8132016-06-02 13:02:17 -06001637 if (!layout) {
Tobin Ehlisee471462016-05-26 11:21:59 -06001638 skip_call |=
1639 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT,
1640 reinterpret_cast<const uint64_t &>(p_alloc_info->pSetLayouts[i]), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
1641 "Unable to find set layout node for layout 0x%" PRIxLEAST64 " specified in vkAllocateDescriptorSets() call",
1642 reinterpret_cast<const uint64_t &>(p_alloc_info->pSetLayouts[i]));
Tobin Ehlisee471462016-05-26 11:21:59 -06001643 }
1644 }
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001645 if (!GetDeviceExtensions(dev_data)->khr_maintenance1_enabled) {
1646 auto pool_state = GetDescriptorPoolState(dev_data, p_alloc_info->descriptorPool);
1647 // Track number of descriptorSets allowable in this pool
1648 if (pool_state->availableSets < p_alloc_info->descriptorSetCount) {
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001649 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT,
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001650 reinterpret_cast<uint64_t &>(pool_state->pool), __LINE__, VALIDATION_ERROR_00911, "DS",
1651 "Unable to allocate %u descriptorSets from pool 0x%" PRIxLEAST64
1652 ". This pool only has %d descriptorSets remaining. %s",
1653 p_alloc_info->descriptorSetCount, reinterpret_cast<uint64_t &>(pool_state->pool),
1654 pool_state->availableSets, validation_error_map[VALIDATION_ERROR_00911]);
1655 }
1656 // Determine whether descriptor counts are satisfiable
1657 for (uint32_t i = 0; i < VK_DESCRIPTOR_TYPE_RANGE_SIZE; i++) {
1658 if (ds_data->required_descriptors_by_type[i] > pool_state->availableDescriptorTypeCount[i]) {
1659 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT,
1660 reinterpret_cast<const uint64_t &>(pool_state->pool), __LINE__, VALIDATION_ERROR_00912, "DS",
1661 "Unable to allocate %u descriptors of type %s from pool 0x%" PRIxLEAST64
1662 ". This pool only has %d descriptors of this type remaining. %s",
1663 ds_data->required_descriptors_by_type[i], string_VkDescriptorType(VkDescriptorType(i)),
1664 reinterpret_cast<uint64_t &>(pool_state->pool), pool_state->availableDescriptorTypeCount[i],
1665 validation_error_map[VALIDATION_ERROR_00912]);
1666 }
Tobin Ehlisee471462016-05-26 11:21:59 -06001667 }
1668 }
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001669
Tobin Ehlisee471462016-05-26 11:21:59 -06001670 return skip_call;
1671}
1672// Decrement allocated sets from the pool and insert new sets into set_map
Tobin Ehlis4e380592016-06-02 12:41:47 -06001673void cvdescriptorset::PerformAllocateDescriptorSets(const VkDescriptorSetAllocateInfo *p_alloc_info,
1674 const VkDescriptorSet *descriptor_sets,
1675 const AllocateDescriptorSetsData *ds_data,
Tobin Ehlisbd711bd2016-10-12 14:27:30 -06001676 std::unordered_map<VkDescriptorPool, DESCRIPTOR_POOL_STATE *> *pool_map,
Tobin Ehlis4e380592016-06-02 12:41:47 -06001677 std::unordered_map<VkDescriptorSet, cvdescriptorset::DescriptorSet *> *set_map,
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001678 const layer_data *dev_data) {
Tobin Ehlisee471462016-05-26 11:21:59 -06001679 auto pool_state = (*pool_map)[p_alloc_info->descriptorPool];
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001680 /* Account for sets and individual descriptors allocated from pool */
Tobin Ehlisee471462016-05-26 11:21:59 -06001681 pool_state->availableSets -= p_alloc_info->descriptorSetCount;
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001682 for (uint32_t i = 0; i < VK_DESCRIPTOR_TYPE_RANGE_SIZE; i++) {
1683 pool_state->availableDescriptorTypeCount[i] -= ds_data->required_descriptors_by_type[i];
1684 }
Tobin Ehlisee471462016-05-26 11:21:59 -06001685 /* Create tracking object for each descriptor set; insert into
1686 * global map and the pool's set.
1687 */
1688 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Tobin Ehlis93f22372016-10-12 14:34:12 -06001689 auto new_ds = new cvdescriptorset::DescriptorSet(descriptor_sets[i], p_alloc_info->descriptorPool, ds_data->layout_nodes[i],
1690 dev_data);
Tobin Ehlisee471462016-05-26 11:21:59 -06001691
1692 pool_state->sets.insert(new_ds);
1693 new_ds->in_use.store(0);
1694 (*set_map)[descriptor_sets[i]] = new_ds;
1695 }
1696}