8#include <userver/cache/expirable_lru_cache.hpp>
9#include <userver/cache/lru_cache_config.hpp>
10#include <userver/components/component_base.hpp>
11#include <userver/concurrent/async_event_source.hpp>
12#include <userver/dump/dumper.hpp>
13#include <userver/dump/meta.hpp>
14#include <userver/dump/operations.hpp>
15#include <userver/dynamic_config/source.hpp>
16#include <userver/logging/log.hpp>
17#include <userver/testsuite/cache_control.hpp>
18#include <userver/utils/statistics/entry.hpp>
19#include <userver/yaml_config/schema.hpp>
21USERVER_NAMESPACE_BEGIN
27utils::statistics::Entry RegisterOnStatisticsStorage(
29 const std::string& name,
30 std::function<
void(
utils::statistics::Writer&)> func
33dynamic_config::Source FindDynamicConfigSource(
const components::ComponentContext& context);
35bool IsDumpSupportEnabled(
const components::ComponentConfig& config);
37yaml_config::Schema GetLruCacheComponentBaseSchema();
76template <
typename Key,
typename Value,
typename Hash = std::hash<Key>,
typename Equal = std::equal_to<Key>>
80 using Cache = ExpirableLruCache<Key, Value, Hash, Equal>;
81 using CacheWrapper = LruCacheWrapper<Key, Value, Hash, Equal>;
85 ~LruCacheComponent()
override;
87 CacheWrapper GetCache();
92 virtual Value DoGetByKey(
const Key& key) = 0;
94 std::shared_ptr<Cache> GetCacheRaw() {
return cache_; }
99 Value GetByKey(
const Key& key);
101 void OnConfigUpdate(
const dynamic_config::Snapshot& cfg);
103 void UpdateConfig(
const LruCacheConfig& config);
105 static constexpr bool kCacheIsDumpable =
dump::kIsDumpable<Key> &&
dump::kIsDumpable<Value>;
107 void GetAndWrite(
dump::
Writer& writer)
const override;
108 void ReadAndSet(
dump::
Reader& reader)
override;
110 const std::string name_;
111 const LruCacheConfigStatic static_config_;
112 std::shared_ptr<
dump::Dumper> dumper_;
113 const std::shared_ptr<Cache> cache_;
116 concurrent::AsyncEventSubscriberScope config_subscription_;
117 utils::statistics::Entry statistics_holder_;
118 testsuite::CacheResetRegistration reset_registration_;
122template <
typename Key,
typename Value,
typename Hash,
typename Equal>
129 static_config_(config),
130 cache_(std::make_shared<Cache>(static_config_.ways, static_config_.GetWaySize())) {
131 if (impl::IsDumpSupportEnabled(config)) {
132 dumper_ = std::make_shared<dump::Dumper>(config, context,
static_cast<dump::DumpableEntity&>(*
this));
133 cache_->SetDumper(dumper_);
137 cache_->SetMaxLifetime(static_config_.config.lifetime);
138 cache_->SetBackgroundUpdate(static_config_.config.background_update);
140 if (static_config_.use_dynamic_config) {
141 LOG_INFO() <<
"Dynamic LRU cache config is enabled, subscribing on "
142 "dynamic-config updates, cache="
145 config_subscription_ = impl::FindDynamicConfigSource(context).UpdateAndListen(
149 LOG_INFO() <<
"Dynamic LRU cache config is disabled, cache=" << name_;
152 statistics_holder_ = impl::RegisterOnStatisticsStorage(context, name_, [
this](utils::statistics::Writer& writer) {
159template <
typename Key,
typename Value,
typename Hash,
typename Equal>
162 statistics_holder_.Unregister();
166 dumper_->CancelWriteTaskAndWait();
170template <
typename Key,
typename Value,
typename Hash,
typename Equal>
173 return CacheWrapper(cache_, [
this](
const Key& key) {
return GetByKey(key); });
176template <
typename Key,
typename Value,
typename Hash,
typename Equal>
178 cache_->Invalidate();
181template <
typename Key,
typename Value,
typename Hash,
typename Equal>
183 return DoGetByKey(key);
186template <
typename Key,
typename Value,
typename Hash,
typename Equal>
187void LruCacheComponent<Key, Value, Hash, Equal>::OnConfigUpdate(
const dynamic_config::Snapshot& cfg) {
188 const auto config = GetLruConfig(cfg, name_);
190 LOG_DEBUG() <<
"Using dynamic config for LRU cache";
191 UpdateConfig(*config);
193 LOG_DEBUG() <<
"Using static config for LRU cache";
194 UpdateConfig(static_config_.config);
198template <
typename Key,
typename Value,
typename Hash,
typename Equal>
199void LruCacheComponent<Key, Value, Hash, Equal>::UpdateConfig(
const LruCacheConfig& config) {
200 cache_->SetWaySize(config.GetWaySize(static_config_.ways));
201 cache_->SetMaxLifetime(config.lifetime);
202 cache_->SetBackgroundUpdate(config.background_update);
205template <
typename Key,
typename Value,
typename Hash,
typename Equal>
207 return impl::GetLruCacheComponentBaseSchema();
210template <
typename Key,
typename Value,
typename Hash,
typename Equal>
212 if constexpr (kCacheIsDumpable) {
213 cache_->Write(writer);
215 dump::ThrowDumpUnimplemented(name_);
219template <
typename Key,
typename Value,
typename Hash,
typename Equal>
221 if constexpr (kCacheIsDumpable) {
222 cache_->Read(reader);
224 dump::ThrowDumpUnimplemented(name_);