/* Copyright (c) 2015-2016 The Khronos Group Inc. * Copyright (c) 2015-2016 Valve Corporation * Copyright (c) 2015-2016 LunarG, Inc. * Copyright (C) 2015-2016 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * Author: Tobin Ehlis * John Zulauf */ #ifndef CORE_VALIDATION_DESCRIPTOR_SETS_H_ #define CORE_VALIDATION_DESCRIPTOR_SETS_H_ #include "core_validation_error_enums.h" #include "vk_validation_error_messages.h" #include "core_validation_types.h" #include "vk_layer_logging.h" #include "vk_layer_utils.h" #include "vk_safe_struct.h" #include "vulkan/vk_layer.h" #include "vk_object_types.h" #include #include #include #include #include #include using core_validation::layer_data; // Descriptor Data structures namespace cvdescriptorset { // Utility structs/classes/types // Index range for global indices below, end is exclusive, i.e. [start,end) struct IndexRange { IndexRange(uint32_t start_in, uint32_t end_in) : start(start_in), end(end_in) {} IndexRange() = default; uint32_t start; uint32_t end; }; typedef std::map BindingReqMap; /* * DescriptorSetLayout class * * Overview - This class encapsulates the Vulkan VkDescriptorSetLayout data (layout). * A layout consists of some number of bindings, each of which has a binding#, a * type, descriptor count, stage flags, and pImmutableSamplers. * * Index vs Binding - A layout is created with an array of VkDescriptorSetLayoutBinding * where each array index will have a corresponding binding# that is defined in that struct. * The binding#, then, is decoupled from VkDescriptorSetLayoutBinding index, which allows * bindings to be defined out-of-order. This DescriptorSetLayout class, however, stores * the bindings internally in-order. This is useful for operations which may "roll over" * from a single binding to the next consecutive binding. * * Note that although the bindings are stored in-order, there still may be "gaps" in the * binding#. For example, if the binding creation order is 8, 7, 10, 3, 4, then the * internal binding array will have five entries stored in binding order 3, 4, 7, 8, 10. * To process all of the bindings in a layout you can iterate from 0 to GetBindingCount() * and use the Get*FromIndex() functions for each index. To just process a single binding, * use the Get*FromBinding() functions. * * Global Index - The binding vector index has as many indices as there are bindings. * This class also has the concept of a Global Index. For the global index functions, * there are as many global indices as there are descriptors in the layout. * For the global index, consider all of the bindings to be a flat array where * descriptor 0 of of the lowest binding# is index 0 and each descriptor in the layout * increments from there. So if the lowest binding# in this example had descriptorCount of * 10, then the GlobalStartIndex of the 2nd lowest binding# will be 10 where 0-9 are the * global indices for the lowest binding#. */ class DescriptorSetLayout { public: // Constructors and destructor DescriptorSetLayout(const VkDescriptorSetLayoutCreateInfo *p_create_info, const VkDescriptorSetLayout layout); // Validate create info - should be called prior to creation static bool ValidateCreateInfo(const debug_report_data *, const VkDescriptorSetLayoutCreateInfo *, const bool, const uint32_t); // Straightforward Get functions VkDescriptorSetLayout GetDescriptorSetLayout() const { return layout_; }; bool IsDestroyed() const { return layout_destroyed_; } void MarkDestroyed() { layout_destroyed_ = true; } uint32_t GetTotalDescriptorCount() const { return descriptor_count_; }; uint32_t GetDynamicDescriptorCount() const { return dynamic_descriptor_count_; }; VkDescriptorSetLayoutCreateFlags GetCreateFlags() const { return flags_; } // For a given binding, return the number of descriptors in that binding and all successive bindings uint32_t GetBindingCount() const { return binding_count_; }; // Non-empty binding numbers in order const std::set &GetSortedBindingSet() const { return non_empty_bindings_; } // Return true if given binding is present in this layout bool HasBinding(const uint32_t binding) const { return binding_to_index_map_.count(binding) > 0; }; // Return true if this layout is compatible with passed in layout from a pipelineLayout, // else return false and update error_msg with description of incompatibility bool IsCompatible(DescriptorSetLayout const *const, std::string *) const; // Return true if binding 1 beyond given exists and has same type, stageFlags & immutable sampler use bool IsNextBindingConsistent(const uint32_t) const; uint32_t GetIndexFromBinding(uint32_t binding) const; // Various Get functions that can either be passed a binding#, which will // be automatically translated into the appropriate index, or the index# can be passed in directly uint32_t GetMaxBinding() const { return bindings_[bindings_.size() - 1].binding; } VkDescriptorSetLayoutBinding const *GetDescriptorSetLayoutBindingPtrFromIndex(const uint32_t) const; VkDescriptorSetLayoutBinding const *GetDescriptorSetLayoutBindingPtrFromBinding(uint32_t binding) const { return GetDescriptorSetLayoutBindingPtrFromIndex(GetIndexFromBinding(binding)); } uint32_t GetDescriptorCountFromIndex(const uint32_t) const; uint32_t GetDescriptorCountFromBinding(const uint32_t binding) const { return GetDescriptorCountFromIndex(GetIndexFromBinding(binding)); } VkDescriptorType GetTypeFromIndex(const uint32_t) const; VkDescriptorType GetTypeFromBinding(const uint32_t binding) const { return GetTypeFromIndex(GetIndexFromBinding(binding)); } VkShaderStageFlags GetStageFlagsFromIndex(const uint32_t) const; VkShaderStageFlags GetStageFlagsFromBinding(const uint32_t binding) const { return GetStageFlagsFromIndex(GetIndexFromBinding(binding)); } uint32_t GetIndexFromGlobalIndex(const uint32_t global_index) const; VkDescriptorType GetTypeFromGlobalIndex(const uint32_t global_index) const { return GetTypeFromIndex(GetIndexFromGlobalIndex(global_index)); } VkSampler const *GetImmutableSamplerPtrFromBinding(const uint32_t) const; VkSampler const *GetImmutableSamplerPtrFromIndex(const uint32_t) const; // For a given binding and array index, return the corresponding index into the dynamic offset array int32_t GetDynamicOffsetIndexFromBinding(uint32_t binding) const { auto dyn_off = binding_to_dynamic_array_idx_map_.find(binding); if (dyn_off == binding_to_dynamic_array_idx_map_.end()) { assert(0); // Requesting dyn offset for invalid binding/array idx pair return -1; } return dyn_off->second; } // For a particular binding, get the global index range // This call should be guarded by a call to "HasBinding(binding)" to verify that the given binding exists const IndexRange &GetGlobalIndexRangeFromBinding(const uint32_t) const; // Helper function to get the next valid binding for a descriptor uint32_t GetNextValidBinding(const uint32_t) const; // For a particular binding starting at offset and having update_count descriptors // updated, verify that for any binding boundaries crossed, the update is consistent bool VerifyUpdateConsistency(uint32_t, uint32_t, uint32_t, const char *, const VkDescriptorSet, std::string *) const; bool IsPushDescriptor() const { return GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR; }; struct BindingTypeStats { uint32_t dynamic_buffer_count; uint32_t non_dynamic_buffer_count; uint32_t image_sampler_count; }; const BindingTypeStats &GetBindingTypeStats() const { return binding_type_stats_; } private: VkDescriptorSetLayout layout_; bool layout_destroyed_; std::set non_empty_bindings_; // Containing non-emtpy bindings in numerical order std::unordered_map binding_to_index_map_; // The following map allows an non-iterative lookup of a binding from a global index... std::map global_start_to_index_map_; // The index corresponding for a starting global (descriptor) index std::unordered_map binding_to_global_index_range_map_; // range is exclusive of .end // For a given binding map to associated index in the dynamic offset array std::unordered_map binding_to_dynamic_array_idx_map_; VkDescriptorSetLayoutCreateFlags flags_; uint32_t binding_count_; // # of bindings in this layout std::vector bindings_; uint32_t descriptor_count_; // total # descriptors in this layout uint32_t dynamic_descriptor_count_; BindingTypeStats binding_type_stats_; }; /* * Descriptor classes * Descriptor is an abstract base class from which 5 separate descriptor types are derived. * This allows the WriteUpdate() and CopyUpdate() operations to be specialized per * descriptor type, but all descriptors in a set can be accessed via the common Descriptor*. */ // Slightly broader than type, each c++ "class" will has a corresponding "DescriptorClass" enum DescriptorClass { PlainSampler, ImageSampler, Image, TexelBuffer, GeneralBuffer }; class Descriptor { public: virtual ~Descriptor(){}; virtual void WriteUpdate(const VkWriteDescriptorSet *, const uint32_t) = 0; virtual void CopyUpdate(const Descriptor *) = 0; // Create binding between resources of this descriptor and given cb_node virtual void BindCommandBuffer(const core_validation::layer_data *, GLOBAL_CB_NODE *) = 0; virtual DescriptorClass GetClass() const { return descriptor_class; }; // Special fast-path check for SamplerDescriptors that are immutable virtual bool IsImmutableSampler() const { return false; }; // Check for dynamic descriptor type virtual bool IsDynamic() const { return false; }; // Check for storage descriptor type virtual bool IsStorage() const { return false; }; bool updated; // Has descriptor been updated? DescriptorClass descriptor_class; }; // Shared helper functions - These are useful because the shared sampler image descriptor type // performs common functions with both sampler and image descriptors so they can share their common functions bool ValidateSampler(const VkSampler, const core_validation::layer_data *); bool ValidateImageUpdate(VkImageView, VkImageLayout, VkDescriptorType, const core_validation::layer_data *, UNIQUE_VALIDATION_ERROR_CODE *, std::string *); class SamplerDescriptor : public Descriptor { public: SamplerDescriptor(const VkSampler *); void WriteUpdate(const VkWriteDescriptorSet *, const uint32_t) override; void CopyUpdate(const Descriptor *) override; void BindCommandBuffer(const core_validation::layer_data *, GLOBAL_CB_NODE *) override; virtual bool IsImmutableSampler() const override { return immutable_; }; VkSampler GetSampler() const { return sampler_; } private: // bool ValidateSampler(const VkSampler) const; VkSampler sampler_; bool immutable_; }; class ImageSamplerDescriptor : public Descriptor { public: ImageSamplerDescriptor(const VkSampler *); void WriteUpdate(const VkWriteDescriptorSet *, const uint32_t) override; void CopyUpdate(const Descriptor *) override; void BindCommandBuffer(const core_validation::layer_data *, GLOBAL_CB_NODE *) override; virtual bool IsImmutableSampler() const override { return immutable_; }; VkSampler GetSampler() const { return sampler_; } VkImageView GetImageView() const { return image_view_; } VkImageLayout GetImageLayout() const { return image_layout_; } private: VkSampler sampler_; bool immutable_; VkImageView image_view_; VkImageLayout image_layout_; }; class ImageDescriptor : public Descriptor { public: ImageDescriptor(const VkDescriptorType); void WriteUpdate(const VkWriteDescriptorSet *, const uint32_t) override; void CopyUpdate(const Descriptor *) override; void BindCommandBuffer(const core_validation::layer_data *, GLOBAL_CB_NODE *) override; virtual bool IsStorage() const override { return storage_; } VkImageView GetImageView() const { return image_view_; } VkImageLayout GetImageLayout() const { return image_layout_; } private: bool storage_; VkImageView image_view_; VkImageLayout image_layout_; }; class TexelDescriptor : public Descriptor { public: TexelDescriptor(const VkDescriptorType); void WriteUpdate(const VkWriteDescriptorSet *, const uint32_t) override; void CopyUpdate(const Descriptor *) override; void BindCommandBuffer(const core_validation::layer_data *, GLOBAL_CB_NODE *) override; virtual bool IsStorage() const override { return storage_; } VkBufferView GetBufferView() const { return buffer_view_; } private: VkBufferView buffer_view_; bool storage_; }; class BufferDescriptor : public Descriptor { public: BufferDescriptor(const VkDescriptorType); void WriteUpdate(const VkWriteDescriptorSet *, const uint32_t) override; void CopyUpdate(const Descriptor *) override; void BindCommandBuffer(const core_validation::layer_data *, GLOBAL_CB_NODE *) override; virtual bool IsDynamic() const override { return dynamic_; } virtual bool IsStorage() const override { return storage_; } VkBuffer GetBuffer() const { return buffer_; } VkDeviceSize GetOffset() const { return offset_; } VkDeviceSize GetRange() const { return range_; } private: bool storage_; bool dynamic_; VkBuffer buffer_; VkDeviceSize offset_; VkDeviceSize range_; }; // Structs to contain common elements that need to be shared between Validate* and Perform* calls below struct AllocateDescriptorSetsData { uint32_t required_descriptors_by_type[VK_DESCRIPTOR_TYPE_RANGE_SIZE]; std::vector> layout_nodes; AllocateDescriptorSetsData(uint32_t); }; // Helper functions for descriptor set functions that cross multiple sets // "Validate" will make sure an update is ok without actually performing it bool ValidateUpdateDescriptorSets(const debug_report_data *, const core_validation::layer_data *, uint32_t, const VkWriteDescriptorSet *, uint32_t, const VkCopyDescriptorSet *); // "Perform" does the update with the assumption that ValidateUpdateDescriptorSets() has passed for the given update void PerformUpdateDescriptorSets(const core_validation::layer_data *, uint32_t, const VkWriteDescriptorSet *, uint32_t, const VkCopyDescriptorSet *); // Similar to PerformUpdateDescriptorSets, this function will do the same for updating via templates void PerformUpdateDescriptorSetsWithTemplateKHR(layer_data *, VkDescriptorSet, std::unique_ptr const &, const void *); // Update the common AllocateDescriptorSetsData struct which can then be shared between Validate* and Perform* funcs below void UpdateAllocateDescriptorSetsData(const layer_data *dev_data, const VkDescriptorSetAllocateInfo *, AllocateDescriptorSetsData *); // Validate that Allocation state is ok bool ValidateAllocateDescriptorSets(const core_validation::layer_data *, const VkDescriptorSetAllocateInfo *, const AllocateDescriptorSetsData *); // Update state based on allocating new descriptorsets void PerformAllocateDescriptorSets(const VkDescriptorSetAllocateInfo *, const VkDescriptorSet *, const AllocateDescriptorSetsData *, std::unordered_map *, std::unordered_map *, core_validation::layer_data *); /* * DescriptorSet class * * Overview - This class encapsulates the Vulkan VkDescriptorSet data (set). * A set has an underlying layout which defines the bindings in the set and the * types and numbers of descriptors in each descriptor slot. Most of the layout * interfaces are exposed through identically-named functions in the set class. * Please refer to the DescriptorSetLayout comment above for a description of * index, binding, and global index. * * At construction a vector of Descriptor* is created with types corresponding to the * layout. The primary operation performed on the descriptors is to update them * via write or copy updates, and validate that the update contents are correct. * In order to validate update contents, the DescriptorSet stores a bunch of ptrs * to data maps where various Vulkan objects can be looked up. The management of * those maps is performed externally. The set class relies on their contents to * be correct at the time of update. */ class DescriptorSet : public BASE_NODE { public: DescriptorSet(const VkDescriptorSet, const VkDescriptorPool, const std::shared_ptr &, core_validation::layer_data *); ~DescriptorSet(); // A number of common Get* functions that return data based on layout from which this set was created uint32_t GetTotalDescriptorCount() const { return p_layout_->GetTotalDescriptorCount(); }; uint32_t GetDynamicDescriptorCount() const { return p_layout_->GetDynamicDescriptorCount(); }; uint32_t GetBindingCount() const { return p_layout_->GetBindingCount(); }; VkDescriptorType GetTypeFromIndex(const uint32_t index) const { return p_layout_->GetTypeFromIndex(index); }; VkDescriptorType GetTypeFromGlobalIndex(const uint32_t index) const { return p_layout_->GetTypeFromGlobalIndex(index); }; VkDescriptorType GetTypeFromBinding(const uint32_t binding) const { return p_layout_->GetTypeFromBinding(binding); }; uint32_t GetDescriptorCountFromIndex(const uint32_t index) const { return p_layout_->GetDescriptorCountFromIndex(index); }; uint32_t GetDescriptorCountFromBinding(const uint32_t binding) const { return p_layout_->GetDescriptorCountFromBinding(binding); }; // Return index into dynamic offset array for given binding int32_t GetDynamicOffsetIndexFromBinding(uint32_t binding) const { return p_layout_->GetDynamicOffsetIndexFromBinding(binding); } // Return true if given binding is present in this set bool HasBinding(const uint32_t binding) const { return p_layout_->HasBinding(binding); }; // Is this set compatible with the given layout? bool IsCompatible(DescriptorSetLayout const *const, std::string *) const; // For given bindings validate state at time of draw is correct, returning false on error and writing error details into string* bool ValidateDrawState(const std::map &, const std::vector &, GLOBAL_CB_NODE *, const char *caller, std::string *) const; // For given set of bindings, add any buffers and images that will be updated to their respective unordered_sets & return number // of objects inserted uint32_t GetStorageUpdates(const std::map &, std::unordered_set *, std::unordered_set *) const; // Descriptor Update functions. These functions validate state and perform update separately // Validate contents of a WriteUpdate bool ValidateWriteUpdate(const debug_report_data *, const VkWriteDescriptorSet *, UNIQUE_VALIDATION_ERROR_CODE *, std::string *); // Perform a WriteUpdate whose contents were just validated using ValidateWriteUpdate void PerformWriteUpdate(const VkWriteDescriptorSet *); // Validate contents of a CopyUpdate bool ValidateCopyUpdate(const debug_report_data *, const VkCopyDescriptorSet *, const DescriptorSet *, UNIQUE_VALIDATION_ERROR_CODE *, std::string *); // Perform a CopyUpdate whose contents were just validated using ValidateCopyUpdate void PerformCopyUpdate(const VkCopyDescriptorSet *, const DescriptorSet *); std::shared_ptr const GetLayout() const { return p_layout_; }; VkDescriptorSet GetSet() const { return set_; }; // Return unordered_set of all command buffers that this set is bound to std::unordered_set GetBoundCmdBuffers() const { return cb_bindings; } // Bind given cmd_buffer to this descriptor set void BindCommandBuffer(GLOBAL_CB_NODE *, const std::map &); // Track work that has been bound or validated to avoid duplicate work, important when large descriptor arrays // are present typedef std::unordered_set TrackedBindings; static void FilterAndTrackOneBindingReq(const BindingReqMap::value_type &binding_req_pair, const BindingReqMap &in_req, BindingReqMap *out_req, TrackedBindings *set); static void FilterAndTrackOneBindingReq(const BindingReqMap::value_type &binding_req_pair, const BindingReqMap &in_req, BindingReqMap *out_req, TrackedBindings *set, uint32_t limit); void FilterAndTrackBindingReqs(GLOBAL_CB_NODE *, const BindingReqMap &in_req, BindingReqMap *out_req); void FilterAndTrackBindingReqs(GLOBAL_CB_NODE *, PIPELINE_STATE *, const BindingReqMap &in_req, BindingReqMap *out_req); void ClearCachedDynamicDescriptorValidation(GLOBAL_CB_NODE *cb_state) { cached_validation_[cb_state].dynamic_buffers.clear(); } void ClearCachedValidation(GLOBAL_CB_NODE *cb_state) { cached_validation_.erase(cb_state); } // If given cmd_buffer is in the cb_bindings set, remove it void RemoveBoundCommandBuffer(GLOBAL_CB_NODE *cb_node) { cb_bindings.erase(cb_node); ClearCachedValidation(cb_node); } VkSampler const *GetImmutableSamplerPtrFromBinding(const uint32_t index) const { return p_layout_->GetImmutableSamplerPtrFromBinding(index); }; // For a particular binding, get the global index const IndexRange &GetGlobalIndexRangeFromBinding(const uint32_t binding) const { return p_layout_->GetGlobalIndexRangeFromBinding(binding); }; // Return true if any part of set has ever been updated bool IsUpdated() const { return some_update_; }; bool IsPushDescriptor() const { return p_layout_->IsPushDescriptor(); }; private: bool VerifyWriteUpdateContents(const VkWriteDescriptorSet *, const uint32_t, UNIQUE_VALIDATION_ERROR_CODE *, std::string *) const; bool VerifyCopyUpdateContents(const VkCopyDescriptorSet *, const DescriptorSet *, VkDescriptorType, uint32_t, UNIQUE_VALIDATION_ERROR_CODE *, std::string *) const; bool ValidateBufferUsage(BUFFER_STATE const *, VkDescriptorType, UNIQUE_VALIDATION_ERROR_CODE *, std::string *) const; bool ValidateBufferUpdate(VkDescriptorBufferInfo const *, VkDescriptorType, UNIQUE_VALIDATION_ERROR_CODE *, std::string *) const; // Private helper to set all bound cmd buffers to INVALID state void InvalidateBoundCmdBuffers(); bool some_update_; // has any part of the set ever been updated? VkDescriptorSet set_; DESCRIPTOR_POOL_STATE *pool_state_; const std::shared_ptr p_layout_; std::vector> descriptors_; // Ptr to device data used for various data look-ups core_validation::layer_data *const device_data_; const VkPhysicalDeviceLimits limits_; // Cached binding and validation support: // // For the lifespan of a given command buffer recording, do lazy evaluation, caching, and dirtying of // expensive validation operation (typically per-draw) typedef std::unordered_map TrackedBindingMap; typedef std::unordered_map ValidatedBindings; // Track the validation caching of bindings vs. the command buffer and draw state typedef std::unordered_map VersionedBindings; struct CachedValidation { TrackedBindings command_binding_and_usage; // Persistent for the life of the recording TrackedBindings non_dynamic_buffers; // Persistent for the life of the recording TrackedBindings dynamic_buffers; // Dirtied (flushed) each BindDescriptorSet std::unordered_map image_samplers; // Tested vs. changes to CB's ImageLayout }; typedef std::unordered_map CachedValidationMap; // Image and ImageView bindings are validated per pipeline and not invalidate by repeated binding CachedValidationMap cached_validation_; }; // For the "bindless" style resource usage with many descriptors, need to optimize binding and validation class PrefilterBindRequestMap { public: static const uint32_t kManyDescriptors_ = 64; // TODO base this number on measured data std::unique_ptr filtered_map_; const BindingReqMap &orig_map_; PrefilterBindRequestMap(DescriptorSet &ds, const BindingReqMap &in_map, GLOBAL_CB_NODE *cb_state); PrefilterBindRequestMap(DescriptorSet &ds, const BindingReqMap &in_map, GLOBAL_CB_NODE *cb_state, PIPELINE_STATE *); const BindingReqMap &Map() const { return (filtered_map_) ? *filtered_map_ : orig_map_; } }; } #endif // CORE_VALIDATION_DESCRIPTOR_SETS_H_