1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
|
/* Copyright (c) 2015-2025 The Khronos Group Inc.
* Copyright (c) 2015-2025 Valve Corporation
* Copyright (c) 2015-2025 LunarG, Inc.
* Copyright (C) 2015-2025 Google Inc.
* Modifications Copyright (C) 2020 Advanced Micro Devices, Inc. All rights reserved.
*
* 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.
*/
#pragma once
#include <vector>
#include <memory>
#include "state_tracker/state_object.h"
#include "utils/hash_util.h"
#include "utils/hash_vk_types.h"
#include "containers/span.h"
// Fwd declarations -- including descriptor_set.h creates an ugly include loop
namespace vvl {
class DeviceState;
class DescriptorSetLayout;
class DescriptorSetLayoutDef;
} // namespace vvl
namespace spirv {
struct ResourceInterfaceVariable;
} // namespace spirv
// Canonical dictionary for the pipeline layout's layout of descriptorsetlayouts
using DescriptorSetLayoutDef = vvl::DescriptorSetLayoutDef;
using DescriptorSetLayoutId = std::shared_ptr<const DescriptorSetLayoutDef>;
using PipelineLayoutSetLayoutsDef = std::vector<DescriptorSetLayoutId>;
using PipelineLayoutSetLayoutsDict =
hash_util::Dictionary<PipelineLayoutSetLayoutsDef, hash_util::IsOrderedContainer<PipelineLayoutSetLayoutsDef>>;
using PipelineLayoutSetLayoutsId = PipelineLayoutSetLayoutsDict::Id;
// Canonical dictionary for PushConstantRanges
using PushConstantRangesDict = hash_util::Dictionary<PushConstantRanges>;
using PushConstantRangesId = PushConstantRangesDict::Id;
// Defines/stores a compatibility defintion for set N
// The "layout layout" must store at least set+1 entries, but only the first set+1 are considered for hash and equality testing
// Note: the "cannonical" data are referenced by Id, not including handle or device specific state
// Note: hash and equality only consider layout_id entries [0, set] for determining uniqueness
struct PipelineLayoutCompatDef {
uint32_t set;
PushConstantRangesId push_constant_ranges;
PipelineLayoutSetLayoutsId set_layouts_id;
bool is_independent_sets; // VK_PIPELINE_LAYOUT_CREATE_INDEPENDENT_SETS_BIT_EXT
PipelineLayoutCompatDef(const uint32_t set_index, const PushConstantRangesId pcr_id, const PipelineLayoutSetLayoutsId sl_id,
bool is_independent_sets)
: set(set_index), push_constant_ranges(pcr_id), set_layouts_id(sl_id), is_independent_sets(is_independent_sets) {}
size_t hash() const;
bool operator==(const PipelineLayoutCompatDef &other) const;
std::string DescribeDifference(const PipelineLayoutCompatDef &other) const;
};
// Canonical dictionary for PipelineLayoutCompat records
using PipelineLayoutCompatDict = hash_util::Dictionary<PipelineLayoutCompatDef, hash_util::HasHashMember<PipelineLayoutCompatDef>>;
using PipelineLayoutCompatId = PipelineLayoutCompatDict::Id;
PushConstantRangesId GetCanonicalId(uint32_t pushConstantRangeCount, const VkPushConstantRange *pPushConstantRanges);
namespace vvl {
// Store layouts and pushconstants for PipelineLayout
class PipelineLayout : public StateObject {
public:
using SetLayoutVector = std::vector<std::shared_ptr<vvl::DescriptorSetLayout const>>;
const SetLayoutVector set_layouts;
// canonical form IDs for the "compatible for set" contents
const PushConstantRangesId push_constant_ranges_layout;
VkPipelineLayoutCreateFlags create_flags;
// table of "compatible for set N" cannonical forms for trivial accept validation
const std::vector<PipelineLayoutCompatId> set_compat_ids;
// Way to quick prevent searching if we know there are no immutable samplers
bool has_immutable_samplers;
PipelineLayout(DeviceState &dev_data, VkPipelineLayout handle, const VkPipelineLayoutCreateInfo *pCreateInfo);
// Merge 2 or more non-overlapping layouts
PipelineLayout(const vvl::span<const PipelineLayout *const> &layouts);
template <typename Container>
PipelineLayout(const Container &layouts) : PipelineLayout(vvl::span<const PipelineLayout *const>{layouts}) {}
VkPipelineLayout VkHandle() const { return handle_.Cast<VkPipelineLayout>(); }
VkPipelineLayoutCreateFlags CreateFlags() const { return create_flags; }
bool IsIndependentSets() const { return (create_flags & VK_PIPELINE_LAYOUT_CREATE_INDEPENDENT_SETS_BIT_EXT) != 0; }
const VkDescriptorSetLayoutBinding *FindBinding(const spirv::ResourceInterfaceVariable &variable) const;
};
} // namespace vvl
std::vector<PipelineLayoutCompatId> GetCompatForSet(const std::vector<std::shared_ptr<vvl::DescriptorSetLayout const>> &set_layouts,
const PushConstantRangesId &push_constant_ranges,
VkPipelineLayoutCreateFlags pipeline_layout_create_flags);
|