blob: e3caff60bcef60bc897c8494b8ad5da609e9b64d [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"
Tobin Ehlisc8266452017-04-07 12:20:30 -060027#include "buffer_validation.h"
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060028#include <sstream>
Mark Lobodzinski2eee5d82016-12-02 15:33:18 -070029#include <algorithm>
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060030
31// Construct DescriptorSetLayout instance from given create info
Tobin Ehlis154c2692016-10-25 09:36:53 -060032cvdescriptorset::DescriptorSetLayout::DescriptorSetLayout(const VkDescriptorSetLayoutCreateInfo *p_create_info,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060033 const VkDescriptorSetLayout layout)
34 : layout_(layout), binding_count_(p_create_info->bindingCount), descriptor_count_(0), dynamic_descriptor_count_(0) {
Tobin Ehlisa3525e02016-11-17 10:50:52 -070035 // Dyn array indicies are ordered by binding # and array index of any array within the binding
36 // so we store up bindings w/ count in ordered map in order to create dyn array mappings below
37 std::map<uint32_t, uint32_t> binding_to_dyn_count;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060038 for (uint32_t i = 0; i < binding_count_; ++i) {
Tobin Ehlis9637fb22016-12-12 15:59:34 -070039 auto binding_num = p_create_info->pBindings[i].binding;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060040 descriptor_count_ += p_create_info->pBindings[i].descriptorCount;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -070041 uint32_t insert_index = 0; // Track vector index where we insert element
Tobin Ehlis9637fb22016-12-12 15:59:34 -070042 if (bindings_.empty() || binding_num > bindings_.back().binding) {
43 bindings_.push_back(safe_VkDescriptorSetLayoutBinding(&p_create_info->pBindings[i]));
Jamie Madill3f5fd492016-12-19 15:59:18 -050044 insert_index = static_cast<uint32_t>(bindings_.size()) - 1;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -070045 } else { // out-of-order binding number, need to insert into vector in-order
Tobin Ehlis9637fb22016-12-12 15:59:34 -070046 auto it = bindings_.begin();
47 // Find currently binding's spot in vector
48 while (binding_num > it->binding) {
49 assert(it != bindings_.end());
50 ++insert_index;
51 ++it;
52 }
53 bindings_.insert(it, safe_VkDescriptorSetLayoutBinding(&p_create_info->pBindings[i]));
54 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060055 // In cases where we should ignore pImmutableSamplers make sure it's NULL
56 if ((p_create_info->pBindings[i].pImmutableSamplers) &&
57 ((p_create_info->pBindings[i].descriptorType != VK_DESCRIPTOR_TYPE_SAMPLER) &&
58 (p_create_info->pBindings[i].descriptorType != VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER))) {
Tobin Ehlis9637fb22016-12-12 15:59:34 -070059 bindings_[insert_index].pImmutableSamplers = nullptr;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060060 }
61 if (p_create_info->pBindings[i].descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
62 p_create_info->pBindings[i].descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC) {
Tobin Ehlisa3525e02016-11-17 10:50:52 -070063 binding_to_dyn_count[p_create_info->pBindings[i].binding] = p_create_info->pBindings[i].descriptorCount;
Tobin Ehlisef0de162016-06-20 13:07:34 -060064 dynamic_descriptor_count_ += p_create_info->pBindings[i].descriptorCount;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060065 }
66 }
Tobin Ehlis9637fb22016-12-12 15:59:34 -070067 assert(bindings_.size() == binding_count_);
68 uint32_t global_index = 0;
69 // Vector order is finalized so create maps of bindings to indices
70 for (uint32_t i = 0; i < binding_count_; ++i) {
71 auto binding_num = bindings_[i].binding;
72 binding_to_index_map_[binding_num] = i;
73 binding_to_global_start_index_map_[binding_num] = global_index;
74 global_index += bindings_[i].descriptorCount ? bindings_[i].descriptorCount - 1 : 0;
75 binding_to_global_end_index_map_[binding_num] = global_index;
76 global_index += bindings_[i].descriptorCount ? 1 : 0;
77 }
Tobin Ehlisa3525e02016-11-17 10:50:52 -070078 // Now create dyn offset array mapping for any dynamic descriptors
79 uint32_t dyn_array_idx = 0;
80 for (const auto &bc_pair : binding_to_dyn_count) {
81 binding_to_dynamic_array_idx_map_[bc_pair.first] = dyn_array_idx;
82 dyn_array_idx += bc_pair.second;
83 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060084}
Tobin Ehlis154c2692016-10-25 09:36:53 -060085
86// Validate descriptor set layout create info
87bool cvdescriptorset::DescriptorSetLayout::ValidateCreateInfo(debug_report_data *report_data,
88 const VkDescriptorSetLayoutCreateInfo *create_info) {
89 bool skip = false;
90 std::unordered_set<uint32_t> bindings;
91 for (uint32_t i = 0; i < create_info->bindingCount; ++i) {
Tobin Ehlisfdcb63f2016-10-25 20:56:47 -060092 if (!bindings.insert(create_info->pBindings[i].binding).second) {
Tobin Ehlis154c2692016-10-25 09:36:53 -060093 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -060094 VALIDATION_ERROR_0500022e, "DS", "duplicated binding number in VkDescriptorSetLayoutBinding. %s",
95 validation_error_map[VALIDATION_ERROR_0500022e]);
Tobin Ehlis154c2692016-10-25 09:36:53 -060096 }
Tobin Ehlis154c2692016-10-25 09:36:53 -060097 }
98 return skip;
99}
100
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600101// put all bindings into the given set
102void cvdescriptorset::DescriptorSetLayout::FillBindingSet(std::unordered_set<uint32_t> *binding_set) const {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700103 for (auto binding_index_pair : binding_to_index_map_) binding_set->insert(binding_index_pair.first);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600104}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600105
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700106VkDescriptorSetLayoutBinding const *cvdescriptorset::DescriptorSetLayout::GetDescriptorSetLayoutBindingPtrFromBinding(
107 const uint32_t binding) const {
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600108 const auto &bi_itr = binding_to_index_map_.find(binding);
109 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600110 return bindings_[bi_itr->second].ptr();
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600111 }
112 return nullptr;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600113}
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700114VkDescriptorSetLayoutBinding const *cvdescriptorset::DescriptorSetLayout::GetDescriptorSetLayoutBindingPtrFromIndex(
115 const uint32_t index) const {
116 if (index >= bindings_.size()) return nullptr;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600117 return bindings_[index].ptr();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600118}
119// Return descriptorCount for given binding, 0 if index is unavailable
120uint32_t cvdescriptorset::DescriptorSetLayout::GetDescriptorCountFromBinding(const uint32_t binding) const {
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600121 const auto &bi_itr = binding_to_index_map_.find(binding);
122 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600123 return bindings_[bi_itr->second].descriptorCount;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600124 }
125 return 0;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600126}
127// Return descriptorCount for given index, 0 if index is unavailable
128uint32_t cvdescriptorset::DescriptorSetLayout::GetDescriptorCountFromIndex(const uint32_t index) const {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700129 if (index >= bindings_.size()) return 0;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600130 return bindings_[index].descriptorCount;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600131}
132// For the given binding, return descriptorType
133VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromBinding(const uint32_t binding) const {
134 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600135 const auto &bi_itr = binding_to_index_map_.find(binding);
136 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600137 return bindings_[bi_itr->second].descriptorType;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600138 }
139 return VK_DESCRIPTOR_TYPE_MAX_ENUM;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600140}
141// For the given index, return descriptorType
142VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromIndex(const uint32_t index) const {
143 assert(index < bindings_.size());
Tobin Ehlis664e6012016-05-05 11:04:44 -0600144 return bindings_[index].descriptorType;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600145}
146// For the given global index, return descriptorType
147// Currently just counting up through bindings_, may improve this in future
148VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromGlobalIndex(const uint32_t index) const {
149 uint32_t global_offset = 0;
150 for (auto binding : bindings_) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600151 global_offset += binding.descriptorCount;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700152 if (index < global_offset) return binding.descriptorType;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600153 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700154 assert(0); // requested global index is out of bounds
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600155 return VK_DESCRIPTOR_TYPE_MAX_ENUM;
156}
157// For the given binding, return stageFlags
158VkShaderStageFlags cvdescriptorset::DescriptorSetLayout::GetStageFlagsFromBinding(const uint32_t binding) const {
159 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600160 const auto &bi_itr = binding_to_index_map_.find(binding);
161 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600162 return bindings_[bi_itr->second].stageFlags;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600163 }
164 return VkShaderStageFlags(0);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600165}
166// For the given binding, return start index
167uint32_t cvdescriptorset::DescriptorSetLayout::GetGlobalStartIndexFromBinding(const uint32_t binding) const {
168 assert(binding_to_global_start_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600169 const auto &btgsi_itr = binding_to_global_start_index_map_.find(binding);
170 if (btgsi_itr != binding_to_global_start_index_map_.end()) {
171 return btgsi_itr->second;
172 }
173 // In error case max uint32_t so index is out of bounds to break ASAP
Tobin Ehlis58c59582016-06-21 12:34:33 -0600174 assert(0);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600175 return 0xFFFFFFFF;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600176}
177// For the given binding, return end index
178uint32_t cvdescriptorset::DescriptorSetLayout::GetGlobalEndIndexFromBinding(const uint32_t binding) const {
179 assert(binding_to_global_end_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600180 const auto &btgei_itr = binding_to_global_end_index_map_.find(binding);
181 if (btgei_itr != binding_to_global_end_index_map_.end()) {
182 return btgei_itr->second;
183 }
184 // In error case max uint32_t so index is out of bounds to break ASAP
Tobin Ehlis58c59582016-06-21 12:34:33 -0600185 assert(0);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600186 return 0xFFFFFFFF;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600187}
188// For given binding, return ptr to ImmutableSampler array
189VkSampler const *cvdescriptorset::DescriptorSetLayout::GetImmutableSamplerPtrFromBinding(const uint32_t binding) const {
190 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600191 const auto &bi_itr = binding_to_index_map_.find(binding);
192 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600193 return bindings_[bi_itr->second].pImmutableSamplers;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600194 }
195 return nullptr;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600196}
Mark Lobodzinski4aa479d2017-03-10 09:14:00 -0700197// Move to next valid binding having a non-zero binding count
198uint32_t cvdescriptorset::DescriptorSetLayout::GetNextValidBinding(const uint32_t binding) const {
199 uint32_t new_binding = binding;
200 do {
201 new_binding++;
202 } while (GetDescriptorCountFromBinding(new_binding) == 0);
203 return new_binding;
204}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600205// For given index, return ptr to ImmutableSampler array
206VkSampler const *cvdescriptorset::DescriptorSetLayout::GetImmutableSamplerPtrFromIndex(const uint32_t index) const {
207 assert(index < bindings_.size());
Tobin Ehlis664e6012016-05-05 11:04:44 -0600208 return bindings_[index].pImmutableSamplers;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600209}
210// If our layout is compatible with rh_ds_layout, return true,
211// else return false and fill in error_msg will description of what causes incompatibility
Tobin Ehlis6dc57dd2017-06-21 10:08:52 -0600212bool cvdescriptorset::DescriptorSetLayout::IsCompatible(DescriptorSetLayout const *const rh_ds_layout,
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600213 std::string *error_msg) const {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600214 // Trivial case
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700215 if (layout_ == rh_ds_layout->GetDescriptorSetLayout()) return true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600216 if (descriptor_count_ != rh_ds_layout->descriptor_count_) {
217 std::stringstream error_str;
218 error_str << "DescriptorSetLayout " << layout_ << " has " << descriptor_count_ << " descriptors, but DescriptorSetLayout "
Tobin Ehlisb1861d92017-07-06 16:50:10 -0600219 << rh_ds_layout->GetDescriptorSetLayout() << ", which comes from pipelineLayout, has "
220 << rh_ds_layout->descriptor_count_ << " descriptors.";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600221 *error_msg = error_str.str();
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700222 return false; // trivial fail case
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600223 }
224 // Descriptor counts match so need to go through bindings one-by-one
225 // and verify that type and stageFlags match
226 for (auto binding : bindings_) {
227 // TODO : Do we also need to check immutable samplers?
228 // VkDescriptorSetLayoutBinding *rh_binding;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600229 if (binding.descriptorCount != rh_ds_layout->GetDescriptorCountFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600230 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600231 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " has a descriptorCount of "
232 << binding.descriptorCount << " but binding " << binding.binding << " for DescriptorSetLayout "
Tobin Ehlisb1861d92017-07-06 16:50:10 -0600233 << rh_ds_layout->GetDescriptorSetLayout() << ", which comes from pipelineLayout, has a descriptorCount of "
Tobin Ehlis664e6012016-05-05 11:04:44 -0600234 << rh_ds_layout->GetDescriptorCountFromBinding(binding.binding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600235 *error_msg = error_str.str();
236 return false;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600237 } else if (binding.descriptorType != rh_ds_layout->GetTypeFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600238 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600239 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " is type '"
240 << string_VkDescriptorType(binding.descriptorType) << "' but binding " << binding.binding
Tobin Ehlisb1861d92017-07-06 16:50:10 -0600241 << " for DescriptorSetLayout " << rh_ds_layout->GetDescriptorSetLayout()
242 << ", which comes from pipelineLayout, is type '"
Tobin Ehlis664e6012016-05-05 11:04:44 -0600243 << string_VkDescriptorType(rh_ds_layout->GetTypeFromBinding(binding.binding)) << "'";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600244 *error_msg = error_str.str();
245 return false;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600246 } else if (binding.stageFlags != rh_ds_layout->GetStageFlagsFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600247 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600248 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " has stageFlags "
249 << binding.stageFlags << " but binding " << binding.binding << " for DescriptorSetLayout "
Tobin Ehlisb1861d92017-07-06 16:50:10 -0600250 << rh_ds_layout->GetDescriptorSetLayout() << ", which comes from pipelineLayout, has stageFlags "
Tobin Ehlis664e6012016-05-05 11:04:44 -0600251 << rh_ds_layout->GetStageFlagsFromBinding(binding.binding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600252 *error_msg = error_str.str();
253 return false;
254 }
255 }
256 return true;
257}
258
259bool cvdescriptorset::DescriptorSetLayout::IsNextBindingConsistent(const uint32_t binding) const {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700260 if (!binding_to_index_map_.count(binding + 1)) return false;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600261 auto const &bi_itr = binding_to_index_map_.find(binding);
262 if (bi_itr != binding_to_index_map_.end()) {
263 const auto &next_bi_itr = binding_to_index_map_.find(binding + 1);
264 if (next_bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600265 auto type = bindings_[bi_itr->second].descriptorType;
266 auto stage_flags = bindings_[bi_itr->second].stageFlags;
267 auto immut_samp = bindings_[bi_itr->second].pImmutableSamplers ? true : false;
268 if ((type != bindings_[next_bi_itr->second].descriptorType) ||
269 (stage_flags != bindings_[next_bi_itr->second].stageFlags) ||
270 (immut_samp != (bindings_[next_bi_itr->second].pImmutableSamplers ? true : false))) {
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600271 return false;
272 }
273 return true;
274 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600275 }
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600276 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600277}
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600278// Starting at offset descriptor of given binding, parse over update_count
279// descriptor updates and verify that for any binding boundaries that are crossed, the next binding(s) are all consistent
280// Consistency means that their type, stage flags, and whether or not they use immutable samplers matches
281// If so, return true. If not, fill in error_msg and return false
282bool cvdescriptorset::DescriptorSetLayout::VerifyUpdateConsistency(uint32_t current_binding, uint32_t offset, uint32_t update_count,
283 const char *type, const VkDescriptorSet set,
284 std::string *error_msg) const {
285 // Verify consecutive bindings match (if needed)
286 auto orig_binding = current_binding;
287 // Track count of descriptors in the current_bindings that are remaining to be updated
288 auto binding_remaining = GetDescriptorCountFromBinding(current_binding);
289 // First, it's legal to offset beyond your own binding so handle that case
290 // Really this is just searching for the binding in which the update begins and adjusting offset accordingly
291 while (offset >= binding_remaining) {
292 // Advance to next binding, decrement offset by binding size
293 offset -= binding_remaining;
294 binding_remaining = GetDescriptorCountFromBinding(++current_binding);
295 }
296 binding_remaining -= offset;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700297 while (update_count > binding_remaining) { // While our updates overstep current binding
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600298 // Verify next consecutive binding matches type, stage flags & immutable sampler use
299 if (!IsNextBindingConsistent(current_binding++)) {
300 std::stringstream error_str;
301 error_str << "Attempting " << type << " descriptor set " << set << " binding #" << orig_binding << " with #"
302 << update_count << " descriptors being updated but this update oversteps the bounds of this binding and the "
303 "next binding is not consistent with current binding so this update is invalid.";
304 *error_msg = error_str.str();
305 return false;
306 }
307 // For sake of this check consider the bindings updated and grab count for next binding
308 update_count -= binding_remaining;
309 binding_remaining = GetDescriptorCountFromBinding(current_binding);
310 }
311 return true;
312}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600313
Tobin Ehlis68d0adf2016-06-01 11:33:50 -0600314cvdescriptorset::AllocateDescriptorSetsData::AllocateDescriptorSetsData(uint32_t count)
315 : required_descriptors_by_type{}, layout_nodes(count, nullptr) {}
316
Tobin Ehlis93f22372016-10-12 14:34:12 -0600317cvdescriptorset::DescriptorSet::DescriptorSet(const VkDescriptorSet set, const VkDescriptorPool pool,
Tobin Ehlis452b4532017-06-21 09:56:13 -0600318 const std::shared_ptr<DescriptorSetLayout const> &layout, const layer_data *dev_data)
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -0700319 : some_update_(false),
320 set_(set),
321 pool_state_(nullptr),
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600322 p_layout_(layout),
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -0700323 device_data_(dev_data),
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700324 limits_(GetPhysDevProperties(dev_data)->properties.limits) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700325 pool_state_ = GetDescriptorPoolState(dev_data, pool);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600326 // Foreach binding, create default descriptors of given type
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600327 for (uint32_t i = 0; i < p_layout_->GetBindingCount(); ++i) {
328 auto type = p_layout_->GetTypeFromIndex(i);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600329 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700330 case VK_DESCRIPTOR_TYPE_SAMPLER: {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600331 auto immut_sampler = p_layout_->GetImmutableSamplerPtrFromIndex(i);
332 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
Tobin Ehlis082c7512017-05-08 11:24:57 -0600333 if (immut_sampler) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700334 descriptors_.emplace_back(new SamplerDescriptor(immut_sampler + di));
Tobin Ehlis082c7512017-05-08 11:24:57 -0600335 some_update_ = true; // Immutable samplers are updated at creation
336 } else
Chris Forbes9f340852017-05-09 08:51:38 -0700337 descriptors_.emplace_back(new SamplerDescriptor(nullptr));
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700338 }
339 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600340 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700341 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600342 auto immut = p_layout_->GetImmutableSamplerPtrFromIndex(i);
343 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
Tobin Ehlis082c7512017-05-08 11:24:57 -0600344 if (immut) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700345 descriptors_.emplace_back(new ImageSamplerDescriptor(immut + di));
Tobin Ehlis082c7512017-05-08 11:24:57 -0600346 some_update_ = true; // Immutable samplers are updated at creation
347 } else
Chris Forbes9f340852017-05-09 08:51:38 -0700348 descriptors_.emplace_back(new ImageSamplerDescriptor(nullptr));
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700349 }
350 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600351 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700352 // ImageDescriptors
353 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
354 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
355 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600356 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700357 descriptors_.emplace_back(new ImageDescriptor(type));
358 break;
359 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
360 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600361 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700362 descriptors_.emplace_back(new TexelDescriptor(type));
363 break;
364 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
365 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
366 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
367 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600368 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700369 descriptors_.emplace_back(new BufferDescriptor(type));
370 break;
371 default:
372 assert(0); // Bad descriptor type specified
373 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600374 }
375 }
376}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600377
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700378cvdescriptorset::DescriptorSet::~DescriptorSet() { InvalidateBoundCmdBuffers(); }
Chris Forbes57989132016-07-26 17:06:10 +1200379
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700380static std::string string_descriptor_req_view_type(descriptor_req req) {
381 std::string result("");
Chris Forbes57989132016-07-26 17:06:10 +1200382 for (unsigned i = 0; i <= VK_IMAGE_VIEW_TYPE_END_RANGE; i++) {
383 if (req & (1 << i)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700384 if (result.size()) result += ", ";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700385 result += string_VkImageViewType(VkImageViewType(i));
Chris Forbes57989132016-07-26 17:06:10 +1200386 }
387 }
388
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700389 if (!result.size()) result = "(none)";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700390
391 return result;
Chris Forbes57989132016-07-26 17:06:10 +1200392}
393
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600394// Is this sets underlying layout compatible with passed in layout according to "Pipeline Layout Compatibility" in spec?
Tobin Ehlis6dc57dd2017-06-21 10:08:52 -0600395bool cvdescriptorset::DescriptorSet::IsCompatible(DescriptorSetLayout const *const layout, std::string *error) const {
396 return layout->IsCompatible(p_layout_.get(), error);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600397}
Chris Forbes57989132016-07-26 17:06:10 +1200398
Tobin Ehlis3066db62016-08-22 08:12:23 -0600399// 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 -0600400// This includes validating that all descriptors in the given bindings are updated,
401// that any update buffers are valid, and that any dynamic offsets are within the bounds of their buffers.
402// Return true if state is acceptable, or false and write an error message into error string
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600403bool cvdescriptorset::DescriptorSet::ValidateDrawState(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600404 const std::vector<uint32_t> &dynamic_offsets, const GLOBAL_CB_NODE *cb_node,
405 const char *caller, std::string *error) const {
Chris Forbesc7090a82016-07-25 18:10:41 +1200406 for (auto binding_pair : bindings) {
407 auto binding = binding_pair.first;
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600408 if (!p_layout_->HasBinding(binding)) {
Tobin Ehlis58c59582016-06-21 12:34:33 -0600409 std::stringstream error_str;
410 error_str << "Attempting to validate DrawState for binding #" << binding
411 << " which is an invalid binding for this descriptor set.";
412 *error = error_str.str();
413 return false;
414 }
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600415 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
416 auto end_idx = p_layout_->GetGlobalEndIndexFromBinding(binding);
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700417 auto array_idx = 0; // Track array idx if we're dealing with array descriptors
418 for (uint32_t i = start_idx; i <= end_idx; ++i, ++array_idx) {
419 if (!descriptors_[i]->updated) {
420 std::stringstream error_str;
421 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
422 << " is being used in draw but has not been updated.";
423 *error = error_str.str();
424 return false;
425 } else {
426 auto descriptor_class = descriptors_[i]->GetClass();
427 if (descriptor_class == GeneralBuffer) {
428 // Verify that buffers are valid
429 auto buffer = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetBuffer();
430 auto buffer_node = GetBufferState(device_data_, buffer);
431 if (!buffer_node) {
432 std::stringstream error_str;
433 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
434 << " references invalid buffer " << buffer << ".";
435 *error = error_str.str();
436 return false;
437 } else {
438 for (auto mem_binding : buffer_node->GetBoundMemory()) {
439 if (!GetMemObjInfo(device_data_, mem_binding)) {
440 std::stringstream error_str;
441 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
442 << " uses buffer " << buffer << " that references invalid memory " << mem_binding << ".";
443 *error = error_str.str();
Tobin Ehlisc8266452017-04-07 12:20:30 -0600444 return false;
445 }
446 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700447 }
448 if (descriptors_[i]->IsDynamic()) {
449 // Validate that dynamic offsets are within the buffer
450 auto buffer_size = buffer_node->createInfo.size;
451 auto range = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetRange();
452 auto desc_offset = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetOffset();
453 auto dyn_offset = dynamic_offsets[GetDynamicOffsetIndexFromBinding(binding) + array_idx];
454 if (VK_WHOLE_SIZE == range) {
455 if ((dyn_offset + desc_offset) > buffer_size) {
456 std::stringstream error_str;
457 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
458 << " uses buffer " << buffer << " with update range of VK_WHOLE_SIZE has dynamic offset "
459 << dyn_offset << " combined with offset " << desc_offset
460 << " that oversteps the buffer size of " << buffer_size << ".";
461 *error = error_str.str();
462 return false;
463 }
464 } else {
465 if ((dyn_offset + desc_offset + range) > buffer_size) {
466 std::stringstream error_str;
467 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
468 << " uses buffer " << buffer << " with dynamic offset " << dyn_offset
469 << " combined with offset " << desc_offset << " and range " << range
470 << " that oversteps the buffer size of " << buffer_size << ".";
471 *error = error_str.str();
472 return false;
473 }
474 }
475 }
476 } else if (descriptor_class == ImageSampler || descriptor_class == Image) {
477 VkImageView image_view;
478 VkImageLayout image_layout;
479 if (descriptor_class == ImageSampler) {
480 image_view = static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetImageView();
481 image_layout = static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetImageLayout();
482 } else {
483 image_view = static_cast<ImageDescriptor *>(descriptors_[i].get())->GetImageView();
484 image_layout = static_cast<ImageDescriptor *>(descriptors_[i].get())->GetImageLayout();
485 }
486 auto reqs = binding_pair.second;
487
488 auto image_view_state = GetImageViewState(device_data_, image_view);
Tobin Ehlis836a1372017-07-14 11:25:21 -0600489 if (nullptr == image_view_state) {
490 // Image view must have been destroyed since initial update. Could potentially flag the descriptor
491 // as "invalid" (updated = false) at DestroyImageView() time and detect this error at bind time
492 std::stringstream error_str;
493 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
494 << " is using imageView " << image_view << " that has been destroyed.";
495 *error = error_str.str();
496 return false;
497 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700498 auto image_view_ci = image_view_state->create_info;
499
500 if ((reqs & DESCRIPTOR_REQ_ALL_VIEW_TYPE_BITS) && (~reqs & (1 << image_view_ci.viewType))) {
501 // bad view type
502 std::stringstream error_str;
503 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
504 << " requires an image view of type " << string_descriptor_req_view_type(reqs) << " but got "
505 << string_VkImageViewType(image_view_ci.viewType) << ".";
506 *error = error_str.str();
507 return false;
508 }
509
510 auto image_node = GetImageState(device_data_, image_view_ci.image);
511 assert(image_node);
512 // Verify Image Layout
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600513 // TODO: VALIDATION_ERROR_046002ae is the error physically closest to the spec language of interest, however
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700514 // there is no VUID for the actual spec language. Need to file a spec MR to add VU language for:
515 // imageLayout is the layout that the image subresources accessible from imageView will be in at the time
516 // this descriptor is accessed.
517 // Copy first mip level into sub_layers and loop over each mip level to verify layout
518 VkImageSubresourceLayers sub_layers;
519 sub_layers.aspectMask = image_view_ci.subresourceRange.aspectMask;
520 sub_layers.baseArrayLayer = image_view_ci.subresourceRange.baseArrayLayer;
521 sub_layers.layerCount = image_view_ci.subresourceRange.layerCount;
522 bool hit_error = false;
523 for (auto cur_level = image_view_ci.subresourceRange.baseMipLevel;
524 cur_level < image_view_ci.subresourceRange.levelCount; ++cur_level) {
525 sub_layers.mipLevel = cur_level;
526 VerifyImageLayout(device_data_, cb_node, image_node, sub_layers, image_layout, VK_IMAGE_LAYOUT_UNDEFINED,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600527 caller, VALIDATION_ERROR_046002ae, &hit_error);
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700528 if (hit_error) {
529 *error =
530 "Image layout specified at vkUpdateDescriptorSets() time doesn't match actual image layout at "
531 "time descriptor is used. See previous error callback for specific details.";
Chris Forbes57989132016-07-26 17:06:10 +1200532 return false;
533 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700534 }
535 // Verify Sample counts
536 if ((reqs & DESCRIPTOR_REQ_SINGLE_SAMPLE) && image_node->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
537 std::stringstream error_str;
538 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
539 << " requires bound image to have VK_SAMPLE_COUNT_1_BIT but got "
540 << string_VkSampleCountFlagBits(image_node->createInfo.samples) << ".";
541 *error = error_str.str();
542 return false;
543 }
544 if ((reqs & DESCRIPTOR_REQ_MULTI_SAMPLE) && image_node->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
545 std::stringstream error_str;
546 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
547 << " requires bound image to have multiple samples, but got VK_SAMPLE_COUNT_1_BIT.";
548 *error = error_str.str();
549 return false;
Chris Forbes57989132016-07-26 17:06:10 +1200550 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600551 }
552 }
553 }
554 }
555 return true;
556}
Chris Forbes57989132016-07-26 17:06:10 +1200557
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600558// For given bindings, place any update buffers or images into the passed-in unordered_sets
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600559uint32_t cvdescriptorset::DescriptorSet::GetStorageUpdates(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600560 std::unordered_set<VkBuffer> *buffer_set,
561 std::unordered_set<VkImageView> *image_set) const {
562 auto num_updates = 0;
Chris Forbesc7090a82016-07-25 18:10:41 +1200563 for (auto binding_pair : bindings) {
564 auto binding = binding_pair.first;
Tobin Ehlis58c59582016-06-21 12:34:33 -0600565 // If a binding doesn't exist, skip it
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600566 if (!p_layout_->HasBinding(binding)) {
Tobin Ehlis58c59582016-06-21 12:34:33 -0600567 continue;
568 }
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600569 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
Tobin Ehlis81f17852016-05-05 09:04:33 -0600570 if (descriptors_[start_idx]->IsStorage()) {
571 if (Image == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600572 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600573 if (descriptors_[start_idx + i]->updated) {
574 image_set->insert(static_cast<ImageDescriptor *>(descriptors_[start_idx + i].get())->GetImageView());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600575 num_updates++;
576 }
577 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600578 } else if (TexelBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600579 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600580 if (descriptors_[start_idx + i]->updated) {
581 auto bufferview = static_cast<TexelDescriptor *>(descriptors_[start_idx + i].get())->GetBufferView();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700582 auto bv_state = GetBufferViewState(device_data_, bufferview);
Tobin Ehlis8b872462016-09-14 08:12:08 -0600583 if (bv_state) {
584 buffer_set->insert(bv_state->create_info.buffer);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600585 num_updates++;
586 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600587 }
588 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600589 } else if (GeneralBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600590 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600591 if (descriptors_[start_idx + i]->updated) {
592 buffer_set->insert(static_cast<BufferDescriptor *>(descriptors_[start_idx + i].get())->GetBuffer());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600593 num_updates++;
594 }
595 }
596 }
597 }
598 }
599 return num_updates;
600}
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600601// Set is being deleted or updates so invalidate all bound cmd buffers
602void cvdescriptorset::DescriptorSet::InvalidateBoundCmdBuffers() {
Petr Krausbc7f5442017-05-14 23:43:38 +0200603 core_validation::invalidateCommandBuffers(device_data_, cb_bindings, {HandleToUint64(set_), kVulkanObjectTypeDescriptorSet});
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600604}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600605// Perform write update in given update struct
Tobin Ehlis300888c2016-05-18 13:43:26 -0600606void cvdescriptorset::DescriptorSet::PerformWriteUpdate(const VkWriteDescriptorSet *update) {
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700607 // Perform update on a per-binding basis as consecutive updates roll over to next binding
608 auto descriptors_remaining = update->descriptorCount;
609 auto binding_being_updated = update->dstBinding;
610 auto offset = update->dstArrayElement;
611 while (descriptors_remaining) {
612 uint32_t update_count = std::min(descriptors_remaining, GetDescriptorCountFromBinding(binding_being_updated));
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600613 auto global_idx = p_layout_->GetGlobalStartIndexFromBinding(binding_being_updated) + offset;
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700614 // Loop over the updates for a single binding at a time
615 for (uint32_t di = 0; di < update_count; ++di) {
616 descriptors_[global_idx + di]->WriteUpdate(update, di);
617 }
618 // Roll over to next binding in case of consecutive update
619 descriptors_remaining -= update_count;
620 offset = 0;
621 binding_being_updated++;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600622 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700623 if (update->descriptorCount) some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600624
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600625 InvalidateBoundCmdBuffers();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600626}
Tobin Ehlis300888c2016-05-18 13:43:26 -0600627// Validate Copy update
628bool cvdescriptorset::DescriptorSet::ValidateCopyUpdate(const debug_report_data *report_data, const VkCopyDescriptorSet *update,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600629 const DescriptorSet *src_set, UNIQUE_VALIDATION_ERROR_CODE *error_code,
630 std::string *error_msg) {
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600631 // Verify idle ds
632 if (in_use.load()) {
Tobin Ehlis2cb8eb22017-01-03 14:09:57 -0700633 // TODO : Re-using Free Idle error code, need copy update idle error code
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600634 *error_code = VALIDATION_ERROR_2860026a;
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600635 std::stringstream error_str;
636 error_str << "Cannot call vkUpdateDescriptorSets() to perform copy update on descriptor set " << set_
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700637 << " that is in use by a command buffer";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600638 *error_msg = error_str.str();
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600639 return false;
640 }
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600641 if (!p_layout_->HasBinding(update->dstBinding)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600642 *error_code = VALIDATION_ERROR_032002b6;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600643 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700644 error_str << "DescriptorSet " << set_ << " does not have copy update dest binding of " << update->dstBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600645 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600646 return false;
647 }
648 if (!src_set->HasBinding(update->srcBinding)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600649 *error_code = VALIDATION_ERROR_032002b2;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600650 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700651 error_str << "DescriptorSet " << set_ << " does not have copy update src binding of " << update->srcBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600652 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600653 return false;
654 }
655 // src & dst set bindings are valid
656 // Check bounds of src & dst
657 auto src_start_idx = src_set->GetGlobalStartIndexFromBinding(update->srcBinding) + update->srcArrayElement;
658 if ((src_start_idx + update->descriptorCount) > src_set->GetTotalDescriptorCount()) {
659 // SRC update out of bounds
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600660 *error_code = VALIDATION_ERROR_032002b4;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600661 std::stringstream error_str;
662 error_str << "Attempting copy update from descriptorSet " << update->srcSet << " binding#" << update->srcBinding
663 << " with offset index of " << src_set->GetGlobalStartIndexFromBinding(update->srcBinding)
664 << " plus update array offset of " << update->srcArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700665 << " descriptors oversteps total number of descriptors in set: " << src_set->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600666 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600667 return false;
668 }
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600669 auto dst_start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
670 if ((dst_start_idx + update->descriptorCount) > p_layout_->GetTotalDescriptorCount()) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600671 // DST update out of bounds
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600672 *error_code = VALIDATION_ERROR_032002b8;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600673 std::stringstream error_str;
674 error_str << "Attempting copy update to descriptorSet " << set_ << " binding#" << update->dstBinding
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600675 << " with offset index of " << p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding)
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600676 << " plus update array offset of " << update->dstArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600677 << " descriptors oversteps total number of descriptors in set: " << p_layout_->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600678 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600679 return false;
680 }
681 // Check that types match
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600682 // TODO : Base default error case going from here is VALIDATION_ERROR_0002b8012ba which covers all consistency issues, need more
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600683 // fine-grained error codes
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600684 *error_code = VALIDATION_ERROR_032002ba;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600685 auto src_type = src_set->GetTypeFromBinding(update->srcBinding);
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600686 auto dst_type = p_layout_->GetTypeFromBinding(update->dstBinding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600687 if (src_type != dst_type) {
688 std::stringstream error_str;
689 error_str << "Attempting copy update to descriptorSet " << set_ << " binding #" << update->dstBinding << " with type "
690 << string_VkDescriptorType(dst_type) << " from descriptorSet " << src_set->GetSet() << " binding #"
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700691 << update->srcBinding << " with type " << string_VkDescriptorType(src_type) << ". Types do not match";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600692 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600693 return false;
694 }
695 // Verify consistency of src & dst bindings if update crosses binding boundaries
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600696 if ((!src_set->GetLayout()->VerifyUpdateConsistency(update->srcBinding, update->srcArrayElement, update->descriptorCount,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600697 "copy update from", src_set->GetSet(), error_msg)) ||
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600698 (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "copy update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600699 set_, error_msg))) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600700 return false;
701 }
Tobin Ehlisd41e7b62016-05-19 07:56:18 -0600702 // First make sure source descriptors are updated
703 for (uint32_t i = 0; i < update->descriptorCount; ++i) {
704 if (!src_set->descriptors_[src_start_idx + i]) {
705 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -0700706 error_str << "Attempting copy update from descriptorSet " << src_set << " binding #" << update->srcBinding
707 << " but descriptor at array offset " << update->srcArrayElement + i << " has not been updated";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600708 *error_msg = error_str.str();
Tobin Ehlisd41e7b62016-05-19 07:56:18 -0600709 return false;
710 }
711 }
712 // Update parameters all look good and descriptor updated so verify update contents
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700713 if (!VerifyCopyUpdateContents(update, src_set, src_type, src_start_idx, error_code, error_msg)) return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -0600714
715 // All checks passed so update is good
716 return true;
717}
718// Perform Copy update
719void cvdescriptorset::DescriptorSet::PerformCopyUpdate(const VkCopyDescriptorSet *update, const DescriptorSet *src_set) {
Tobin Ehlis300888c2016-05-18 13:43:26 -0600720 auto src_start_idx = src_set->GetGlobalStartIndexFromBinding(update->srcBinding) + update->srcArrayElement;
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600721 auto dst_start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600722 // Update parameters all look good so perform update
723 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Tobin Ehlis300888c2016-05-18 13:43:26 -0600724 descriptors_[dst_start_idx + di]->CopyUpdate(src_set->descriptors_[src_start_idx + di].get());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600725 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700726 if (update->descriptorCount) some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600727
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600728 InvalidateBoundCmdBuffers();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600729}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600730
Tobin Ehlisf9519102016-08-17 09:49:13 -0600731// Bind cb_node to this set and this set to cb_node.
732// Prereq: This should be called for a set that has been confirmed to be active for the given cb_node, meaning it's going
733// to be used in a draw by the given cb_node
Tobin Ehlis276d3d32016-12-21 09:21:06 -0700734void cvdescriptorset::DescriptorSet::BindCommandBuffer(GLOBAL_CB_NODE *cb_node,
Tobin Ehlis022528b2016-12-29 12:22:32 -0700735 const std::map<uint32_t, descriptor_req> &binding_req_map) {
Tobin Ehlis9252c2b2016-07-21 14:40:22 -0600736 // bind cb to this descriptor set
737 cb_bindings.insert(cb_node);
Tobin Ehlis7ca20be2016-10-12 15:09:16 -0600738 // Add bindings for descriptor set, the set's pool, and individual objects in the set
Petr Krausbc7f5442017-05-14 23:43:38 +0200739 cb_node->object_bindings.insert({HandleToUint64(set_), kVulkanObjectTypeDescriptorSet});
Tobin Ehlis7ca20be2016-10-12 15:09:16 -0600740 pool_state_->cb_bindings.insert(cb_node);
Petr Krausbc7f5442017-05-14 23:43:38 +0200741 cb_node->object_bindings.insert({HandleToUint64(pool_state_->pool), kVulkanObjectTypeDescriptorPool});
Tobin Ehlisf9519102016-08-17 09:49:13 -0600742 // For the active slots, use set# to look up descriptorSet from boundDescriptorSets, and bind all of that descriptor set's
743 // resources
Tobin Ehlis022528b2016-12-29 12:22:32 -0700744 for (auto binding_req_pair : binding_req_map) {
745 auto binding = binding_req_pair.first;
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600746 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
747 auto end_idx = p_layout_->GetGlobalEndIndexFromBinding(binding);
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600748 for (uint32_t i = start_idx; i <= end_idx; ++i) {
749 descriptors_[i]->BindCommandBuffer(device_data_, cb_node);
750 }
751 }
Tobin Ehlis9252c2b2016-07-21 14:40:22 -0600752}
753
Tobin Ehlis300888c2016-05-18 13:43:26 -0600754cvdescriptorset::SamplerDescriptor::SamplerDescriptor(const VkSampler *immut) : sampler_(VK_NULL_HANDLE), immutable_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600755 updated = false;
756 descriptor_class = PlainSampler;
757 if (immut) {
758 sampler_ = *immut;
759 immutable_ = true;
760 updated = true;
761 }
762}
Tobin Ehlise2f80292016-06-02 10:08:53 -0600763// Validate given sampler. Currently this only checks to make sure it exists in the samplerMap
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700764bool cvdescriptorset::ValidateSampler(const VkSampler sampler, const layer_data *dev_data) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700765 return (GetSamplerState(dev_data, sampler) != nullptr);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600766}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600767
Tobin Ehlis554bf382016-05-24 11:14:43 -0600768bool cvdescriptorset::ValidateImageUpdate(VkImageView image_view, VkImageLayout image_layout, VkDescriptorType type,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700769 const layer_data *dev_data, UNIQUE_VALIDATION_ERROR_CODE *error_code,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600770 std::string *error_msg) {
771 // TODO : Defaulting to 00943 for all cases here. Need to create new error codes for various cases.
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600772 *error_code = VALIDATION_ERROR_15c0028c;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700773 auto iv_state = GetImageViewState(dev_data, image_view);
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600774 if (!iv_state) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600775 std::stringstream error_str;
776 error_str << "Invalid VkImageView: " << image_view;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600777 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600778 return false;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600779 }
Tobin Ehlis81280962016-07-20 14:04:20 -0600780 // 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 -0600781 // Validate that imageLayout is compatible with aspect_mask and image format
782 // and validate that image usage bits are correct for given usage
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600783 VkImageAspectFlags aspect_mask = iv_state->create_info.subresourceRange.aspectMask;
784 VkImage image = iv_state->create_info.image;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600785 VkFormat format = VK_FORMAT_MAX_ENUM;
786 VkImageUsageFlags usage = 0;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700787 auto image_node = GetImageState(dev_data, image);
Tobin Ehlis1c9c55f2016-06-02 11:49:22 -0600788 if (image_node) {
789 format = image_node->createInfo.format;
790 usage = image_node->createInfo.usage;
Tobin Ehlis029d2fe2016-09-21 09:19:15 -0600791 // Validate that memory is bound to image
Tobin Ehlis2cb8eb22017-01-03 14:09:57 -0700792 // TODO: This should have its own valid usage id apart from 2524 which is from CreateImageView case. The only
793 // the error here occurs is if memory bound to a created imageView has been freed.
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600794 if (ValidateMemoryIsBoundToImage(dev_data, image_node, "vkUpdateDescriptorSets()", VALIDATION_ERROR_0ac007f8)) {
795 *error_code = VALIDATION_ERROR_0ac007f8;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600796 *error_msg = "No memory bound to image.";
Tobin Ehlis029d2fe2016-09-21 09:19:15 -0600797 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -0600798 }
Tobin Ehlis1809f912016-05-25 09:24:36 -0600799 }
800 // First validate that format and layout are compatible
801 if (format == VK_FORMAT_MAX_ENUM) {
802 std::stringstream error_str;
803 error_str << "Invalid image (" << image << ") in imageView (" << image_view << ").";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600804 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600805 return false;
806 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600807 // TODO : The various image aspect and format checks here are based on general spec language in 11.5 Image Views section under
808 // vkCreateImageView(). What's the best way to create unique id for these cases?
Dave Houlton1d2022c2017-03-29 11:43:58 -0600809 bool ds = FormatIsDepthOrStencil(format);
Tobin Ehlis1809f912016-05-25 09:24:36 -0600810 switch (image_layout) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700811 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
812 // Only Color bit must be set
813 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobin Ehlis1809f912016-05-25 09:24:36 -0600814 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700815 error_str << "ImageView (" << image_view << ") uses layout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL but does "
816 "not have VK_IMAGE_ASPECT_COLOR_BIT set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600817 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600818 return false;
819 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700820 // format must NOT be DS
821 if (ds) {
822 std::stringstream error_str;
823 error_str << "ImageView (" << image_view
824 << ") uses layout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL but the image format is "
825 << string_VkFormat(format) << " which is not a color format.";
826 *error_msg = error_str.str();
827 return false;
828 }
829 break;
830 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
831 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
832 // Depth or stencil bit must be set, but both must NOT be set
Tobin Ehlisbbf3f912016-06-15 13:03:58 -0600833 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
834 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
835 // both must NOT be set
836 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700837 error_str << "ImageView (" << image_view << ") has both STENCIL and DEPTH aspects set";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600838 *error_msg = error_str.str();
Tobin Ehlisbbf3f912016-06-15 13:03:58 -0600839 return false;
840 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700841 } else if (!(aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
842 // Neither were set
843 std::stringstream error_str;
844 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
845 << " but does not have STENCIL or DEPTH aspects set";
846 *error_msg = error_str.str();
847 return false;
Tobin Ehlisbbf3f912016-06-15 13:03:58 -0600848 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700849 // format must be DS
850 if (!ds) {
851 std::stringstream error_str;
852 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
853 << " but the image format is " << string_VkFormat(format) << " which is not a depth/stencil format.";
854 *error_msg = error_str.str();
855 return false;
856 }
857 break;
858 default:
859 // For other layouts if the source is depth/stencil image, both aspect bits must not be set
860 if (ds) {
861 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
862 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
863 // both must NOT be set
864 std::stringstream error_str;
865 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
866 << " and is using depth/stencil image of format " << string_VkFormat(format)
867 << " but it has both STENCIL and DEPTH aspects set, which is illegal. When using a depth/stencil "
868 "image in a descriptor set, please only set either VK_IMAGE_ASPECT_DEPTH_BIT or "
869 "VK_IMAGE_ASPECT_STENCIL_BIT depending on whether it will be used for depth reads or stencil "
870 "reads respectively.";
871 *error_msg = error_str.str();
872 return false;
873 }
874 }
875 }
876 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600877 }
878 // Now validate that usage flags are correctly set for given type of update
Tobin Ehlisfb4cf712016-10-10 14:02:48 -0600879 // 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 -0600880 // TODO : The various image usage bit requirements are in general spec language for VkImageUsageFlags bit block in 11.3 Images
881 // under vkCreateImage()
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600882 // TODO : Need to also validate case VALIDATION_ERROR_15c002a0 where STORAGE_IMAGE & INPUT_ATTACH types must have been created
883 // with identify swizzle
Tobin Ehlis1809f912016-05-25 09:24:36 -0600884 std::string error_usage_bit;
885 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700886 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
887 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
888 if (!(usage & VK_IMAGE_USAGE_SAMPLED_BIT)) {
889 error_usage_bit = "VK_IMAGE_USAGE_SAMPLED_BIT";
890 }
891 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600892 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700893 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
894 if (!(usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
895 error_usage_bit = "VK_IMAGE_USAGE_STORAGE_BIT";
896 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
897 std::stringstream error_str;
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600898 // TODO : Need to create custom enum error codes for these cases
899 if (image_node->shared_presentable) {
900 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != image_layout) {
901 error_str
902 << "ImageView (" << image_view
903 << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type with a front-buffered image is being updated with "
904 "layout "
905 << string_VkImageLayout(image_layout)
906 << " but according to spec section 13.1 Descriptor Types, 'Front-buffered images that report support "
907 "for "
908 "VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT must be in the VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR layout.'";
909 *error_msg = error_str.str();
910 return false;
911 }
912 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
913 error_str
914 << "ImageView (" << image_view << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type is being updated with layout "
915 << string_VkImageLayout(image_layout)
916 << " but according to spec section 13.1 Descriptor Types, 'Load and store operations on storage images can "
917 "only be done on images in VK_IMAGE_LAYOUT_GENERAL layout.'";
918 *error_msg = error_str.str();
919 return false;
920 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700921 }
922 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600923 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700924 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT: {
925 if (!(usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) {
926 error_usage_bit = "VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT";
927 }
928 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600929 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700930 default:
931 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600932 }
933 if (!error_usage_bit.empty()) {
934 std::stringstream error_str;
935 error_str << "ImageView (" << image_view << ") with usage mask 0x" << usage
936 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
937 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600938 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600939 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600940 }
941 return true;
942}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600943
Tobin Ehlis300888c2016-05-18 13:43:26 -0600944void cvdescriptorset::SamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
945 sampler_ = update->pImageInfo[index].sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600946 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600947}
948
Tobin Ehlis300888c2016-05-18 13:43:26 -0600949void cvdescriptorset::SamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600950 if (!immutable_) {
951 auto update_sampler = static_cast<const SamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600952 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600953 }
954 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600955}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600956
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700957void cvdescriptorset::SamplerDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600958 if (!immutable_) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700959 auto sampler_state = GetSamplerState(dev_data, sampler_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700960 if (sampler_state) core_validation::AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600961 }
962}
963
Tobin Ehlis300888c2016-05-18 13:43:26 -0600964cvdescriptorset::ImageSamplerDescriptor::ImageSamplerDescriptor(const VkSampler *immut)
Chris Forbes9f340852017-05-09 08:51:38 -0700965 : sampler_(VK_NULL_HANDLE), immutable_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600966 updated = false;
967 descriptor_class = ImageSampler;
968 if (immut) {
969 sampler_ = *immut;
970 immutable_ = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600971 }
972}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600973
Tobin Ehlis300888c2016-05-18 13:43:26 -0600974void cvdescriptorset::ImageSamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600975 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600976 const auto &image_info = update->pImageInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -0600977 sampler_ = image_info.sampler;
978 image_view_ = image_info.imageView;
979 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600980}
981
Tobin Ehlis300888c2016-05-18 13:43:26 -0600982void cvdescriptorset::ImageSamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600983 if (!immutable_) {
984 auto update_sampler = static_cast<const ImageSamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600985 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600986 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600987 auto image_view = static_cast<const ImageSamplerDescriptor *>(src)->image_view_;
988 auto image_layout = static_cast<const ImageSamplerDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600989 updated = true;
990 image_view_ = image_view;
991 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600992}
993
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700994void cvdescriptorset::ImageSamplerDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -0600995 // First add binding for any non-immutable sampler
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600996 if (!immutable_) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700997 auto sampler_state = GetSamplerState(dev_data, sampler_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700998 if (sampler_state) core_validation::AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600999 }
Tobin Ehlis81e46372016-08-17 13:33:44 -06001000 // Add binding for image
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001001 auto iv_state = GetImageViewState(dev_data, image_view_);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001002 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -06001003 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001004 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001005}
1006
Tobin Ehlis300888c2016-05-18 13:43:26 -06001007cvdescriptorset::ImageDescriptor::ImageDescriptor(const VkDescriptorType type)
1008 : storage_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001009 updated = false;
1010 descriptor_class = Image;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001011 if (VK_DESCRIPTOR_TYPE_STORAGE_IMAGE == type) storage_ = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001012};
1013
Tobin Ehlis300888c2016-05-18 13:43:26 -06001014void cvdescriptorset::ImageDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001015 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001016 const auto &image_info = update->pImageInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001017 image_view_ = image_info.imageView;
1018 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001019}
1020
Tobin Ehlis300888c2016-05-18 13:43:26 -06001021void cvdescriptorset::ImageDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001022 auto image_view = static_cast<const ImageDescriptor *>(src)->image_view_;
1023 auto image_layout = static_cast<const ImageDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001024 updated = true;
1025 image_view_ = image_view;
1026 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001027}
1028
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001029void cvdescriptorset::ImageDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -06001030 // Add binding for image
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001031 auto iv_state = GetImageViewState(dev_data, image_view_);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001032 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -06001033 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001034 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001035}
1036
Tobin Ehlis300888c2016-05-18 13:43:26 -06001037cvdescriptorset::BufferDescriptor::BufferDescriptor(const VkDescriptorType type)
1038 : storage_(false), dynamic_(false), buffer_(VK_NULL_HANDLE), offset_(0), range_(0) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001039 updated = false;
1040 descriptor_class = GeneralBuffer;
1041 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
1042 dynamic_ = true;
1043 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type) {
1044 storage_ = true;
1045 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
1046 dynamic_ = true;
1047 storage_ = true;
1048 }
1049}
Tobin Ehlis300888c2016-05-18 13:43:26 -06001050void cvdescriptorset::BufferDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001051 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001052 const auto &buffer_info = update->pBufferInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001053 buffer_ = buffer_info.buffer;
1054 offset_ = buffer_info.offset;
1055 range_ = buffer_info.range;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001056}
1057
Tobin Ehlis300888c2016-05-18 13:43:26 -06001058void cvdescriptorset::BufferDescriptor::CopyUpdate(const Descriptor *src) {
1059 auto buff_desc = static_cast<const BufferDescriptor *>(src);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001060 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001061 buffer_ = buff_desc->buffer_;
1062 offset_ = buff_desc->offset_;
1063 range_ = buff_desc->range_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001064}
1065
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001066void cvdescriptorset::BufferDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001067 auto buffer_node = GetBufferState(dev_data, buffer_);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001068 if (buffer_node) core_validation::AddCommandBufferBindingBuffer(dev_data, cb_node, buffer_node);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001069}
1070
Tobin Ehlis300888c2016-05-18 13:43:26 -06001071cvdescriptorset::TexelDescriptor::TexelDescriptor(const VkDescriptorType type) : buffer_view_(VK_NULL_HANDLE), storage_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001072 updated = false;
1073 descriptor_class = TexelBuffer;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001074 if (VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER == type) storage_ = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001075};
Tobin Ehlis56a30942016-05-19 08:00:00 -06001076
Tobin Ehlis300888c2016-05-18 13:43:26 -06001077void cvdescriptorset::TexelDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001078 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001079 buffer_view_ = update->pTexelBufferView[index];
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001080}
1081
Tobin Ehlis300888c2016-05-18 13:43:26 -06001082void cvdescriptorset::TexelDescriptor::CopyUpdate(const Descriptor *src) {
1083 updated = true;
1084 buffer_view_ = static_cast<const TexelDescriptor *>(src)->buffer_view_;
1085}
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001086
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001087void cvdescriptorset::TexelDescriptor::BindCommandBuffer(const layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001088 auto bv_state = GetBufferViewState(dev_data, buffer_view_);
Tobin Ehlis8b872462016-09-14 08:12:08 -06001089 if (bv_state) {
Tobin Ehlis2515c0e2016-09-28 07:12:28 -06001090 core_validation::AddCommandBufferBindingBufferView(dev_data, cb_node, bv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001091 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001092}
1093
Tobin Ehlis300888c2016-05-18 13:43:26 -06001094// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1095// sets, and then calls their respective Validate[Write|Copy]Update functions.
1096// If the update hits an issue for which the callback returns "true", meaning that the call down the chain should
1097// be skipped, then true is returned.
1098// If there is no issue with the update, then false is returned.
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001099bool cvdescriptorset::ValidateUpdateDescriptorSets(const debug_report_data *report_data, const layer_data *dev_data,
1100 uint32_t write_count, const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001101 const VkCopyDescriptorSet *p_cds) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001102 bool skip = false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001103 // Validate Write updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001104 for (uint32_t i = 0; i < write_count; i++) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001105 auto dest_set = p_wds[i].dstSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001106 auto set_node = core_validation::GetSetNode(dev_data, dest_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001107 if (!set_node) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001108 skip |=
Tobin Ehlis300888c2016-05-18 13:43:26 -06001109 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02001110 HandleToUint64(dest_set), __LINE__, DRAWSTATE_INVALID_DESCRIPTOR_SET, "DS",
Tobin Ehlis300888c2016-05-18 13:43:26 -06001111 "Cannot call vkUpdateDescriptorSets() on descriptor set 0x%" PRIxLEAST64 " that has not been allocated.",
Petr Krausbc7f5442017-05-14 23:43:38 +02001112 HandleToUint64(dest_set));
Tobin Ehlis300888c2016-05-18 13:43:26 -06001113 } else {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001114 UNIQUE_VALIDATION_ERROR_CODE error_code;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001115 std::string error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001116 if (!set_node->ValidateWriteUpdate(report_data, &p_wds[i], &error_code, &error_str)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001117 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02001118 HandleToUint64(dest_set), __LINE__, error_code, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001119 "vkUpdateDescriptorsSets() failed write update validation for Descriptor Set 0x%" PRIx64
1120 " with error: %s. %s",
Petr Krausbc7f5442017-05-14 23:43:38 +02001121 HandleToUint64(dest_set), error_str.c_str(), validation_error_map[error_code]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001122 }
1123 }
1124 }
1125 // Now validate copy updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001126 for (uint32_t i = 0; i < copy_count; ++i) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001127 auto dst_set = p_cds[i].dstSet;
1128 auto src_set = p_cds[i].srcSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001129 auto src_node = core_validation::GetSetNode(dev_data, src_set);
1130 auto dst_node = core_validation::GetSetNode(dev_data, dst_set);
Tobin Ehlisa1712752017-01-04 09:41:47 -07001131 // Object_tracker verifies that src & dest descriptor set are valid
1132 assert(src_node);
1133 assert(dst_node);
1134 UNIQUE_VALIDATION_ERROR_CODE error_code;
1135 std::string error_str;
1136 if (!dst_node->ValidateCopyUpdate(report_data, &p_cds[i], src_node, &error_code, &error_str)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001137 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02001138 HandleToUint64(dst_set), __LINE__, error_code, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001139 "vkUpdateDescriptorsSets() failed copy update from Descriptor Set 0x%" PRIx64
1140 " to Descriptor Set 0x%" PRIx64 " with error: %s. %s",
Petr Krausbc7f5442017-05-14 23:43:38 +02001141 HandleToUint64(src_set), HandleToUint64(dst_set), error_str.c_str(), validation_error_map[error_code]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001142 }
1143 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001144 return skip;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001145}
1146// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1147// sets, and then calls their respective Perform[Write|Copy]Update functions.
1148// Prerequisite : ValidateUpdateDescriptorSets() should be called and return "false" prior to calling PerformUpdateDescriptorSets()
1149// with the same set of updates.
1150// This is split from the validate code to allow validation prior to calling down the chain, and then update after
1151// calling down the chain.
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001152void cvdescriptorset::PerformUpdateDescriptorSets(const layer_data *dev_data, uint32_t write_count,
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001153 const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
1154 const VkCopyDescriptorSet *p_cds) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001155 // Write updates first
1156 uint32_t i = 0;
1157 for (i = 0; i < write_count; ++i) {
1158 auto dest_set = p_wds[i].dstSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001159 auto set_node = core_validation::GetSetNode(dev_data, dest_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001160 if (set_node) {
1161 set_node->PerformWriteUpdate(&p_wds[i]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001162 }
1163 }
1164 // Now copy updates
1165 for (i = 0; i < copy_count; ++i) {
1166 auto dst_set = p_cds[i].dstSet;
1167 auto src_set = p_cds[i].srcSet;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001168 auto src_node = core_validation::GetSetNode(dev_data, src_set);
1169 auto dst_node = core_validation::GetSetNode(dev_data, dst_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001170 if (src_node && dst_node) {
1171 dst_node->PerformCopyUpdate(&p_cds[i], src_node);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001172 }
1173 }
1174}
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001175// This helper function carries out the state updates for descriptor updates peformed via update templates. It basically collects
1176// data and leverages the PerformUpdateDescriptor helper functions to do this.
1177void cvdescriptorset::PerformUpdateDescriptorSetsWithTemplateKHR(layer_data *device_data, VkDescriptorSet descriptorSet,
1178 std::unique_ptr<TEMPLATE_STATE> const &template_state,
1179 const void *pData) {
1180 auto const &create_info = template_state->create_info;
1181
1182 // Create a vector of write structs
1183 std::vector<VkWriteDescriptorSet> desc_writes;
1184 auto layout_obj = GetDescriptorSetLayout(device_data, create_info.descriptorSetLayout);
1185
1186 // Create a WriteDescriptorSet struct for each template update entry
1187 for (uint32_t i = 0; i < create_info.descriptorUpdateEntryCount; i++) {
1188 auto binding_count = layout_obj->GetDescriptorCountFromBinding(create_info.pDescriptorUpdateEntries[i].dstBinding);
1189 auto binding_being_updated = create_info.pDescriptorUpdateEntries[i].dstBinding;
1190 auto dst_array_element = create_info.pDescriptorUpdateEntries[i].dstArrayElement;
1191
1192 for (uint32_t j = 0; j < create_info.pDescriptorUpdateEntries[i].descriptorCount; j++) {
1193 desc_writes.emplace_back();
1194 auto &write_entry = desc_writes.back();
1195
1196 size_t offset = create_info.pDescriptorUpdateEntries[i].offset + j * create_info.pDescriptorUpdateEntries[i].stride;
1197 char *update_entry = (char *)(pData) + offset;
1198
1199 if (dst_array_element >= binding_count) {
1200 dst_array_element = 0;
Mark Lobodzinski4aa479d2017-03-10 09:14:00 -07001201 binding_being_updated = layout_obj->GetNextValidBinding(binding_being_updated);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001202 }
1203
1204 write_entry.sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
1205 write_entry.pNext = NULL;
1206 write_entry.dstSet = descriptorSet;
1207 write_entry.dstBinding = binding_being_updated;
1208 write_entry.dstArrayElement = dst_array_element;
1209 write_entry.descriptorCount = 1;
1210 write_entry.descriptorType = create_info.pDescriptorUpdateEntries[i].descriptorType;
1211
1212 switch (create_info.pDescriptorUpdateEntries[i].descriptorType) {
1213 case VK_DESCRIPTOR_TYPE_SAMPLER:
1214 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
1215 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1216 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
1217 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
1218 write_entry.pImageInfo = reinterpret_cast<VkDescriptorImageInfo *>(update_entry);
1219 break;
1220
1221 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1222 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1223 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1224 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1225 write_entry.pBufferInfo = reinterpret_cast<VkDescriptorBufferInfo *>(update_entry);
1226 break;
1227
1228 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1229 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1230 write_entry.pTexelBufferView = reinterpret_cast<VkBufferView *>(update_entry);
1231 break;
1232 default:
1233 assert(0);
1234 break;
1235 }
1236 dst_array_element++;
1237 }
1238 }
1239 PerformUpdateDescriptorSets(device_data, static_cast<uint32_t>(desc_writes.size()), desc_writes.data(), 0, NULL);
1240}
Tobin Ehlis300888c2016-05-18 13:43:26 -06001241// Validate the state for a given write update but don't actually perform the update
1242// If an error would occur for this update, return false and fill in details in error_msg string
1243bool cvdescriptorset::DescriptorSet::ValidateWriteUpdate(const debug_report_data *report_data, const VkWriteDescriptorSet *update,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001244 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001245 // Verify idle ds
1246 if (in_use.load()) {
Tobin Ehlis2cb8eb22017-01-03 14:09:57 -07001247 // TODO : Re-using Free Idle error code, need write update idle error code
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001248 *error_code = VALIDATION_ERROR_2860026a;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001249 std::stringstream error_str;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001250 error_str << "Cannot call vkUpdateDescriptorSets() to perform write update on descriptor set " << set_
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001251 << " that is in use by a command buffer";
Tobin Ehlis300888c2016-05-18 13:43:26 -06001252 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001253 return false;
1254 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001255 // Verify dst binding exists
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001256 if (!p_layout_->HasBinding(update->dstBinding)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001257 *error_code = VALIDATION_ERROR_15c00276;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001258 std::stringstream error_str;
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001259 error_str << "DescriptorSet " << set_ << " does not have binding " << update->dstBinding;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001260 *error_msg = error_str.str();
1261 return false;
Tobin Ehlis59a5efc2016-11-21 09:41:57 -07001262 } else {
1263 // Make sure binding isn't empty
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001264 if (0 == p_layout_->GetDescriptorCountFromBinding(update->dstBinding)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001265 *error_code = VALIDATION_ERROR_15c00278;
Tobin Ehlis59a5efc2016-11-21 09:41:57 -07001266 std::stringstream error_str;
1267 error_str << "DescriptorSet " << set_ << " cannot updated binding " << update->dstBinding << " that has 0 descriptors";
1268 *error_msg = error_str.str();
1269 return false;
1270 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001271 }
1272 // We know that binding is valid, verify update and do update on each descriptor
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001273 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
1274 auto type = p_layout_->GetTypeFromBinding(update->dstBinding);
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001275 if (type != update->descriptorType) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001276 *error_code = VALIDATION_ERROR_15c0027e;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001277 std::stringstream error_str;
1278 error_str << "Attempting write update to descriptor set " << set_ << " binding #" << update->dstBinding << " with type "
1279 << string_VkDescriptorType(type) << " but update type is " << string_VkDescriptorType(update->descriptorType);
1280 *error_msg = error_str.str();
1281 return false;
1282 }
Tobin Ehlis7b402352016-12-15 07:51:20 -07001283 if (update->descriptorCount > (descriptors_.size() - start_idx)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001284 *error_code = VALIDATION_ERROR_15c00282;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001285 std::stringstream error_str;
1286 error_str << "Attempting write update to descriptor set " << set_ << " binding #" << update->dstBinding << " with "
Tobin Ehlis7b402352016-12-15 07:51:20 -07001287 << descriptors_.size() - start_idx
Tobin Ehlisf922ef82016-11-30 10:19:14 -07001288 << " descriptors in that binding and all successive bindings of the set, but update of "
1289 << update->descriptorCount << " descriptors combined with update array element offset of "
1290 << update->dstArrayElement << " oversteps the available number of consecutive descriptors";
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001291 *error_msg = error_str.str();
1292 return false;
1293 }
1294 // Verify consecutive bindings match (if needed)
Tobin Ehlis7cd8c792017-06-20 08:30:39 -06001295 if (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "write update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001296 set_, error_msg)) {
Tobin Ehlis48fbd692017-01-04 09:17:01 -07001297 // TODO : Should break out "consecutive binding updates" language into valid usage statements
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001298 *error_code = VALIDATION_ERROR_15c00282;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001299 return false;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001300 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001301 // Update is within bounds and consistent so last step is to validate update contents
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001302 if (!VerifyWriteUpdateContents(update, start_idx, error_code, error_msg)) {
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001303 std::stringstream error_str;
1304 error_str << "Write update to descriptor in set " << set_ << " binding #" << update->dstBinding
1305 << " failed with error message: " << error_msg->c_str();
1306 *error_msg = error_str.str();
1307 return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001308 }
1309 // All checks passed, update is clean
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001310 return true;
Tobin Ehlis03d61de2016-05-17 08:31:46 -06001311}
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001312// For the given buffer, verify that its creation parameters are appropriate for the given type
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001313// 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 -07001314bool cvdescriptorset::DescriptorSet::ValidateBufferUsage(BUFFER_STATE const *buffer_node, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001315 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) const {
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001316 // Verify that usage bits set correctly for given type
Tobin Ehlis94bc5d22016-06-02 07:46:52 -06001317 auto usage = buffer_node->createInfo.usage;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001318 std::string error_usage_bit;
1319 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001320 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1321 if (!(usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001322 *error_code = VALIDATION_ERROR_15c0029c;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001323 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT";
1324 }
1325 break;
1326 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1327 if (!(usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001328 *error_code = VALIDATION_ERROR_15c0029e;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001329 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT";
1330 }
1331 break;
1332 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1333 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1334 if (!(usage & VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001335 *error_code = VALIDATION_ERROR_15c00292;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001336 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT";
1337 }
1338 break;
1339 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1340 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1341 if (!(usage & VK_BUFFER_USAGE_STORAGE_BUFFER_BIT)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001342 *error_code = VALIDATION_ERROR_15c00296;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001343 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_BUFFER_BIT";
1344 }
1345 break;
1346 default:
1347 break;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001348 }
1349 if (!error_usage_bit.empty()) {
1350 std::stringstream error_str;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001351 error_str << "Buffer (" << buffer_node->buffer << ") with usage mask 0x" << usage
1352 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
1353 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001354 *error_msg = error_str.str();
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001355 return false;
1356 }
1357 return true;
1358}
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001359// For buffer descriptor updates, verify the buffer usage and VkDescriptorBufferInfo struct which includes:
1360// 1. buffer is valid
1361// 2. buffer was created with correct usage flags
1362// 3. offset is less than buffer size
1363// 4. range is either VK_WHOLE_SIZE or falls in (0, (buffer size - offset)]
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001364// 5. range and offset are within the device's limits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001365// 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 -06001366bool cvdescriptorset::DescriptorSet::ValidateBufferUpdate(VkDescriptorBufferInfo const *buffer_info, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001367 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) const {
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001368 // First make sure that buffer is valid
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001369 auto buffer_node = GetBufferState(device_data_, buffer_info->buffer);
Tobin Ehlisfa8b6182016-12-22 13:40:45 -07001370 // Any invalid buffer should already be caught by object_tracker
1371 assert(buffer_node);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001372 if (ValidateMemoryIsBoundToBuffer(device_data_, buffer_node, "vkUpdateDescriptorSets()", VALIDATION_ERROR_15c00294)) {
1373 *error_code = VALIDATION_ERROR_15c00294;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001374 *error_msg = "No memory bound to buffer.";
Tobin Ehlis81280962016-07-20 14:04:20 -06001375 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001376 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001377 // Verify usage bits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001378 if (!ValidateBufferUsage(buffer_node, type, error_code, error_msg)) {
1379 // error_msg will have been updated by ValidateBufferUsage()
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001380 return false;
1381 }
1382 // offset must be less than buffer size
Jeremy Hayesd1a6a822017-03-09 14:39:45 -07001383 if (buffer_info->offset >= buffer_node->createInfo.size) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001384 *error_code = VALIDATION_ERROR_044002a8;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001385 std::stringstream error_str;
Jeremy Hayesd1a6a822017-03-09 14:39:45 -07001386 error_str << "VkDescriptorBufferInfo offset of " << buffer_info->offset << " is greater than or equal to buffer "
1387 << buffer_node->buffer << " size of " << buffer_node->createInfo.size;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001388 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001389 return false;
1390 }
1391 if (buffer_info->range != VK_WHOLE_SIZE) {
1392 // Range must be VK_WHOLE_SIZE or > 0
1393 if (!buffer_info->range) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001394 *error_code = VALIDATION_ERROR_044002aa;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001395 std::stringstream error_str;
1396 error_str << "VkDescriptorBufferInfo range is not VK_WHOLE_SIZE and is zero, which is not allowed.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001397 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001398 return false;
1399 }
1400 // Range must be VK_WHOLE_SIZE or <= (buffer size - offset)
1401 if (buffer_info->range > (buffer_node->createInfo.size - buffer_info->offset)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001402 *error_code = VALIDATION_ERROR_044002ac;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001403 std::stringstream error_str;
1404 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range << " which is greater than buffer size ("
1405 << buffer_node->createInfo.size << ") minus requested offset of " << buffer_info->offset;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001406 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001407 return false;
1408 }
1409 }
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001410 // Check buffer update sizes against device limits
1411 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER == type || VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
1412 auto max_ub_range = limits_.maxUniformBufferRange;
1413 // TODO : If range is WHOLE_SIZE, need to make sure underlying buffer size doesn't exceed device max
1414 if (buffer_info->range != VK_WHOLE_SIZE && buffer_info->range > max_ub_range) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001415 *error_code = VALIDATION_ERROR_15c00298;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001416 std::stringstream error_str;
1417 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range
1418 << " which is greater than this device's maxUniformBufferRange (" << max_ub_range << ")";
1419 *error_msg = error_str.str();
1420 return false;
1421 }
1422 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type || VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
1423 auto max_sb_range = limits_.maxStorageBufferRange;
1424 // TODO : If range is WHOLE_SIZE, need to make sure underlying buffer size doesn't exceed device max
1425 if (buffer_info->range != VK_WHOLE_SIZE && buffer_info->range > max_sb_range) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001426 *error_code = VALIDATION_ERROR_15c0029a;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001427 std::stringstream error_str;
1428 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range
1429 << " which is greater than this device's maxStorageBufferRange (" << max_sb_range << ")";
1430 *error_msg = error_str.str();
1431 return false;
1432 }
1433 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001434 return true;
1435}
1436
Tobin Ehlis300888c2016-05-18 13:43:26 -06001437// Verify that the contents of the update are ok, but don't perform actual update
1438bool cvdescriptorset::DescriptorSet::VerifyWriteUpdateContents(const VkWriteDescriptorSet *update, const uint32_t index,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001439 UNIQUE_VALIDATION_ERROR_CODE *error_code,
1440 std::string *error_msg) const {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001441 switch (update->descriptorType) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001442 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
1443 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1444 // Validate image
1445 auto image_view = update->pImageInfo[di].imageView;
1446 auto image_layout = update->pImageInfo[di].imageLayout;
1447 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001448 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001449 error_str << "Attempted write update to combined image sampler descriptor failed due to: "
1450 << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001451 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001452 return false;
1453 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001454 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001455 // Intentional fall-through to validate sampler
Tobin Ehlis300888c2016-05-18 13:43:26 -06001456 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001457 case VK_DESCRIPTOR_TYPE_SAMPLER: {
1458 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1459 if (!descriptors_[index + di].get()->IsImmutableSampler()) {
1460 if (!ValidateSampler(update->pImageInfo[di].sampler, device_data_)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001461 *error_code = VALIDATION_ERROR_15c0028a;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001462 std::stringstream error_str;
1463 error_str << "Attempted write update to sampler descriptor with invalid sampler: "
1464 << update->pImageInfo[di].sampler << ".";
1465 *error_msg = error_str.str();
1466 return false;
1467 }
1468 } else {
1469 // TODO : Warn here
1470 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001471 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001472 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001473 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001474 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1475 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
1476 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
1477 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1478 auto image_view = update->pImageInfo[di].imageView;
1479 auto image_layout = update->pImageInfo[di].imageLayout;
1480 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, error_code, error_msg)) {
1481 std::stringstream error_str;
1482 error_str << "Attempted write update to image descriptor failed due to: " << error_msg->c_str();
1483 *error_msg = error_str.str();
1484 return false;
1485 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001486 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001487 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001488 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001489 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1490 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER: {
1491 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1492 auto buffer_view = update->pTexelBufferView[di];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001493 auto bv_state = GetBufferViewState(device_data_, buffer_view);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001494 if (!bv_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001495 *error_code = VALIDATION_ERROR_15c00286;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001496 std::stringstream error_str;
1497 error_str << "Attempted write update to texel buffer descriptor with invalid buffer view: " << buffer_view;
1498 *error_msg = error_str.str();
1499 return false;
1500 }
1501 auto buffer = bv_state->create_info.buffer;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001502 if (!ValidateBufferUsage(GetBufferState(device_data_, buffer), update->descriptorType, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001503 std::stringstream error_str;
1504 error_str << "Attempted write update to texel buffer descriptor failed due to: " << error_msg->c_str();
1505 *error_msg = error_str.str();
1506 return false;
1507 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001508 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001509 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001510 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001511 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1512 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1513 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1514 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC: {
1515 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1516 if (!ValidateBufferUpdate(update->pBufferInfo + di, update->descriptorType, error_code, error_msg)) {
1517 std::stringstream error_str;
1518 error_str << "Attempted write update to buffer descriptor failed due to: " << error_msg->c_str();
1519 *error_msg = error_str.str();
1520 return false;
1521 }
1522 }
1523 break;
1524 }
1525 default:
1526 assert(0); // We've already verified update type so should never get here
1527 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001528 }
1529 // All checks passed so update contents are good
1530 return true;
1531}
1532// Verify that the contents of the update are ok, but don't perform actual update
1533bool cvdescriptorset::DescriptorSet::VerifyCopyUpdateContents(const VkCopyDescriptorSet *update, const DescriptorSet *src_set,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001534 VkDescriptorType type, uint32_t index,
1535 UNIQUE_VALIDATION_ERROR_CODE *error_code,
1536 std::string *error_msg) const {
1537 // Note : Repurposing some Write update error codes here as specific details aren't called out for copy updates like they are
1538 // for write updates
Tobin Ehlis300888c2016-05-18 13:43:26 -06001539 switch (src_set->descriptors_[index]->descriptor_class) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001540 case PlainSampler: {
1541 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1542 if (!src_set->descriptors_[index + di]->IsImmutableSampler()) {
1543 auto update_sampler = static_cast<SamplerDescriptor *>(src_set->descriptors_[index + di].get())->GetSampler();
1544 if (!ValidateSampler(update_sampler, device_data_)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001545 *error_code = VALIDATION_ERROR_15c0028a;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001546 std::stringstream error_str;
1547 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
1548 *error_msg = error_str.str();
1549 return false;
1550 }
1551 } else {
1552 // TODO : Warn here
1553 }
1554 }
1555 break;
1556 }
1557 case ImageSampler: {
1558 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1559 auto img_samp_desc = static_cast<const ImageSamplerDescriptor *>(src_set->descriptors_[index + di].get());
1560 // First validate sampler
1561 if (!img_samp_desc->IsImmutableSampler()) {
1562 auto update_sampler = img_samp_desc->GetSampler();
1563 if (!ValidateSampler(update_sampler, device_data_)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001564 *error_code = VALIDATION_ERROR_15c0028a;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001565 std::stringstream error_str;
1566 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
1567 *error_msg = error_str.str();
1568 return false;
1569 }
1570 } else {
1571 // TODO : Warn here
1572 }
1573 // Validate image
1574 auto image_view = img_samp_desc->GetImageView();
1575 auto image_layout = img_samp_desc->GetImageLayout();
1576 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001577 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001578 error_str << "Attempted copy update to combined image sampler descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001579 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001580 return false;
1581 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001582 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001583 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001584 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001585 case Image: {
1586 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1587 auto img_desc = static_cast<const ImageDescriptor *>(src_set->descriptors_[index + di].get());
1588 auto image_view = img_desc->GetImageView();
1589 auto image_layout = img_desc->GetImageLayout();
1590 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001591 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001592 error_str << "Attempted copy update to image descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001593 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001594 return false;
1595 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001596 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001597 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001598 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001599 case TexelBuffer: {
1600 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1601 auto buffer_view = static_cast<TexelDescriptor *>(src_set->descriptors_[index + di].get())->GetBufferView();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001602 auto bv_state = GetBufferViewState(device_data_, buffer_view);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001603 if (!bv_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001604 *error_code = VALIDATION_ERROR_15c00286;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001605 std::stringstream error_str;
1606 error_str << "Attempted copy update to texel buffer descriptor with invalid buffer view: " << buffer_view;
1607 *error_msg = error_str.str();
1608 return false;
1609 }
1610 auto buffer = bv_state->create_info.buffer;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001611 if (!ValidateBufferUsage(GetBufferState(device_data_, buffer), type, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001612 std::stringstream error_str;
1613 error_str << "Attempted copy update to texel buffer descriptor failed due to: " << error_msg->c_str();
1614 *error_msg = error_str.str();
1615 return false;
1616 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001617 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001618 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001619 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001620 case GeneralBuffer: {
1621 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1622 auto buffer = static_cast<BufferDescriptor *>(src_set->descriptors_[index + di].get())->GetBuffer();
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001623 if (!ValidateBufferUsage(GetBufferState(device_data_, buffer), type, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001624 std::stringstream error_str;
1625 error_str << "Attempted copy update to buffer descriptor failed due to: " << error_msg->c_str();
1626 *error_msg = error_str.str();
1627 return false;
1628 }
Tobin Ehliscbcf2342016-05-24 13:07:12 -06001629 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001630 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001631 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001632 default:
1633 assert(0); // We've already verified update type so should never get here
1634 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001635 }
1636 // All checks passed so update contents are good
1637 return true;
Chris Forbesb4e0bdb2016-05-31 16:34:40 +12001638}
Tobin Ehlisf320b192017-03-14 11:22:50 -06001639// Update the common AllocateDescriptorSetsData
1640void cvdescriptorset::UpdateAllocateDescriptorSetsData(const layer_data *dev_data, const VkDescriptorSetAllocateInfo *p_alloc_info,
1641 AllocateDescriptorSetsData *ds_data) {
1642 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
1643 auto layout = GetDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
1644 if (layout) {
1645 ds_data->layout_nodes[i] = layout;
1646 // Count total descriptors required per type
1647 for (uint32_t j = 0; j < layout->GetBindingCount(); ++j) {
1648 const auto &binding_layout = layout->GetDescriptorSetLayoutBindingPtrFromIndex(j);
1649 uint32_t typeIndex = static_cast<uint32_t>(binding_layout->descriptorType);
1650 ds_data->required_descriptors_by_type[typeIndex] += binding_layout->descriptorCount;
1651 }
1652 }
1653 // Any unknown layouts will be flagged as errors during ValidateAllocateDescriptorSets() call
1654 }
1655};
Tobin Ehlisee471462016-05-26 11:21:59 -06001656// Verify that the state at allocate time is correct, but don't actually allocate the sets yet
Tobin Ehlisf320b192017-03-14 11:22:50 -06001657bool cvdescriptorset::ValidateAllocateDescriptorSets(const core_validation::layer_data *dev_data,
1658 const VkDescriptorSetAllocateInfo *p_alloc_info,
1659 const AllocateDescriptorSetsData *ds_data) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001660 bool skip = false;
Tobin Ehlisf320b192017-03-14 11:22:50 -06001661 auto report_data = core_validation::GetReportData(dev_data);
Tobin Ehlisee471462016-05-26 11:21:59 -06001662
1663 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001664 auto layout = GetDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
Tobin Ehlis815e8132016-06-02 13:02:17 -06001665 if (!layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001666 skip |=
Tobin Ehlisee471462016-05-26 11:21:59 -06001667 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02001668 HandleToUint64(p_alloc_info->pSetLayouts[i]), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
Tobin Ehlisee471462016-05-26 11:21:59 -06001669 "Unable to find set layout node for layout 0x%" PRIxLEAST64 " specified in vkAllocateDescriptorSets() call",
Petr Krausbc7f5442017-05-14 23:43:38 +02001670 HandleToUint64(p_alloc_info->pSetLayouts[i]));
Tobin Ehlisee471462016-05-26 11:21:59 -06001671 }
1672 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001673 if (!GetDeviceExtensions(dev_data)->vk_khr_maintenance1) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001674 auto pool_state = GetDescriptorPoolState(dev_data, p_alloc_info->descriptorPool);
1675 // Track number of descriptorSets allowable in this pool
1676 if (pool_state->availableSets < p_alloc_info->descriptorSetCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001677 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001678 HandleToUint64(pool_state->pool), __LINE__, VALIDATION_ERROR_04c00264, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001679 "Unable to allocate %u descriptorSets from pool 0x%" PRIxLEAST64
1680 ". This pool only has %d descriptorSets remaining. %s",
Petr Krausbc7f5442017-05-14 23:43:38 +02001681 p_alloc_info->descriptorSetCount, HandleToUint64(pool_state->pool), pool_state->availableSets,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001682 validation_error_map[VALIDATION_ERROR_04c00264]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001683 }
1684 // Determine whether descriptor counts are satisfiable
1685 for (uint32_t i = 0; i < VK_DESCRIPTOR_TYPE_RANGE_SIZE; i++) {
1686 if (ds_data->required_descriptors_by_type[i] > pool_state->availableDescriptorTypeCount[i]) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001687 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001688 HandleToUint64(pool_state->pool), __LINE__, VALIDATION_ERROR_04c00266, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001689 "Unable to allocate %u descriptors of type %s from pool 0x%" PRIxLEAST64
1690 ". This pool only has %d descriptors of this type remaining. %s",
1691 ds_data->required_descriptors_by_type[i], string_VkDescriptorType(VkDescriptorType(i)),
Petr Krausbc7f5442017-05-14 23:43:38 +02001692 HandleToUint64(pool_state->pool), pool_state->availableDescriptorTypeCount[i],
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001693 validation_error_map[VALIDATION_ERROR_04c00266]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001694 }
Tobin Ehlisee471462016-05-26 11:21:59 -06001695 }
1696 }
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001697
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001698 return skip;
Tobin Ehlisee471462016-05-26 11:21:59 -06001699}
1700// Decrement allocated sets from the pool and insert new sets into set_map
Tobin Ehlis4e380592016-06-02 12:41:47 -06001701void cvdescriptorset::PerformAllocateDescriptorSets(const VkDescriptorSetAllocateInfo *p_alloc_info,
1702 const VkDescriptorSet *descriptor_sets,
1703 const AllocateDescriptorSetsData *ds_data,
Tobin Ehlisbd711bd2016-10-12 14:27:30 -06001704 std::unordered_map<VkDescriptorPool, DESCRIPTOR_POOL_STATE *> *pool_map,
Tobin Ehlis4e380592016-06-02 12:41:47 -06001705 std::unordered_map<VkDescriptorSet, cvdescriptorset::DescriptorSet *> *set_map,
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001706 const layer_data *dev_data) {
Tobin Ehlisee471462016-05-26 11:21:59 -06001707 auto pool_state = (*pool_map)[p_alloc_info->descriptorPool];
Mark Lobodzinskic9430182017-06-13 13:00:05 -06001708 // Account for sets and individual descriptors allocated from pool
Tobin Ehlisee471462016-05-26 11:21:59 -06001709 pool_state->availableSets -= p_alloc_info->descriptorSetCount;
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001710 for (uint32_t i = 0; i < VK_DESCRIPTOR_TYPE_RANGE_SIZE; i++) {
1711 pool_state->availableDescriptorTypeCount[i] -= ds_data->required_descriptors_by_type[i];
1712 }
Mark Lobodzinskic9430182017-06-13 13:00:05 -06001713 // Create tracking object for each descriptor set; insert into global map and the pool's set.
Tobin Ehlisee471462016-05-26 11:21:59 -06001714 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Tobin Ehlis93f22372016-10-12 14:34:12 -06001715 auto new_ds = new cvdescriptorset::DescriptorSet(descriptor_sets[i], p_alloc_info->descriptorPool, ds_data->layout_nodes[i],
1716 dev_data);
Tobin Ehlisee471462016-05-26 11:21:59 -06001717
1718 pool_state->sets.insert(new_ds);
1719 new_ds->in_use.store(0);
1720 (*set_map)[descriptor_sets[i]] = new_ds;
1721 }
1722}