Files
Vulkan-Samples/framework/hpp_resource_cache.cpp
2025-09-04 10:54:47 +08:00

218 lines
8.0 KiB
C++

/* Copyright (c) 2023-2025, NVIDIA CORPORATION. All rights reserved.
*
* SPDX-License-Identifier: Apache-2.0
*
* 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.
*/
#include "hpp_resource_cache.h"
#include "core/device.h"
#include <common/hpp_resource_caching.h>
#include <core/hpp_descriptor_set.h>
#include <core/hpp_image_view.h>
#include <core/hpp_pipeline_layout.h>
namespace vkb
{
namespace
{
template <class T, class... A>
T &request_resource(
vkb::core::DeviceCpp &device, vkb::HPPResourceRecord &recorder, std::mutex &resource_mutex, std::unordered_map<std::size_t, T> &resources, A &...args)
{
std::lock_guard<std::mutex> guard(resource_mutex);
auto &res = vkb::common::request_resource(device, &recorder, resources, args...);
return res;
}
} // namespace
HPPResourceCache::HPPResourceCache(vkb::core::DeviceCpp &device) :
device{device}
{}
void HPPResourceCache::clear()
{
state.shader_modules.clear();
state.pipeline_layouts.clear();
state.descriptor_sets.clear();
state.descriptor_set_layouts.clear();
state.render_passes.clear();
clear_pipelines();
clear_framebuffers();
}
void HPPResourceCache::clear_framebuffers()
{
state.framebuffers.clear();
}
void HPPResourceCache::clear_pipelines()
{
state.graphics_pipelines.clear();
state.compute_pipelines.clear();
}
const HPPResourceCacheState &HPPResourceCache::get_internal_state() const
{
return state;
}
vkb::core::HPPComputePipeline &HPPResourceCache::request_compute_pipeline(vkb::rendering::HPPPipelineState &pipeline_state)
{
return request_resource(device, recorder, compute_pipeline_mutex, state.compute_pipelines, pipeline_cache, pipeline_state);
}
vkb::core::HPPDescriptorSet &HPPResourceCache::request_descriptor_set(vkb::core::HPPDescriptorSetLayout &descriptor_set_layout,
const BindingMap<vk::DescriptorBufferInfo> &buffer_infos,
const BindingMap<vk::DescriptorImageInfo> &image_infos)
{
auto &descriptor_pool = request_resource(device, recorder, descriptor_set_mutex, state.descriptor_pools, descriptor_set_layout);
return request_resource(device, recorder, descriptor_set_mutex, state.descriptor_sets, descriptor_set_layout, descriptor_pool, buffer_infos, image_infos);
}
vkb::core::HPPDescriptorSetLayout &HPPResourceCache::request_descriptor_set_layout(const uint32_t set_index,
const std::vector<vkb::core::HPPShaderModule *> &shader_modules,
const std::vector<vkb::core::HPPShaderResource> &set_resources)
{
return request_resource(device, recorder, descriptor_set_layout_mutex, state.descriptor_set_layouts, set_index, shader_modules, set_resources);
}
vkb::core::HPPFramebuffer &HPPResourceCache::request_framebuffer(const vkb::rendering::HPPRenderTarget &render_target,
const vkb::core::HPPRenderPass &render_pass)
{
return request_resource(device, recorder, framebuffer_mutex, state.framebuffers, render_target, render_pass);
}
vkb::core::HPPGraphicsPipeline &HPPResourceCache::request_graphics_pipeline(vkb::rendering::HPPPipelineState &pipeline_state)
{
return request_resource(device, recorder, graphics_pipeline_mutex, state.graphics_pipelines, pipeline_cache, pipeline_state);
}
vkb::core::HPPPipelineLayout &HPPResourceCache::request_pipeline_layout(const std::vector<vkb::core::HPPShaderModule *> &shader_modules)
{
return request_resource(device, recorder, pipeline_layout_mutex, state.pipeline_layouts, shader_modules);
}
vkb::core::HPPRenderPass &HPPResourceCache::request_render_pass(const std::vector<vkb::rendering::HPPAttachment> &attachments,
const std::vector<vkb::common::HPPLoadStoreInfo> &load_store_infos,
const std::vector<vkb::core::HPPSubpassInfo> &subpasses)
{
return request_resource(device, recorder, render_pass_mutex, state.render_passes, attachments, load_store_infos, subpasses);
}
vkb::core::HPPShaderModule &HPPResourceCache::request_shader_module(vk::ShaderStageFlagBits stage,
const vkb::core::HPPShaderSource &glsl_source,
const vkb::core::HPPShaderVariant &shader_variant)
{
std::string entry_point{"main"};
return request_resource(device, recorder, shader_module_mutex, state.shader_modules, stage, glsl_source, entry_point, shader_variant);
}
std::vector<uint8_t> HPPResourceCache::serialize()
{
return recorder.get_data();
}
void HPPResourceCache::set_pipeline_cache(vk::PipelineCache new_pipeline_cache)
{
pipeline_cache = new_pipeline_cache;
}
void HPPResourceCache::update_descriptor_sets(const std::vector<vkb::core::HPPImageView> &old_views, const std::vector<vkb::core::HPPImageView> &new_views)
{
// Find descriptor sets referring to the old image view
std::vector<vk::WriteDescriptorSet> set_updates;
std::set<size_t> matches;
for (size_t i = 0; i < old_views.size(); ++i)
{
auto &old_view = old_views[i];
auto &new_view = new_views[i];
for (auto &kd_pair : state.descriptor_sets)
{
auto &key = kd_pair.first;
auto &descriptor_set = kd_pair.second;
auto &image_infos = descriptor_set.get_image_infos();
for (auto &ba_pair : image_infos)
{
auto &binding = ba_pair.first;
auto &array = ba_pair.second;
for (auto &ai_pair : array)
{
auto &array_element = ai_pair.first;
auto &image_info = ai_pair.second;
if (image_info.imageView == old_view.get_handle())
{
// Save key to remove old descriptor set
matches.insert(key);
// Update image info with new view
image_info.imageView = new_view.get_handle();
// Save struct for writing the update later
if (auto binding_info = descriptor_set.get_layout().get_layout_binding(binding))
{
vk::WriteDescriptorSet write_descriptor_set{.dstSet = descriptor_set.get_handle(),
.dstBinding = binding,
.dstArrayElement = array_element,
.descriptorCount = 1,
.descriptorType = binding_info->descriptorType,
.pImageInfo = &image_info};
set_updates.push_back(write_descriptor_set);
}
else
{
LOGE("Shader layout set does not use image binding at #{}", binding);
}
}
}
}
}
}
if (!set_updates.empty())
{
device.get_handle().updateDescriptorSets(set_updates, {});
}
// Delete old entries (moved out descriptor sets)
for (auto &match : matches)
{
// Move out of the map
auto it = state.descriptor_sets.find(match);
auto descriptor_set = std::move(it->second);
state.descriptor_sets.erase(match);
// Generate new key
size_t new_key = std::hash<vkb::core::HPPDescriptorSet>()(descriptor_set);
// Add (key, resource) to the cache
state.descriptor_sets.emplace(new_key, std::move(descriptor_set));
}
}
void HPPResourceCache::warmup(const std::vector<uint8_t> &data)
{
recorder.set_data(data);
replayer.play(*this, recorder);
}
} // namespace vkb