blob: de9f2f120ac5b2588c7293e3c48b993d12e747eb [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
21#include "descriptor_sets.h"
22#include "vk_enum_string_helper.h"
23#include "vk_safe_struct.h"
24#include <sstream>
25
26// Construct DescriptorSetLayout instance from given create info
27cvdescriptorset::DescriptorSetLayout::DescriptorSetLayout(debug_report_data *report_data,
28 const VkDescriptorSetLayoutCreateInfo *p_create_info,
29 const VkDescriptorSetLayout layout)
30 : layout_(layout), binding_count_(p_create_info->bindingCount), descriptor_count_(0), dynamic_descriptor_count_(0) {
31 uint32_t global_index = 0;
32 for (uint32_t i = 0; i < binding_count_; ++i) {
33 descriptor_count_ += p_create_info->pBindings[i].descriptorCount;
34 if (!binding_to_index_map_.emplace(p_create_info->pBindings[i].binding, i).second) {
35 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT,
36 reinterpret_cast<uint64_t &>(layout_), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
37 "duplicated binding number in "
38 "VkDescriptorSetLayoutBinding");
39 }
40 binding_to_global_start_index_map_[p_create_info->pBindings[i].binding] = global_index;
41 global_index += p_create_info->pBindings[i].descriptorCount ? p_create_info->pBindings[i].descriptorCount - 1 : 0;
42 binding_to_global_end_index_map_[p_create_info->pBindings[i].binding] = global_index;
43 global_index++;
Tobin Ehlis664e6012016-05-05 11:04:44 -060044 bindings_.push_back(safe_VkDescriptorSetLayoutBinding(&p_create_info->pBindings[i]));
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060045 // In cases where we should ignore pImmutableSamplers make sure it's NULL
46 if ((p_create_info->pBindings[i].pImmutableSamplers) &&
47 ((p_create_info->pBindings[i].descriptorType != VK_DESCRIPTOR_TYPE_SAMPLER) &&
48 (p_create_info->pBindings[i].descriptorType != VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER))) {
Tobin Ehlis664e6012016-05-05 11:04:44 -060049 bindings_.back().pImmutableSamplers = nullptr;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060050 }
51 if (p_create_info->pBindings[i].descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
52 p_create_info->pBindings[i].descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC) {
Tobin Ehlisef0de162016-06-20 13:07:34 -060053 dynamic_descriptor_count_ += p_create_info->pBindings[i].descriptorCount;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060054 }
55 }
56}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060057// put all bindings into the given set
58void cvdescriptorset::DescriptorSetLayout::FillBindingSet(std::unordered_set<uint32_t> *binding_set) const {
59 for (auto binding_index_pair : binding_to_index_map_)
60 binding_set->insert(binding_index_pair.first);
61}
Tobin Ehlis56a30942016-05-19 08:00:00 -060062
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060063VkDescriptorSetLayoutBinding const *
64cvdescriptorset::DescriptorSetLayout::GetDescriptorSetLayoutBindingPtrFromBinding(const uint32_t binding) const {
Tobin Ehlis0bc30632016-05-05 10:16:02 -060065 const auto &bi_itr = binding_to_index_map_.find(binding);
66 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -060067 return bindings_[bi_itr->second].ptr();
Tobin Ehlis0bc30632016-05-05 10:16:02 -060068 }
69 return nullptr;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060070}
71VkDescriptorSetLayoutBinding const *
72cvdescriptorset::DescriptorSetLayout::GetDescriptorSetLayoutBindingPtrFromIndex(const uint32_t index) const {
73 if (index >= bindings_.size())
74 return nullptr;
Tobin Ehlis664e6012016-05-05 11:04:44 -060075 return bindings_[index].ptr();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060076}
77// Return descriptorCount for given binding, 0 if index is unavailable
78uint32_t cvdescriptorset::DescriptorSetLayout::GetDescriptorCountFromBinding(const uint32_t binding) const {
Tobin Ehlis0bc30632016-05-05 10:16:02 -060079 const auto &bi_itr = binding_to_index_map_.find(binding);
80 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -060081 return bindings_[bi_itr->second].descriptorCount;
Tobin Ehlis0bc30632016-05-05 10:16:02 -060082 }
83 return 0;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060084}
85// Return descriptorCount for given index, 0 if index is unavailable
86uint32_t cvdescriptorset::DescriptorSetLayout::GetDescriptorCountFromIndex(const uint32_t index) const {
87 if (index >= bindings_.size())
88 return 0;
Tobin Ehlis664e6012016-05-05 11:04:44 -060089 return bindings_[index].descriptorCount;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060090}
91// For the given binding, return descriptorType
92VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromBinding(const uint32_t binding) const {
93 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -060094 const auto &bi_itr = binding_to_index_map_.find(binding);
95 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -060096 return bindings_[bi_itr->second].descriptorType;
Tobin Ehlis0bc30632016-05-05 10:16:02 -060097 }
98 return VK_DESCRIPTOR_TYPE_MAX_ENUM;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060099}
100// For the given index, return descriptorType
101VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromIndex(const uint32_t index) const {
102 assert(index < bindings_.size());
Tobin Ehlis664e6012016-05-05 11:04:44 -0600103 return bindings_[index].descriptorType;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600104}
105// For the given global index, return descriptorType
106// Currently just counting up through bindings_, may improve this in future
107VkDescriptorType cvdescriptorset::DescriptorSetLayout::GetTypeFromGlobalIndex(const uint32_t index) const {
108 uint32_t global_offset = 0;
109 for (auto binding : bindings_) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600110 global_offset += binding.descriptorCount;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600111 if (index < global_offset)
Tobin Ehlis664e6012016-05-05 11:04:44 -0600112 return binding.descriptorType;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600113 }
114 assert(0); // requested global index is out of bounds
115 return VK_DESCRIPTOR_TYPE_MAX_ENUM;
116}
117// For the given binding, return stageFlags
118VkShaderStageFlags cvdescriptorset::DescriptorSetLayout::GetStageFlagsFromBinding(const uint32_t binding) const {
119 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600120 const auto &bi_itr = binding_to_index_map_.find(binding);
121 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600122 return bindings_[bi_itr->second].stageFlags;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600123 }
124 return VkShaderStageFlags(0);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600125}
126// For the given binding, return start index
127uint32_t cvdescriptorset::DescriptorSetLayout::GetGlobalStartIndexFromBinding(const uint32_t binding) const {
128 assert(binding_to_global_start_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600129 const auto &btgsi_itr = binding_to_global_start_index_map_.find(binding);
130 if (btgsi_itr != binding_to_global_start_index_map_.end()) {
131 return btgsi_itr->second;
132 }
133 // In error case max uint32_t so index is out of bounds to break ASAP
Tobin Ehlis58c59582016-06-21 12:34:33 -0600134 assert(0);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600135 return 0xFFFFFFFF;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600136}
137// For the given binding, return end index
138uint32_t cvdescriptorset::DescriptorSetLayout::GetGlobalEndIndexFromBinding(const uint32_t binding) const {
139 assert(binding_to_global_end_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600140 const auto &btgei_itr = binding_to_global_end_index_map_.find(binding);
141 if (btgei_itr != binding_to_global_end_index_map_.end()) {
142 return btgei_itr->second;
143 }
144 // In error case max uint32_t so index is out of bounds to break ASAP
Tobin Ehlis58c59582016-06-21 12:34:33 -0600145 assert(0);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600146 return 0xFFFFFFFF;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600147}
148// For given binding, return ptr to ImmutableSampler array
149VkSampler const *cvdescriptorset::DescriptorSetLayout::GetImmutableSamplerPtrFromBinding(const uint32_t binding) const {
150 assert(binding_to_index_map_.count(binding));
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600151 const auto &bi_itr = binding_to_index_map_.find(binding);
152 if (bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600153 return bindings_[bi_itr->second].pImmutableSamplers;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600154 }
155 return nullptr;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600156}
157// For given index, return ptr to ImmutableSampler array
158VkSampler const *cvdescriptorset::DescriptorSetLayout::GetImmutableSamplerPtrFromIndex(const uint32_t index) const {
159 assert(index < bindings_.size());
Tobin Ehlis664e6012016-05-05 11:04:44 -0600160 return bindings_[index].pImmutableSamplers;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600161}
162// If our layout is compatible with rh_ds_layout, return true,
163// else return false and fill in error_msg will description of what causes incompatibility
164bool cvdescriptorset::DescriptorSetLayout::IsCompatible(const DescriptorSetLayout *rh_ds_layout, std::string *error_msg) const {
165 // Trivial case
166 if (layout_ == rh_ds_layout->GetDescriptorSetLayout())
167 return true;
168 if (descriptor_count_ != rh_ds_layout->descriptor_count_) {
169 std::stringstream error_str;
170 error_str << "DescriptorSetLayout " << layout_ << " has " << descriptor_count_ << " descriptors, but DescriptorSetLayout "
171 << rh_ds_layout->GetDescriptorSetLayout() << " has " << rh_ds_layout->descriptor_count_ << " descriptors.";
172 *error_msg = error_str.str();
173 return false; // trivial fail case
174 }
175 // Descriptor counts match so need to go through bindings one-by-one
176 // and verify that type and stageFlags match
177 for (auto binding : bindings_) {
178 // TODO : Do we also need to check immutable samplers?
179 // VkDescriptorSetLayoutBinding *rh_binding;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600180 if (binding.descriptorCount != rh_ds_layout->GetDescriptorCountFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600181 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600182 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " has a descriptorCount of "
183 << binding.descriptorCount << " but binding " << binding.binding << " for DescriptorSetLayout "
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600184 << rh_ds_layout->GetDescriptorSetLayout() << " has a descriptorCount of "
Tobin Ehlis664e6012016-05-05 11:04:44 -0600185 << rh_ds_layout->GetDescriptorCountFromBinding(binding.binding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600186 *error_msg = error_str.str();
187 return false;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600188 } else if (binding.descriptorType != rh_ds_layout->GetTypeFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600189 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600190 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " is type '"
191 << string_VkDescriptorType(binding.descriptorType) << "' but binding " << binding.binding
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600192 << " for DescriptorSetLayout " << rh_ds_layout->GetDescriptorSetLayout() << " is type '"
Tobin Ehlis664e6012016-05-05 11:04:44 -0600193 << string_VkDescriptorType(rh_ds_layout->GetTypeFromBinding(binding.binding)) << "'";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600194 *error_msg = error_str.str();
195 return false;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600196 } else if (binding.stageFlags != rh_ds_layout->GetStageFlagsFromBinding(binding.binding)) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600197 std::stringstream error_str;
Tobin Ehlis664e6012016-05-05 11:04:44 -0600198 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << layout_ << " has stageFlags "
199 << binding.stageFlags << " but binding " << binding.binding << " for DescriptorSetLayout "
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600200 << rh_ds_layout->GetDescriptorSetLayout() << " has stageFlags "
Tobin Ehlis664e6012016-05-05 11:04:44 -0600201 << rh_ds_layout->GetStageFlagsFromBinding(binding.binding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600202 *error_msg = error_str.str();
203 return false;
204 }
205 }
206 return true;
207}
208
209bool cvdescriptorset::DescriptorSetLayout::IsNextBindingConsistent(const uint32_t binding) const {
210 if (!binding_to_index_map_.count(binding + 1))
211 return false;
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600212 auto const &bi_itr = binding_to_index_map_.find(binding);
213 if (bi_itr != binding_to_index_map_.end()) {
214 const auto &next_bi_itr = binding_to_index_map_.find(binding + 1);
215 if (next_bi_itr != binding_to_index_map_.end()) {
Tobin Ehlis664e6012016-05-05 11:04:44 -0600216 auto type = bindings_[bi_itr->second].descriptorType;
217 auto stage_flags = bindings_[bi_itr->second].stageFlags;
218 auto immut_samp = bindings_[bi_itr->second].pImmutableSamplers ? true : false;
219 if ((type != bindings_[next_bi_itr->second].descriptorType) ||
220 (stage_flags != bindings_[next_bi_itr->second].stageFlags) ||
221 (immut_samp != (bindings_[next_bi_itr->second].pImmutableSamplers ? true : false))) {
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600222 return false;
223 }
224 return true;
225 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600226 }
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600227 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600228}
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600229// Starting at offset descriptor of given binding, parse over update_count
230// descriptor updates and verify that for any binding boundaries that are crossed, the next binding(s) are all consistent
231// Consistency means that their type, stage flags, and whether or not they use immutable samplers matches
232// If so, return true. If not, fill in error_msg and return false
233bool cvdescriptorset::DescriptorSetLayout::VerifyUpdateConsistency(uint32_t current_binding, uint32_t offset, uint32_t update_count,
234 const char *type, const VkDescriptorSet set,
235 std::string *error_msg) const {
236 // Verify consecutive bindings match (if needed)
237 auto orig_binding = current_binding;
238 // Track count of descriptors in the current_bindings that are remaining to be updated
239 auto binding_remaining = GetDescriptorCountFromBinding(current_binding);
240 // First, it's legal to offset beyond your own binding so handle that case
241 // Really this is just searching for the binding in which the update begins and adjusting offset accordingly
242 while (offset >= binding_remaining) {
243 // Advance to next binding, decrement offset by binding size
244 offset -= binding_remaining;
245 binding_remaining = GetDescriptorCountFromBinding(++current_binding);
246 }
247 binding_remaining -= offset;
248 while (update_count > binding_remaining) { // While our updates overstep current binding
249 // Verify next consecutive binding matches type, stage flags & immutable sampler use
250 if (!IsNextBindingConsistent(current_binding++)) {
251 std::stringstream error_str;
252 error_str << "Attempting " << type << " descriptor set " << set << " binding #" << orig_binding << " with #"
253 << update_count << " descriptors being updated but this update oversteps the bounds of this binding and the "
254 "next binding is not consistent with current binding so this update is invalid.";
255 *error_msg = error_str.str();
256 return false;
257 }
258 // For sake of this check consider the bindings updated and grab count for next binding
259 update_count -= binding_remaining;
260 binding_remaining = GetDescriptorCountFromBinding(current_binding);
261 }
262 return true;
263}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600264
Tobin Ehlis68d0adf2016-06-01 11:33:50 -0600265cvdescriptorset::AllocateDescriptorSetsData::AllocateDescriptorSetsData(uint32_t count)
266 : required_descriptors_by_type{}, layout_nodes(count, nullptr) {}
267
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600268cvdescriptorset::DescriptorSet::DescriptorSet(const VkDescriptorSet set, const DescriptorSetLayout *layout,
Tobin Ehlis4e380592016-06-02 12:41:47 -0600269 const core_validation::layer_data *dev_data)
270 : some_update_(false), set_(set), p_layout_(layout), device_data_(dev_data) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600271 // Foreach binding, create default descriptors of given type
272 for (uint32_t i = 0; i < p_layout_->GetBindingCount(); ++i) {
273 auto type = p_layout_->GetTypeFromIndex(i);
274 switch (type) {
275 case VK_DESCRIPTOR_TYPE_SAMPLER: {
276 auto immut_sampler = p_layout_->GetImmutableSamplerPtrFromIndex(i);
277 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
278 if (immut_sampler)
Chris Forbescb621ea2016-05-30 11:47:31 +1200279 descriptors_.emplace_back(new SamplerDescriptor(immut_sampler + di));
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600280 else
Chris Forbescb621ea2016-05-30 11:47:31 +1200281 descriptors_.emplace_back(new SamplerDescriptor());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600282 }
283 break;
284 }
285 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
286 auto immut = p_layout_->GetImmutableSamplerPtrFromIndex(i);
287 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
288 if (immut)
Chris Forbescb621ea2016-05-30 11:47:31 +1200289 descriptors_.emplace_back(new ImageSamplerDescriptor(immut + di));
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600290 else
Chris Forbescb621ea2016-05-30 11:47:31 +1200291 descriptors_.emplace_back(new ImageSamplerDescriptor());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600292 }
293 break;
294 }
295 // ImageDescriptors
296 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
297 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
298 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
299 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Chris Forbescb621ea2016-05-30 11:47:31 +1200300 descriptors_.emplace_back(new ImageDescriptor(type));
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600301 break;
302 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
303 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
304 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Chris Forbescb621ea2016-05-30 11:47:31 +1200305 descriptors_.emplace_back(new TexelDescriptor(type));
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600306 break;
307 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
308 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
309 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
310 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
311 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Chris Forbescb621ea2016-05-30 11:47:31 +1200312 descriptors_.emplace_back(new BufferDescriptor(type));
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600313 break;
314 default:
Tobin Ehlis81f17852016-05-05 09:04:33 -0600315 assert(0); // Bad descriptor type specified
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600316 break;
317 }
318 }
319}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600320
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600321cvdescriptorset::DescriptorSet::~DescriptorSet() {
322 InvalidateBoundCmdBuffers();
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600323}
Chris Forbes57989132016-07-26 17:06:10 +1200324
325
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700326static std::string string_descriptor_req_view_type(descriptor_req req) {
327 std::string result("");
Chris Forbes57989132016-07-26 17:06:10 +1200328 for (unsigned i = 0; i <= VK_IMAGE_VIEW_TYPE_END_RANGE; i++) {
329 if (req & (1 << i)) {
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700330 if (result.size()) result += ", ";
331 result += string_VkImageViewType(VkImageViewType(i));
Chris Forbes57989132016-07-26 17:06:10 +1200332 }
333 }
334
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700335 if (!result.size())
336 result = "(none)";
337
338 return result;
Chris Forbes57989132016-07-26 17:06:10 +1200339}
340
341
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600342// Is this sets underlying layout compatible with passed in layout according to "Pipeline Layout Compatibility" in spec?
343bool cvdescriptorset::DescriptorSet::IsCompatible(const DescriptorSetLayout *layout, std::string *error) const {
344 return layout->IsCompatible(p_layout_, error);
345}
Chris Forbes57989132016-07-26 17:06:10 +1200346
Tobin Ehlis3066db62016-08-22 08:12:23 -0600347// 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 -0600348// This includes validating that all descriptors in the given bindings are updated,
349// that any update buffers are valid, and that any dynamic offsets are within the bounds of their buffers.
350// Return true if state is acceptable, or false and write an error message into error string
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600351bool cvdescriptorset::DescriptorSet::ValidateDrawState(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600352 const std::vector<uint32_t> &dynamic_offsets, std::string *error) const {
iostrows5eb97652016-06-02 15:56:26 +0200353 auto dyn_offset_index = 0;
Chris Forbesc7090a82016-07-25 18:10:41 +1200354 for (auto binding_pair : bindings) {
355 auto binding = binding_pair.first;
Tobin Ehlis58c59582016-06-21 12:34:33 -0600356 if (!p_layout_->HasBinding(binding)) {
357 std::stringstream error_str;
358 error_str << "Attempting to validate DrawState for binding #" << binding
359 << " which is an invalid binding for this descriptor set.";
360 *error = error_str.str();
361 return false;
362 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600363 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
Tobin Ehlis81f17852016-05-05 09:04:33 -0600364 if (descriptors_[start_idx]->IsImmutableSampler()) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600365 // Nothing to do for strictly immutable sampler
366 } else {
367 auto end_idx = p_layout_->GetGlobalEndIndexFromBinding(binding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600368 for (uint32_t i = start_idx; i <= end_idx; ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600369 if (!descriptors_[i]->updated) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600370 std::stringstream error_str;
371 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
372 << " is being used in draw but has not been updated.";
373 *error = error_str.str();
374 return false;
375 } else {
Chris Forbes57989132016-07-26 17:06:10 +1200376 auto descriptor_class = descriptors_[i]->GetClass();
377 if (descriptor_class == GeneralBuffer) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600378 // Verify that buffers are valid
Tobin Ehlis81f17852016-05-05 09:04:33 -0600379 auto buffer = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetBuffer();
Tobin Ehlis94bc5d22016-06-02 07:46:52 -0600380 auto buffer_node = getBufferNode(device_data_, buffer);
381 if (!buffer_node) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600382 std::stringstream error_str;
383 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
384 << " references invalid buffer " << buffer << ".";
385 *error = error_str.str();
386 return false;
387 } else {
Tobin Ehlis997b2582016-06-02 08:43:37 -0600388 auto mem_entry = getMemObjInfo(device_data_, buffer_node->mem);
389 if (!mem_entry) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600390 std::stringstream error_str;
391 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
Tobin Ehlis94bc5d22016-06-02 07:46:52 -0600392 << " uses buffer " << buffer << " that references invalid memory " << buffer_node->mem
393 << ".";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600394 *error = error_str.str();
395 return false;
396 }
397 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600398 if (descriptors_[i]->IsDynamic()) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600399 // Validate that dynamic offsets are within the buffer
Tobin Ehlis94bc5d22016-06-02 07:46:52 -0600400 auto buffer_size = buffer_node->createInfo.size;
Tobin Ehlis81f17852016-05-05 09:04:33 -0600401 auto range = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetRange();
402 auto desc_offset = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetOffset();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600403 auto dyn_offset = dynamic_offsets[dyn_offset_index++];
404 if (VK_WHOLE_SIZE == range) {
405 if ((dyn_offset + desc_offset) > buffer_size) {
406 std::stringstream error_str;
407 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
408 << " uses buffer " << buffer
409 << " with update range of VK_WHOLE_SIZE has dynamic offset " << dyn_offset
410 << " combined with offset " << desc_offset << " that oversteps the buffer size of "
411 << buffer_size << ".";
412 *error = error_str.str();
413 return false;
414 }
415 } else {
416 if ((dyn_offset + desc_offset + range) > buffer_size) {
417 std::stringstream error_str;
418 error_str << "Dynamic descriptor in binding #" << binding << " at global descriptor index " << i
419 << " uses buffer " << buffer << " with dynamic offset " << dyn_offset
420 << " combined with offset " << desc_offset << " and range " << range
421 << " that oversteps the buffer size of " << buffer_size << ".";
422 *error = error_str.str();
423 return false;
424 }
425 }
426 }
427 }
Chris Forbes57989132016-07-26 17:06:10 +1200428 else if (descriptor_class == ImageSampler || descriptor_class == Image) {
429 auto image_view = (descriptor_class == ImageSampler)
430 ? static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetImageView()
431 : static_cast<ImageDescriptor *>(descriptors_[i].get())->GetImageView();
432 auto reqs = binding_pair.second;
433
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600434 auto image_view_state = getImageViewState(device_data_, image_view);
435 assert(image_view_state);
436 auto image_view_ci = image_view_state->create_info;
Chris Forbes57989132016-07-26 17:06:10 +1200437
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600438 if ((reqs & DESCRIPTOR_REQ_ALL_VIEW_TYPE_BITS) && (~reqs & (1 << image_view_ci.viewType))) {
Chris Forbes57989132016-07-26 17:06:10 +1200439 // bad view type
440 std::stringstream error_str;
441 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
442 << " requires an image view of type " << string_descriptor_req_view_type(reqs)
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600443 << " but got " << string_VkImageViewType(image_view_ci.viewType) << ".";
Chris Forbes57989132016-07-26 17:06:10 +1200444 *error = error_str.str();
445 return false;
446 }
447
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600448 auto image_node = getImageNode(device_data_, image_view_ci.image);
Chris Forbes57989132016-07-26 17:06:10 +1200449 assert(image_node);
450
451 if ((reqs & DESCRIPTOR_REQ_SINGLE_SAMPLE) &&
452 image_node->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
453 std::stringstream error_str;
454 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
455 << " requires bound image to have VK_SAMPLE_COUNT_1_BIT but got "
456 << string_VkSampleCountFlagBits(image_node->createInfo.samples) << ".";
457 *error = error_str.str();
458 return false;
459 }
460
461 if ((reqs & DESCRIPTOR_REQ_MULTI_SAMPLE) &&
462 image_node->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
463 std::stringstream error_str;
464 error_str << "Descriptor in binding #" << binding << " at global descriptor index " << i
465 << " requires bound image to have multiple samples, but got VK_SAMPLE_COUNT_1_BIT.";
466 *error = error_str.str();
467 return false;
468 }
469 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600470 }
471 }
472 }
473 }
474 return true;
475}
Chris Forbes57989132016-07-26 17:06:10 +1200476
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600477// For given bindings, place any update buffers or images into the passed-in unordered_sets
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600478uint32_t cvdescriptorset::DescriptorSet::GetStorageUpdates(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600479 std::unordered_set<VkBuffer> *buffer_set,
480 std::unordered_set<VkImageView> *image_set) const {
481 auto num_updates = 0;
Chris Forbesc7090a82016-07-25 18:10:41 +1200482 for (auto binding_pair : bindings) {
483 auto binding = binding_pair.first;
Tobin Ehlis58c59582016-06-21 12:34:33 -0600484 // If a binding doesn't exist, skip it
485 if (!p_layout_->HasBinding(binding)) {
486 continue;
487 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600488 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
Tobin Ehlis81f17852016-05-05 09:04:33 -0600489 if (descriptors_[start_idx]->IsStorage()) {
490 if (Image == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600491 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600492 if (descriptors_[start_idx + i]->updated) {
493 image_set->insert(static_cast<ImageDescriptor *>(descriptors_[start_idx + i].get())->GetImageView());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600494 num_updates++;
495 }
496 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600497 } else if (TexelBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600498 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600499 if (descriptors_[start_idx + i]->updated) {
500 auto bufferview = static_cast<TexelDescriptor *>(descriptors_[start_idx + i].get())->GetBufferView();
Tobin Ehlis8b872462016-09-14 08:12:08 -0600501 auto bv_state = getBufferViewState(device_data_, bufferview);
502 if (bv_state) {
503 buffer_set->insert(bv_state->create_info.buffer);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600504 num_updates++;
505 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600506 }
507 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600508 } else if (GeneralBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600509 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600510 if (descriptors_[start_idx + i]->updated) {
511 buffer_set->insert(static_cast<BufferDescriptor *>(descriptors_[start_idx + i].get())->GetBuffer());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600512 num_updates++;
513 }
514 }
515 }
516 }
517 }
518 return num_updates;
519}
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600520// Set is being deleted or updates so invalidate all bound cmd buffers
521void cvdescriptorset::DescriptorSet::InvalidateBoundCmdBuffers() {
Tobin Ehlis2556f5b2016-06-24 17:22:16 -0600522 core_validation::invalidateCommandBuffers(cb_bindings,
523 {reinterpret_cast<uint64_t &>(set_), VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT});
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600524}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600525// Perform write update in given update struct
Tobin Ehlis300888c2016-05-18 13:43:26 -0600526void cvdescriptorset::DescriptorSet::PerformWriteUpdate(const VkWriteDescriptorSet *update) {
Tobin Ehlis300888c2016-05-18 13:43:26 -0600527 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
528 // perform update
529 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
530 descriptors_[start_idx + di]->WriteUpdate(update, di);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600531 }
Tobin Ehlis56a30942016-05-19 08:00:00 -0600532 if (update->descriptorCount)
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600533 some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600534
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600535 InvalidateBoundCmdBuffers();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600536}
Tobin Ehlis300888c2016-05-18 13:43:26 -0600537// Validate Copy update
538bool cvdescriptorset::DescriptorSet::ValidateCopyUpdate(const debug_report_data *report_data, const VkCopyDescriptorSet *update,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600539 const DescriptorSet *src_set, UNIQUE_VALIDATION_ERROR_CODE *error_code,
540 std::string *error_msg) {
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600541 // Verify idle ds
542 if (in_use.load()) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600543 // TODO : Re-using Allocate Idle error code, need copy update idle error code
544 *error_code = VALIDATION_ERROR_00919;
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600545 std::stringstream error_str;
546 error_str << "Cannot call vkUpdateDescriptorSets() to perform copy update on descriptor set " << set_
547 << " that is in use by a command buffer.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600548 *error_msg = error_str.str();
Tobin Ehlis03d61de2016-05-17 08:31:46 -0600549 return false;
550 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600551 if (!p_layout_->HasBinding(update->dstBinding)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600552 *error_code = VALIDATION_ERROR_00966;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600553 std::stringstream error_str;
554 error_str << "DescriptorSet " << set_ << " does not have copy update dest binding of " << update->dstBinding << ".";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600555 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600556 return false;
557 }
558 if (!src_set->HasBinding(update->srcBinding)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600559 *error_code = VALIDATION_ERROR_00964;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600560 std::stringstream error_str;
561 error_str << "DescriptorSet " << set_ << " does not have copy update src binding of " << update->srcBinding << ".";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600562 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600563 return false;
564 }
565 // src & dst set bindings are valid
566 // Check bounds of src & dst
567 auto src_start_idx = src_set->GetGlobalStartIndexFromBinding(update->srcBinding) + update->srcArrayElement;
568 if ((src_start_idx + update->descriptorCount) > src_set->GetTotalDescriptorCount()) {
569 // SRC update out of bounds
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600570 *error_code = VALIDATION_ERROR_00965;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600571 std::stringstream error_str;
572 error_str << "Attempting copy update from descriptorSet " << update->srcSet << " binding#" << update->srcBinding
573 << " with offset index of " << src_set->GetGlobalStartIndexFromBinding(update->srcBinding)
574 << " plus update array offset of " << update->srcArrayElement << " and update of " << update->descriptorCount
575 << " descriptors oversteps total number of descriptors in set: " << src_set->GetTotalDescriptorCount() << ".";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600576 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600577 return false;
578 }
579 auto dst_start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
580 if ((dst_start_idx + update->descriptorCount) > p_layout_->GetTotalDescriptorCount()) {
581 // DST update out of bounds
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600582 *error_code = VALIDATION_ERROR_00967;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600583 std::stringstream error_str;
584 error_str << "Attempting copy update to descriptorSet " << set_ << " binding#" << update->dstBinding
585 << " with offset index of " << p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding)
586 << " plus update array offset of " << update->dstArrayElement << " and update of " << update->descriptorCount
587 << " descriptors oversteps total number of descriptors in set: " << p_layout_->GetTotalDescriptorCount() << ".";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600588 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600589 return false;
590 }
591 // Check that types match
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600592 // TODO : Base default error case going from here is VALIDATION_ERROR_00968 which covers all consistency issues, need more
593 // fine-grained error codes
594 *error_code = VALIDATION_ERROR_00968;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600595 auto src_type = src_set->GetTypeFromBinding(update->srcBinding);
596 auto dst_type = p_layout_->GetTypeFromBinding(update->dstBinding);
597 if (src_type != dst_type) {
598 std::stringstream error_str;
599 error_str << "Attempting copy update to descriptorSet " << set_ << " binding #" << update->dstBinding << " with type "
600 << string_VkDescriptorType(dst_type) << " from descriptorSet " << src_set->GetSet() << " binding #"
601 << update->srcBinding << " with type " << string_VkDescriptorType(src_type) << ". Types do not match.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600602 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600603 return false;
604 }
605 // Verify consistency of src & dst bindings if update crosses binding boundaries
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600606 if ((!src_set->GetLayout()->VerifyUpdateConsistency(update->srcBinding, update->srcArrayElement, update->descriptorCount,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600607 "copy update from", src_set->GetSet(), error_msg)) ||
Tobin Ehlis1f946f82016-05-05 12:03:44 -0600608 (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "copy update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600609 set_, error_msg))) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600610 return false;
611 }
Tobin Ehlisd41e7b62016-05-19 07:56:18 -0600612 // First make sure source descriptors are updated
613 for (uint32_t i = 0; i < update->descriptorCount; ++i) {
614 if (!src_set->descriptors_[src_start_idx + i]) {
615 std::stringstream error_str;
616 error_str << "Attempting copy update from descriptorSet " << src_set << " binding #" << update->srcBinding << " but descriptor at array offset "
617 << update->srcArrayElement + i << " has not been updated.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600618 *error_msg = error_str.str();
Tobin Ehlisd41e7b62016-05-19 07:56:18 -0600619 return false;
620 }
621 }
622 // Update parameters all look good and descriptor updated so verify update contents
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600623 if (!VerifyCopyUpdateContents(update, src_set, src_type, src_start_idx, error_code, error_msg))
Tobin Ehlis300888c2016-05-18 13:43:26 -0600624 return false;
625
626 // All checks passed so update is good
627 return true;
628}
629// Perform Copy update
630void cvdescriptorset::DescriptorSet::PerformCopyUpdate(const VkCopyDescriptorSet *update, const DescriptorSet *src_set) {
Tobin Ehlis300888c2016-05-18 13:43:26 -0600631 auto src_start_idx = src_set->GetGlobalStartIndexFromBinding(update->srcBinding) + update->srcArrayElement;
632 auto dst_start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600633 // Update parameters all look good so perform update
634 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Tobin Ehlis300888c2016-05-18 13:43:26 -0600635 descriptors_[dst_start_idx + di]->CopyUpdate(src_set->descriptors_[src_start_idx + di].get());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600636 }
Tobin Ehlis56a30942016-05-19 08:00:00 -0600637 if (update->descriptorCount)
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600638 some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600639
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600640 InvalidateBoundCmdBuffers();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600641}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600642
Tobin Ehlisf9519102016-08-17 09:49:13 -0600643// Bind cb_node to this set and this set to cb_node.
644// Prereq: This should be called for a set that has been confirmed to be active for the given cb_node, meaning it's going
645// to be used in a draw by the given cb_node
Tobin Ehlisf9519102016-08-17 09:49:13 -0600646void cvdescriptorset::DescriptorSet::BindCommandBuffer(GLOBAL_CB_NODE *cb_node, const std::unordered_set<uint32_t> &bindings) {
Tobin Ehlis9252c2b2016-07-21 14:40:22 -0600647 // bind cb to this descriptor set
648 cb_bindings.insert(cb_node);
649 // Add bindings for descriptor set and individual objects in the set
650 cb_node->object_bindings.insert({reinterpret_cast<uint64_t &>(set_), VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT});
Tobin Ehlisf9519102016-08-17 09:49:13 -0600651 // For the active slots, use set# to look up descriptorSet from boundDescriptorSets, and bind all of that descriptor set's
652 // resources
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600653 for (auto binding : bindings) {
654 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(binding);
655 auto end_idx = p_layout_->GetGlobalEndIndexFromBinding(binding);
656 for (uint32_t i = start_idx; i <= end_idx; ++i) {
657 descriptors_[i]->BindCommandBuffer(device_data_, cb_node);
658 }
659 }
Tobin Ehlis9252c2b2016-07-21 14:40:22 -0600660}
661
Tobin Ehlis300888c2016-05-18 13:43:26 -0600662cvdescriptorset::SamplerDescriptor::SamplerDescriptor() : sampler_(VK_NULL_HANDLE), immutable_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600663 updated = false;
664 descriptor_class = PlainSampler;
665};
666
Tobin Ehlis300888c2016-05-18 13:43:26 -0600667cvdescriptorset::SamplerDescriptor::SamplerDescriptor(const VkSampler *immut) : sampler_(VK_NULL_HANDLE), immutable_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600668 updated = false;
669 descriptor_class = PlainSampler;
670 if (immut) {
671 sampler_ = *immut;
672 immutable_ = true;
673 updated = true;
674 }
675}
Tobin Ehlise2f80292016-06-02 10:08:53 -0600676// Validate given sampler. Currently this only checks to make sure it exists in the samplerMap
677bool cvdescriptorset::ValidateSampler(const VkSampler sampler, const core_validation::layer_data *dev_data) {
678 return (getSamplerNode(dev_data, sampler) != nullptr);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600679}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600680
Tobin Ehlis554bf382016-05-24 11:14:43 -0600681bool cvdescriptorset::ValidateImageUpdate(VkImageView image_view, VkImageLayout image_layout, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600682 const core_validation::layer_data *dev_data, UNIQUE_VALIDATION_ERROR_CODE *error_code,
683 std::string *error_msg) {
684 // TODO : Defaulting to 00943 for all cases here. Need to create new error codes for various cases.
685 *error_code = VALIDATION_ERROR_00943;
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600686 auto iv_state = getImageViewState(dev_data, image_view);
687 if (!iv_state) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600688 std::stringstream error_str;
689 error_str << "Invalid VkImageView: " << image_view;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600690 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600691 return false;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600692 }
Tobin Ehlis81280962016-07-20 14:04:20 -0600693 // 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 -0600694 // Validate that imageLayout is compatible with aspect_mask and image format
695 // and validate that image usage bits are correct for given usage
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600696 VkImageAspectFlags aspect_mask = iv_state->create_info.subresourceRange.aspectMask;
697 VkImage image = iv_state->create_info.image;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600698 VkFormat format = VK_FORMAT_MAX_ENUM;
699 VkImageUsageFlags usage = 0;
Tobin Ehlis1c9c55f2016-06-02 11:49:22 -0600700 auto image_node = getImageNode(dev_data, image);
701 if (image_node) {
702 format = image_node->createInfo.format;
703 usage = image_node->createInfo.usage;
Tobin Ehlis029d2fe2016-09-21 09:19:15 -0600704 // Validate that memory is bound to image
Tobin Ehlisfed999f2016-09-21 15:09:45 -0600705 if (ValidateMemoryIsBoundToImage(dev_data, image_node, "vkUpdateDescriptorSets()")) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600706 // TODO : Need new code(s) for language in 11.6 Memory Association
707 *error_msg = "No memory bound to image.";
Tobin Ehlis029d2fe2016-09-21 09:19:15 -0600708 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -0600709 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600710 } else {
Tobin Ehlis1809f912016-05-25 09:24:36 -0600711 // Also need to check the swapchains.
Tobin Ehlis969a5262016-06-02 12:13:32 -0600712 auto swapchain = getSwapchainFromImage(dev_data, image);
713 if (swapchain) {
Tobin Ehlis4e380592016-06-02 12:41:47 -0600714 auto swapchain_node = getSwapchainNode(dev_data, swapchain);
715 if (swapchain_node) {
716 format = swapchain_node->createInfo.imageFormat;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600717 }
718 }
Tobin Ehlis1809f912016-05-25 09:24:36 -0600719 }
720 // First validate that format and layout are compatible
721 if (format == VK_FORMAT_MAX_ENUM) {
722 std::stringstream error_str;
723 error_str << "Invalid image (" << image << ") in imageView (" << image_view << ").";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600724 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600725 return false;
726 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600727 // TODO : The various image aspect and format checks here are based on general spec language in 11.5 Image Views section under
728 // vkCreateImageView(). What's the best way to create unique id for these cases?
Tobin Ehlis1809f912016-05-25 09:24:36 -0600729 bool ds = vk_format_is_depth_or_stencil(format);
730 switch (image_layout) {
731 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
732 // Only Color bit must be set
733 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600734 std::stringstream error_str;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600735 error_str << "ImageView (" << image_view << ") uses layout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL but does "
736 "not have VK_IMAGE_ASPECT_COLOR_BIT set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600737 *error_msg = error_str.str();
Tobin Ehlis554bf382016-05-24 11:14:43 -0600738 return false;
739 }
Tobin Ehlis1809f912016-05-25 09:24:36 -0600740 // format must NOT be DS
741 if (ds) {
742 std::stringstream error_str;
743 error_str << "ImageView (" << image_view
744 << ") uses layout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL but the image format is "
745 << string_VkFormat(format) << " which is not a color format.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600746 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600747 return false;
748 }
749 break;
750 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
751 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
752 // Depth or stencil bit must be set, but both must NOT be set
753 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
754 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
755 // both must NOT be set
756 std::stringstream error_str;
757 error_str << "ImageView (" << image_view << ") has both STENCIL and DEPTH aspects set";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600758 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600759 return false;
760 }
761 } else if (!(aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
762 // Neither were set
763 std::stringstream error_str;
764 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
765 << " but does not have STENCIL or DEPTH aspects set";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600766 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600767 return false;
768 }
769 // format must be DS
770 if (!ds) {
771 std::stringstream error_str;
772 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
773 << " but the image format is " << string_VkFormat(format) << " which is not a depth/stencil format.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600774 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600775 return false;
776 }
777 break;
778 default:
Tobin Ehlisbbf3f912016-06-15 13:03:58 -0600779 // For other layouts if the source is ds image, both aspect bits must not be set
780 if (ds) {
781 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
782 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
783 // both must NOT be set
784 std::stringstream error_str;
785 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
786 << " and is using depth/stencil image of format " << string_VkFormat(format)
787 << " but it has both STENCIL and DEPTH aspects set, which is illegal. When using a depth/stencil "
788 "image in a descriptor set, please only set either VK_IMAGE_ASPECT_DEPTH_BIT or "
789 "VK_IMAGE_ASPECT_STENCIL_BIT depending on whether it will be used for depth reads or stencil "
790 "reads respectively.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600791 *error_msg = error_str.str();
Tobin Ehlisbbf3f912016-06-15 13:03:58 -0600792 return false;
793 }
794 }
795 }
Tobin Ehlis1809f912016-05-25 09:24:36 -0600796 break;
797 }
798 // Now validate that usage flags are correctly set for given type of update
Tobin Ehlisfb4cf712016-10-10 14:02:48 -0600799 // 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 -0600800 // TODO : The various image usage bit requirements are in general spec language for VkImageUsageFlags bit block in 11.3 Images
801 // under vkCreateImage()
802 // TODO : Need to also validate case VALIDATION_ERROR_00952 where STORAGE_IMAGE & INPUT_ATTACH types must have been created with
803 // identify swizzle
Tobin Ehlis1809f912016-05-25 09:24:36 -0600804 std::string error_usage_bit;
805 switch (type) {
806 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
807 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
808 if (!(usage & VK_IMAGE_USAGE_SAMPLED_BIT)) {
809 error_usage_bit = "VK_IMAGE_USAGE_SAMPLED_BIT";
810 }
811 break;
812 }
813 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
814 if (!(usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
815 error_usage_bit = "VK_IMAGE_USAGE_STORAGE_BIT";
Tobin Ehlisfb4cf712016-10-10 14:02:48 -0600816 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
817 std::stringstream error_str;
818 // TODO : Need to create custom enum error code for this case
819 error_str << "ImageView (" << image_view << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type is being updated with layout "
820 << string_VkImageLayout(image_layout)
821 << " but according to spec section 13.1 Descriptor Types, 'Load and store operations on storage images can "
822 "only be done on images in VK_IMAGE_LAYOUT_GENERAL layout.'";
823 *error_msg = error_str.str();
824 return false;
Tobin Ehlis1809f912016-05-25 09:24:36 -0600825 }
826 break;
827 }
828 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT: {
829 if (!(usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) {
830 error_usage_bit = "VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT";
831 }
832 break;
833 }
834 default:
835 break;
836 }
837 if (!error_usage_bit.empty()) {
838 std::stringstream error_str;
839 error_str << "ImageView (" << image_view << ") with usage mask 0x" << usage
840 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
841 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600842 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -0600843 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600844 }
845 return true;
846}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600847
Tobin Ehlis300888c2016-05-18 13:43:26 -0600848void cvdescriptorset::SamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
849 sampler_ = update->pImageInfo[index].sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600850 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600851}
852
Tobin Ehlis300888c2016-05-18 13:43:26 -0600853void cvdescriptorset::SamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600854 if (!immutable_) {
855 auto update_sampler = static_cast<const SamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600856 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600857 }
858 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600859}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600860
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600861void cvdescriptorset::SamplerDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
862 if (!immutable_) {
863 auto sampler_node = getSamplerNode(dev_data, sampler_);
864 if (sampler_node)
865 core_validation::AddCommandBufferBindingSampler(cb_node, sampler_node);
866 }
867}
868
Tobin Ehlis300888c2016-05-18 13:43:26 -0600869cvdescriptorset::ImageSamplerDescriptor::ImageSamplerDescriptor()
870 : sampler_(VK_NULL_HANDLE), immutable_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600871 updated = false;
872 descriptor_class = ImageSampler;
873}
874
Tobin Ehlis300888c2016-05-18 13:43:26 -0600875cvdescriptorset::ImageSamplerDescriptor::ImageSamplerDescriptor(const VkSampler *immut)
876 : sampler_(VK_NULL_HANDLE), immutable_(true), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600877 updated = false;
878 descriptor_class = ImageSampler;
879 if (immut) {
880 sampler_ = *immut;
881 immutable_ = true;
882 updated = true;
883 }
884}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600885
Tobin Ehlis300888c2016-05-18 13:43:26 -0600886void cvdescriptorset::ImageSamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600887 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600888 const auto &image_info = update->pImageInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -0600889 sampler_ = image_info.sampler;
890 image_view_ = image_info.imageView;
891 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600892}
893
Tobin Ehlis300888c2016-05-18 13:43:26 -0600894void cvdescriptorset::ImageSamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600895 if (!immutable_) {
896 auto update_sampler = static_cast<const ImageSamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600897 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600898 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600899 auto image_view = static_cast<const ImageSamplerDescriptor *>(src)->image_view_;
900 auto image_layout = static_cast<const ImageSamplerDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600901 updated = true;
902 image_view_ = image_view;
903 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600904}
905
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600906void cvdescriptorset::ImageSamplerDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data,
907 GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -0600908 // First add binding for any non-immutable sampler
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600909 if (!immutable_) {
910 auto sampler_node = getSamplerNode(dev_data, sampler_);
911 if (sampler_node)
912 core_validation::AddCommandBufferBindingSampler(cb_node, sampler_node);
913 }
Tobin Ehlis81e46372016-08-17 13:33:44 -0600914 // Add binding for image
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600915 auto iv_state = getImageViewState(dev_data, image_view_);
916 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -0600917 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -0600918 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600919}
920
Tobin Ehlis300888c2016-05-18 13:43:26 -0600921cvdescriptorset::ImageDescriptor::ImageDescriptor(const VkDescriptorType type)
922 : storage_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600923 updated = false;
924 descriptor_class = Image;
925 if (VK_DESCRIPTOR_TYPE_STORAGE_IMAGE == type)
926 storage_ = true;
927};
928
Tobin Ehlis300888c2016-05-18 13:43:26 -0600929void cvdescriptorset::ImageDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600930 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600931 const auto &image_info = update->pImageInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -0600932 image_view_ = image_info.imageView;
933 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600934}
935
Tobin Ehlis300888c2016-05-18 13:43:26 -0600936void cvdescriptorset::ImageDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600937 auto image_view = static_cast<const ImageDescriptor *>(src)->image_view_;
938 auto image_layout = static_cast<const ImageDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600939 updated = true;
940 image_view_ = image_view;
941 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600942}
943
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600944void cvdescriptorset::ImageDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -0600945 // Add binding for image
Tobin Ehlis8b26a382016-09-14 08:02:49 -0600946 auto iv_state = getImageViewState(dev_data, image_view_);
947 if (iv_state) {
Tobin Ehlis15b8ea02016-09-19 14:02:58 -0600948 core_validation::AddCommandBufferBindingImageView(dev_data, cb_node, iv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -0600949 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600950}
951
Tobin Ehlis300888c2016-05-18 13:43:26 -0600952cvdescriptorset::BufferDescriptor::BufferDescriptor(const VkDescriptorType type)
953 : storage_(false), dynamic_(false), buffer_(VK_NULL_HANDLE), offset_(0), range_(0) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600954 updated = false;
955 descriptor_class = GeneralBuffer;
956 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
957 dynamic_ = true;
958 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type) {
959 storage_ = true;
960 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
961 dynamic_ = true;
962 storage_ = true;
963 }
964}
Tobin Ehlis300888c2016-05-18 13:43:26 -0600965void cvdescriptorset::BufferDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600966 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600967 const auto &buffer_info = update->pBufferInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -0600968 buffer_ = buffer_info.buffer;
969 offset_ = buffer_info.offset;
970 range_ = buffer_info.range;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600971}
972
Tobin Ehlis300888c2016-05-18 13:43:26 -0600973void cvdescriptorset::BufferDescriptor::CopyUpdate(const Descriptor *src) {
974 auto buff_desc = static_cast<const BufferDescriptor *>(src);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600975 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -0600976 buffer_ = buff_desc->buffer_;
977 offset_ = buff_desc->offset_;
978 range_ = buff_desc->range_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600979}
980
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600981void cvdescriptorset::BufferDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -0600982 auto buffer_node = getBufferNode(dev_data, buffer_);
983 if (buffer_node)
984 core_validation::AddCommandBufferBindingBuffer(dev_data, cb_node, buffer_node);
Tobin Ehlis8020eea2016-08-17 11:10:41 -0600985}
986
Tobin Ehlis300888c2016-05-18 13:43:26 -0600987cvdescriptorset::TexelDescriptor::TexelDescriptor(const VkDescriptorType type) : buffer_view_(VK_NULL_HANDLE), storage_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600988 updated = false;
989 descriptor_class = TexelBuffer;
990 if (VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER == type)
991 storage_ = true;
992};
Tobin Ehlis56a30942016-05-19 08:00:00 -0600993
Tobin Ehlis300888c2016-05-18 13:43:26 -0600994void cvdescriptorset::TexelDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600995 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -0600996 buffer_view_ = update->pTexelBufferView[index];
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600997}
998
Tobin Ehlis300888c2016-05-18 13:43:26 -0600999void cvdescriptorset::TexelDescriptor::CopyUpdate(const Descriptor *src) {
1000 updated = true;
1001 buffer_view_ = static_cast<const TexelDescriptor *>(src)->buffer_view_;
1002}
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001003
1004void cvdescriptorset::TexelDescriptor::BindCommandBuffer(const core_validation::layer_data *dev_data, GLOBAL_CB_NODE *cb_node) {
Tobin Ehlis8b872462016-09-14 08:12:08 -06001005 auto bv_state = getBufferViewState(dev_data, buffer_view_);
1006 if (bv_state) {
Tobin Ehlis2515c0e2016-09-28 07:12:28 -06001007 core_validation::AddCommandBufferBindingBufferView(dev_data, cb_node, bv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001008 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001009}
1010
Tobin Ehlis300888c2016-05-18 13:43:26 -06001011// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1012// sets, and then calls their respective Validate[Write|Copy]Update functions.
1013// If the update hits an issue for which the callback returns "true", meaning that the call down the chain should
1014// be skipped, then true is returned.
1015// If there is no issue with the update, then false is returned.
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001016bool cvdescriptorset::ValidateUpdateDescriptorSets(const debug_report_data *report_data,
1017 const core_validation::layer_data *dev_data, uint32_t write_count,
1018 const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
1019 const VkCopyDescriptorSet *p_cds) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001020 bool skip_call = false;
1021 // Validate Write updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001022 for (uint32_t i = 0; i < write_count; i++) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001023 auto dest_set = p_wds[i].dstSet;
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001024 auto set_node = core_validation::getSetNode(dev_data, dest_set);
1025 if (!set_node) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001026 skip_call |=
1027 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
Tobin Ehlis56a30942016-05-19 08:00:00 -06001028 reinterpret_cast<uint64_t &>(dest_set), __LINE__, DRAWSTATE_INVALID_DESCRIPTOR_SET, "DS",
Tobin Ehlis300888c2016-05-18 13:43:26 -06001029 "Cannot call vkUpdateDescriptorSets() on descriptor set 0x%" PRIxLEAST64 " that has not been allocated.",
1030 reinterpret_cast<uint64_t &>(dest_set));
1031 } else {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001032 UNIQUE_VALIDATION_ERROR_CODE error_code;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001033 std::string error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001034 if (!set_node->ValidateWriteUpdate(report_data, &p_wds[i], &error_code, &error_str)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001035 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001036 reinterpret_cast<uint64_t &>(dest_set), __LINE__, error_code, "DS",
Tobin Ehlis300888c2016-05-18 13:43:26 -06001037 "vkUpdateDescriptorsSets() failed write update validation for Descriptor Set 0x%" PRIx64
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001038 " with error: %s. %s",
1039 reinterpret_cast<uint64_t &>(dest_set), error_str.c_str(), validation_error_map[error_code]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001040 }
1041 }
1042 }
1043 // Now validate copy updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001044 for (uint32_t i = 0; i < copy_count; ++i) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001045 auto dst_set = p_cds[i].dstSet;
1046 auto src_set = p_cds[i].srcSet;
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001047 auto src_node = core_validation::getSetNode(dev_data, src_set);
1048 auto dst_node = core_validation::getSetNode(dev_data, dst_set);
1049 if (!src_node) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001050 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001051 reinterpret_cast<uint64_t &>(src_set), __LINE__, VALIDATION_ERROR_00971, "DS",
Tobin Ehlis300888c2016-05-18 13:43:26 -06001052 "Cannot call vkUpdateDescriptorSets() to copy from descriptor set 0x%" PRIxLEAST64
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001053 " that has not been allocated. %s",
1054 reinterpret_cast<uint64_t &>(src_set), validation_error_map[VALIDATION_ERROR_00971]);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001055 } else if (!dst_node) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001056 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001057 reinterpret_cast<uint64_t &>(dst_set), __LINE__, VALIDATION_ERROR_00972, "DS",
Tobin Ehlis300888c2016-05-18 13:43:26 -06001058 "Cannot call vkUpdateDescriptorSets() to copy to descriptor set 0x%" PRIxLEAST64
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001059 " that has not been allocated. %s",
1060 reinterpret_cast<uint64_t &>(dst_set), validation_error_map[VALIDATION_ERROR_00972]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001061 } else {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001062 UNIQUE_VALIDATION_ERROR_CODE error_code;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001063 std::string error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001064 if (!dst_node->ValidateCopyUpdate(report_data, &p_cds[i], src_node, &error_code, &error_str)) {
1065 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
1066 reinterpret_cast<uint64_t &>(dst_set), __LINE__, error_code, "DS",
1067 "vkUpdateDescriptorsSets() failed copy update from Descriptor Set 0x%" PRIx64
1068 " to Descriptor Set 0x%" PRIx64 " with error: %s. %s",
1069 reinterpret_cast<uint64_t &>(src_set), reinterpret_cast<uint64_t &>(dst_set),
1070 error_str.c_str(), validation_error_map[error_code]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001071 }
1072 }
1073 }
1074 return skip_call;
1075}
1076// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1077// sets, and then calls their respective Perform[Write|Copy]Update functions.
1078// Prerequisite : ValidateUpdateDescriptorSets() should be called and return "false" prior to calling PerformUpdateDescriptorSets()
1079// with the same set of updates.
1080// This is split from the validate code to allow validation prior to calling down the chain, and then update after
1081// calling down the chain.
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001082void cvdescriptorset::PerformUpdateDescriptorSets(const core_validation::layer_data *dev_data, uint32_t write_count,
1083 const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
1084 const VkCopyDescriptorSet *p_cds) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001085 // Write updates first
1086 uint32_t i = 0;
1087 for (i = 0; i < write_count; ++i) {
1088 auto dest_set = p_wds[i].dstSet;
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001089 auto set_node = core_validation::getSetNode(dev_data, dest_set);
1090 if (set_node) {
1091 set_node->PerformWriteUpdate(&p_wds[i]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001092 }
1093 }
1094 // Now copy updates
1095 for (i = 0; i < copy_count; ++i) {
1096 auto dst_set = p_cds[i].dstSet;
1097 auto src_set = p_cds[i].srcSet;
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001098 auto src_node = core_validation::getSetNode(dev_data, src_set);
1099 auto dst_node = core_validation::getSetNode(dev_data, dst_set);
1100 if (src_node && dst_node) {
1101 dst_node->PerformCopyUpdate(&p_cds[i], src_node);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001102 }
1103 }
1104}
1105// Validate the state for a given write update but don't actually perform the update
1106// If an error would occur for this update, return false and fill in details in error_msg string
1107bool cvdescriptorset::DescriptorSet::ValidateWriteUpdate(const debug_report_data *report_data, const VkWriteDescriptorSet *update,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001108 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001109 // Verify idle ds
1110 if (in_use.load()) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001111 // TODO : Re-using Allocate Idle error code, need write update idle error code
1112 *error_code = VALIDATION_ERROR_00919;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001113 std::stringstream error_str;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001114 error_str << "Cannot call vkUpdateDescriptorSets() to perform write update on descriptor set " << set_
1115 << " that is in use by a command buffer.";
1116 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001117 return false;
1118 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001119 // Verify dst binding exists
1120 if (!p_layout_->HasBinding(update->dstBinding)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001121 *error_code = VALIDATION_ERROR_00936;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001122 std::stringstream error_str;
1123 error_str << "DescriptorSet " << set_ << " does not have binding " << update->dstBinding << ".";
1124 *error_msg = error_str.str();
1125 return false;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001126 }
1127 // We know that binding is valid, verify update and do update on each descriptor
1128 auto start_idx = p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding) + update->dstArrayElement;
1129 auto type = p_layout_->GetTypeFromBinding(update->dstBinding);
1130 if (type != update->descriptorType) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001131 *error_code = VALIDATION_ERROR_00937;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001132 std::stringstream error_str;
1133 error_str << "Attempting write update to descriptor set " << set_ << " binding #" << update->dstBinding << " with type "
1134 << string_VkDescriptorType(type) << " but update type is " << string_VkDescriptorType(update->descriptorType);
1135 *error_msg = error_str.str();
1136 return false;
1137 }
1138 if ((start_idx + update->descriptorCount) > p_layout_->GetTotalDescriptorCount()) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001139 *error_code = VALIDATION_ERROR_00938;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001140 std::stringstream error_str;
1141 error_str << "Attempting write update to descriptor set " << set_ << " binding #" << update->dstBinding << " with "
1142 << p_layout_->GetTotalDescriptorCount() << " total descriptors but update of " << update->descriptorCount
1143 << " descriptors starting at binding offset of " << p_layout_->GetGlobalStartIndexFromBinding(update->dstBinding)
1144 << " combined with update array element offset of " << update->dstArrayElement
1145 << " oversteps the size of this descriptor set.";
1146 *error_msg = error_str.str();
1147 return false;
1148 }
1149 // Verify consecutive bindings match (if needed)
1150 if (!p_layout_->VerifyUpdateConsistency(update->dstBinding, update->dstArrayElement, update->descriptorCount, "write update to",
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001151 set_, error_msg)) {
1152 *error_code = VALIDATION_ERROR_00938;
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001153 return false;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001154 }
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001155 // Update is within bounds and consistent so last step is to validate update contents
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001156 if (!VerifyWriteUpdateContents(update, start_idx, error_code, error_msg)) {
Tobin Ehlis57ae28f2016-05-24 12:35:57 -06001157 std::stringstream error_str;
1158 error_str << "Write update to descriptor in set " << set_ << " binding #" << update->dstBinding
1159 << " failed with error message: " << error_msg->c_str();
1160 *error_msg = error_str.str();
1161 return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001162 }
1163 // All checks passed, update is clean
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001164 return true;
Tobin Ehlis03d61de2016-05-17 08:31:46 -06001165}
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001166// For the given buffer, verify that its creation parameters are appropriate for the given type
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001167// 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 -06001168bool cvdescriptorset::DescriptorSet::ValidateBufferUsage(BUFFER_NODE const *buffer_node, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001169 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) const {
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001170 // Verify that usage bits set correctly for given type
Tobin Ehlis94bc5d22016-06-02 07:46:52 -06001171 auto usage = buffer_node->createInfo.usage;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001172 std::string error_usage_bit;
1173 switch (type) {
1174 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1175 if (!(usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001176 *error_code = VALIDATION_ERROR_00950;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001177 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT";
1178 }
1179 break;
1180 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1181 if (!(usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001182 *error_code = VALIDATION_ERROR_00951;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001183 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT";
1184 }
1185 break;
1186 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1187 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1188 if (!(usage & VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001189 *error_code = VALIDATION_ERROR_00946;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001190 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT";
1191 }
1192 break;
1193 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1194 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1195 if (!(usage & VK_BUFFER_USAGE_STORAGE_BUFFER_BIT)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001196 *error_code = VALIDATION_ERROR_00947;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001197 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_BUFFER_BIT";
1198 }
1199 break;
1200 default:
1201 break;
1202 }
1203 if (!error_usage_bit.empty()) {
1204 std::stringstream error_str;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001205 error_str << "Buffer (" << buffer_node->buffer << ") with usage mask 0x" << usage
1206 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
1207 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001208 *error_msg = error_str.str();
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001209 return false;
1210 }
1211 return true;
1212}
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001213// For buffer descriptor updates, verify the buffer usage and VkDescriptorBufferInfo struct which includes:
1214// 1. buffer is valid
1215// 2. buffer was created with correct usage flags
1216// 3. offset is less than buffer size
1217// 4. range is either VK_WHOLE_SIZE or falls in (0, (buffer size - offset)]
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001218// 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 -06001219bool cvdescriptorset::DescriptorSet::ValidateBufferUpdate(VkDescriptorBufferInfo const *buffer_info, VkDescriptorType type,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001220 UNIQUE_VALIDATION_ERROR_CODE *error_code, std::string *error_msg) const {
1221 // TODO : Defaulting to 00962 for all cases here. Need to create new error codes for a few cases below.
1222 *error_code = VALIDATION_ERROR_00962;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001223 // First make sure that buffer is valid
1224 auto buffer_node = getBufferNode(device_data_, buffer_info->buffer);
1225 if (!buffer_node) {
1226 std::stringstream error_str;
1227 error_str << "Invalid VkBuffer: " << buffer_info->buffer;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001228 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001229 return false;
1230 }
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001231 if (ValidateMemoryIsBoundToBuffer(device_data_, buffer_node, "vkUpdateDescriptorSets()")) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001232 // TODO : This is a repeat code, need new code(s) for language in 11.6 Memory Association
1233 *error_msg = "No memory bound to buffer.";
Tobin Ehlis81280962016-07-20 14:04:20 -06001234 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001235 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001236 // Verify usage bits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001237 if (!ValidateBufferUsage(buffer_node, type, error_code, error_msg)) {
1238 // error_msg will have been updated by ValidateBufferUsage()
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001239 return false;
1240 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001241 // TODO : Need to also validate device limit offset requirements captured in VALIDATION_ERROR_00944,945
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001242 // offset must be less than buffer size
1243 if (buffer_info->offset > buffer_node->createInfo.size) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001244 *error_code = VALIDATION_ERROR_00959;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001245 std::stringstream error_str;
1246 error_str << "VkDescriptorBufferInfo offset of " << buffer_info->offset << " is greater than buffer " << buffer_node->buffer
1247 << " size of " << buffer_node->createInfo.size;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001248 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001249 return false;
1250 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001251 // TODO : Need to also validate device limit range requirements captured in VALIDATION_ERROR_00948,949
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001252 if (buffer_info->range != VK_WHOLE_SIZE) {
1253 // Range must be VK_WHOLE_SIZE or > 0
1254 if (!buffer_info->range) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001255 *error_code = VALIDATION_ERROR_00960;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001256 std::stringstream error_str;
1257 error_str << "VkDescriptorBufferInfo range is not VK_WHOLE_SIZE and is zero, which is not allowed.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001258 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001259 return false;
1260 }
1261 // Range must be VK_WHOLE_SIZE or <= (buffer size - offset)
1262 if (buffer_info->range > (buffer_node->createInfo.size - buffer_info->offset)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001263 *error_code = VALIDATION_ERROR_00961;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001264 std::stringstream error_str;
1265 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range << " which is greater than buffer size ("
1266 << buffer_node->createInfo.size << ") minus requested offset of " << buffer_info->offset;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001267 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001268 return false;
1269 }
1270 }
1271 return true;
1272}
1273
Tobin Ehlis300888c2016-05-18 13:43:26 -06001274// Verify that the contents of the update are ok, but don't perform actual update
1275bool cvdescriptorset::DescriptorSet::VerifyWriteUpdateContents(const VkWriteDescriptorSet *update, const uint32_t index,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001276 UNIQUE_VALIDATION_ERROR_CODE *error_code,
1277 std::string *error_msg) const {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001278 switch (update->descriptorType) {
1279 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
1280 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1281 // Validate image
1282 auto image_view = update->pImageInfo[di].imageView;
1283 auto image_layout = update->pImageInfo[di].imageLayout;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001284 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001285 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001286 error_str << "Attempted write update to combined image sampler descriptor failed due to: " << error_msg->c_str();
1287 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001288 return false;
1289 }
1290 }
1291 // Intentional fall-through to validate sampler
1292 }
1293 case VK_DESCRIPTOR_TYPE_SAMPLER: {
1294 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1295 if (!descriptors_[index + di].get()->IsImmutableSampler()) {
Tobin Ehlise2f80292016-06-02 10:08:53 -06001296 if (!ValidateSampler(update->pImageInfo[di].sampler, device_data_)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001297 *error_code = VALIDATION_ERROR_00942;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001298 std::stringstream error_str;
1299 error_str << "Attempted write update to sampler descriptor with invalid sampler: "
1300 << update->pImageInfo[di].sampler << ".";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001301 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001302 return false;
1303 }
1304 } else {
1305 // TODO : Warn here
1306 }
1307 }
1308 break;
1309 }
1310 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1311 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
1312 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
1313 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1314 auto image_view = update->pImageInfo[di].imageView;
1315 auto image_layout = update->pImageInfo[di].imageLayout;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001316 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001317 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001318 error_str << "Attempted write update to image descriptor failed due to: " << error_msg->c_str();
1319 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001320 return false;
1321 }
1322 }
1323 break;
1324 }
1325 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1326 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER: {
1327 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1328 auto buffer_view = update->pTexelBufferView[di];
Tobin Ehlis8b872462016-09-14 08:12:08 -06001329 auto bv_state = getBufferViewState(device_data_, buffer_view);
1330 if (!bv_state) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001331 *error_code = VALIDATION_ERROR_00940;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001332 std::stringstream error_str;
1333 error_str << "Attempted write update to texel buffer descriptor with invalid buffer view: " << buffer_view;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001334 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001335 return false;
1336 }
Tobin Ehlis8b872462016-09-14 08:12:08 -06001337 auto buffer = bv_state->create_info.buffer;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001338 if (!ValidateBufferUsage(getBufferNode(device_data_, buffer), update->descriptorType, error_code, error_msg)) {
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001339 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001340 error_str << "Attempted write update to texel buffer descriptor failed due to: " << error_msg->c_str();
1341 *error_msg = error_str.str();
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001342 return false;
1343 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001344 }
1345 break;
1346 }
1347 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1348 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1349 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1350 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC: {
1351 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001352 if (!ValidateBufferUpdate(update->pBufferInfo + di, update->descriptorType, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001353 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001354 error_str << "Attempted write update to buffer descriptor failed due to: " << error_msg->c_str();
1355 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001356 return false;
1357 }
1358 }
1359 break;
1360 }
1361 default:
1362 assert(0); // We've already verified update type so should never get here
1363 break;
1364 }
1365 // All checks passed so update contents are good
1366 return true;
1367}
1368// Verify that the contents of the update are ok, but don't perform actual update
1369bool cvdescriptorset::DescriptorSet::VerifyCopyUpdateContents(const VkCopyDescriptorSet *update, const DescriptorSet *src_set,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001370 VkDescriptorType type, uint32_t index,
1371 UNIQUE_VALIDATION_ERROR_CODE *error_code,
1372 std::string *error_msg) const {
1373 // Note : Repurposing some Write update error codes here as specific details aren't called out for copy updates like they are
1374 // for write updates
Tobin Ehlis300888c2016-05-18 13:43:26 -06001375 switch (src_set->descriptors_[index]->descriptor_class) {
1376 case PlainSampler: {
1377 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1378 if (!src_set->descriptors_[index + di]->IsImmutableSampler()) {
1379 auto update_sampler = static_cast<SamplerDescriptor *>(src_set->descriptors_[index + di].get())->GetSampler();
Tobin Ehlise2f80292016-06-02 10:08:53 -06001380 if (!ValidateSampler(update_sampler, device_data_)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001381 *error_code = VALIDATION_ERROR_00942;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001382 std::stringstream error_str;
1383 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001384 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001385 return false;
1386 }
1387 } else {
1388 // TODO : Warn here
1389 }
1390 }
1391 break;
1392 }
1393 case ImageSampler: {
1394 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1395 auto img_samp_desc = static_cast<const ImageSamplerDescriptor *>(src_set->descriptors_[index + di].get());
1396 // First validate sampler
1397 if (!img_samp_desc->IsImmutableSampler()) {
1398 auto update_sampler = img_samp_desc->GetSampler();
Tobin Ehlise2f80292016-06-02 10:08:53 -06001399 if (!ValidateSampler(update_sampler, device_data_)) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001400 *error_code = VALIDATION_ERROR_00942;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001401 std::stringstream error_str;
1402 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001403 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001404 return false;
1405 }
1406 } else {
1407 // TODO : Warn here
1408 }
1409 // Validate image
1410 auto image_view = img_samp_desc->GetImageView();
1411 auto image_layout = img_samp_desc->GetImageLayout();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001412 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001413 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001414 error_str << "Attempted copy update to combined image sampler descriptor failed due to: " << error_msg->c_str();
1415 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001416 return false;
1417 }
1418 }
Alex Smithd8f14792016-09-23 12:18:51 +01001419 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001420 }
1421 case Image: {
1422 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1423 auto img_desc = static_cast<const ImageDescriptor *>(src_set->descriptors_[index + di].get());
1424 auto image_view = img_desc->GetImageView();
1425 auto image_layout = img_desc->GetImageLayout();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001426 if (!ValidateImageUpdate(image_view, image_layout, type, device_data_, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001427 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001428 error_str << "Attempted copy update to image descriptor failed due to: " << error_msg->c_str();
1429 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001430 return false;
1431 }
1432 }
1433 break;
1434 }
1435 case TexelBuffer: {
1436 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1437 auto buffer_view = static_cast<TexelDescriptor *>(src_set->descriptors_[index + di].get())->GetBufferView();
Tobin Ehlis8b872462016-09-14 08:12:08 -06001438 auto bv_state = getBufferViewState(device_data_, buffer_view);
1439 if (!bv_state) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001440 *error_code = VALIDATION_ERROR_00940;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001441 std::stringstream error_str;
Tobin Ehliscbcf2342016-05-24 13:07:12 -06001442 error_str << "Attempted copy update to texel buffer descriptor with invalid buffer view: " << buffer_view;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001443 *error_msg = error_str.str();
Tobin Ehliscbcf2342016-05-24 13:07:12 -06001444 return false;
1445 }
Tobin Ehlis8b872462016-09-14 08:12:08 -06001446 auto buffer = bv_state->create_info.buffer;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001447 if (!ValidateBufferUsage(getBufferNode(device_data_, buffer), type, error_code, error_msg)) {
Tobin Ehliscbcf2342016-05-24 13:07:12 -06001448 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001449 error_str << "Attempted copy update to texel buffer descriptor failed due to: " << error_msg->c_str();
1450 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001451 return false;
1452 }
1453 }
1454 break;
1455 }
1456 case GeneralBuffer: {
1457 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
1458 auto buffer = static_cast<BufferDescriptor *>(src_set->descriptors_[index + di].get())->GetBuffer();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001459 if (!ValidateBufferUsage(getBufferNode(device_data_, buffer), type, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001460 std::stringstream error_str;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001461 error_str << "Attempted copy update to buffer descriptor failed due to: " << error_msg->c_str();
1462 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06001463 return false;
1464 }
1465 }
1466 break;
1467 }
1468 default:
1469 assert(0); // We've already verified update type so should never get here
1470 break;
1471 }
1472 // All checks passed so update contents are good
1473 return true;
Chris Forbesb4e0bdb2016-05-31 16:34:40 +12001474}
Tobin Ehlisee471462016-05-26 11:21:59 -06001475// Verify that the state at allocate time is correct, but don't actually allocate the sets yet
Tobin Ehlis815e8132016-06-02 13:02:17 -06001476bool cvdescriptorset::ValidateAllocateDescriptorSets(const debug_report_data *report_data,
1477 const VkDescriptorSetAllocateInfo *p_alloc_info,
1478 const core_validation::layer_data *dev_data,
1479 AllocateDescriptorSetsData *ds_data) {
Tobin Ehlisee471462016-05-26 11:21:59 -06001480 bool skip_call = false;
Tobin Ehlisee471462016-05-26 11:21:59 -06001481
1482 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Tobin Ehlis815e8132016-06-02 13:02:17 -06001483 auto layout = getDescriptorSetLayout(dev_data, p_alloc_info->pSetLayouts[i]);
1484 if (!layout) {
Tobin Ehlisee471462016-05-26 11:21:59 -06001485 skip_call |=
1486 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT,
1487 reinterpret_cast<const uint64_t &>(p_alloc_info->pSetLayouts[i]), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
1488 "Unable to find set layout node for layout 0x%" PRIxLEAST64 " specified in vkAllocateDescriptorSets() call",
1489 reinterpret_cast<const uint64_t &>(p_alloc_info->pSetLayouts[i]));
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001490 } else {
Tobin Ehlis815e8132016-06-02 13:02:17 -06001491 ds_data->layout_nodes[i] = layout;
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001492 // Count total descriptors required per type
Tobin Ehlis815e8132016-06-02 13:02:17 -06001493 for (uint32_t j = 0; j < layout->GetBindingCount(); ++j) {
1494 const auto &binding_layout = layout->GetDescriptorSetLayoutBindingPtrFromIndex(j);
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001495 uint32_t typeIndex = static_cast<uint32_t>(binding_layout->descriptorType);
1496 ds_data->required_descriptors_by_type[typeIndex] += binding_layout->descriptorCount;
1497 }
Tobin Ehlisee471462016-05-26 11:21:59 -06001498 }
1499 }
Tobin Ehlis815e8132016-06-02 13:02:17 -06001500 auto pool_node = getPoolNode(dev_data, p_alloc_info->descriptorPool);
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001501 // Track number of descriptorSets allowable in this pool
1502 if (pool_node->availableSets < p_alloc_info->descriptorSetCount) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001503 skip_call |= log_msg(
1504 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT,
1505 reinterpret_cast<uint64_t &>(pool_node->pool), __LINE__, DRAWSTATE_DESCRIPTOR_POOL_EMPTY, "DS",
1506 "Unable to allocate %u descriptorSets from pool 0x%" PRIxLEAST64 ". This pool only has %d descriptorSets remaining.",
1507 p_alloc_info->descriptorSetCount, reinterpret_cast<uint64_t &>(pool_node->pool), pool_node->availableSets);
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001508 }
1509 // Determine whether descriptor counts are satisfiable
1510 for (uint32_t i = 0; i < VK_DESCRIPTOR_TYPE_RANGE_SIZE; i++) {
1511 if (ds_data->required_descriptors_by_type[i] > pool_node->availableDescriptorTypeCount[i]) {
1512 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT,
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001513 reinterpret_cast<const uint64_t &>(pool_node->pool), __LINE__, DRAWSTATE_DESCRIPTOR_POOL_EMPTY,
1514 "DS", "Unable to allocate %u descriptors of type %s from pool 0x%" PRIxLEAST64
1515 ". This pool only has %d descriptors of this type remaining.",
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001516 ds_data->required_descriptors_by_type[i], string_VkDescriptorType(VkDescriptorType(i)),
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001517 reinterpret_cast<uint64_t &>(pool_node->pool), pool_node->availableDescriptorTypeCount[i]);
Tobin Ehlisee471462016-05-26 11:21:59 -06001518 }
1519 }
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06001520
Tobin Ehlisee471462016-05-26 11:21:59 -06001521 return skip_call;
1522}
1523// Decrement allocated sets from the pool and insert new sets into set_map
Tobin Ehlis4e380592016-06-02 12:41:47 -06001524void cvdescriptorset::PerformAllocateDescriptorSets(const VkDescriptorSetAllocateInfo *p_alloc_info,
1525 const VkDescriptorSet *descriptor_sets,
1526 const AllocateDescriptorSetsData *ds_data,
Tobin Ehlisbd711bd2016-10-12 14:27:30 -06001527 std::unordered_map<VkDescriptorPool, DESCRIPTOR_POOL_STATE *> *pool_map,
Tobin Ehlis4e380592016-06-02 12:41:47 -06001528 std::unordered_map<VkDescriptorSet, cvdescriptorset::DescriptorSet *> *set_map,
1529 const core_validation::layer_data *dev_data) {
Tobin Ehlisee471462016-05-26 11:21:59 -06001530 auto pool_state = (*pool_map)[p_alloc_info->descriptorPool];
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001531 /* Account for sets and individual descriptors allocated from pool */
Tobin Ehlisee471462016-05-26 11:21:59 -06001532 pool_state->availableSets -= p_alloc_info->descriptorSetCount;
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06001533 for (uint32_t i = 0; i < VK_DESCRIPTOR_TYPE_RANGE_SIZE; i++) {
1534 pool_state->availableDescriptorTypeCount[i] -= ds_data->required_descriptors_by_type[i];
1535 }
Tobin Ehlisee471462016-05-26 11:21:59 -06001536 /* Create tracking object for each descriptor set; insert into
1537 * global map and the pool's set.
1538 */
1539 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Tobin Ehlis4e380592016-06-02 12:41:47 -06001540 auto new_ds = new cvdescriptorset::DescriptorSet(descriptor_sets[i], ds_data->layout_nodes[i], dev_data);
Tobin Ehlisee471462016-05-26 11:21:59 -06001541
1542 pool_state->sets.insert(new_ds);
1543 new_ds->in_use.store(0);
1544 (*set_map)[descriptor_sets[i]] = new_ds;
1545 }
1546}