aboutsummaryrefslogtreecommitdiff
path: root/src/core/arm/nce/lru_cache.h
blob: 1bc00c8f1441439f197add18d7a8f8972ad48a44 (plain) (blame)
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
// SPDX-FileCopyrightText: Copyright 2025 Eden Emulator Project
// SPDX-License-Identifier: GPL-3.0-or-later

#pragma once
#include <list>
#include <optional>
#include <shared_mutex>
#include <unordered_map>
#include <utility>

#include "common/logging/log.h"

template <typename KeyType, typename ValueType>
class LRUCache {
public:
    using key_type   = KeyType;
    using value_type = ValueType;
    using size_type  = std::size_t;

    struct Statistics {
        size_type hits   = 0;
        size_type misses = 0;
        void reset() noexcept { hits = misses = 0; }
    };

    explicit LRUCache(size_type capacity, bool enabled = true)
        : enabled_{enabled}, capacity_{capacity} {
        cache_map_.reserve(capacity_);
        LOG_WARNING(Core, "LRU Cache initialised (state: {} | capacity: {})", enabled_ ? "enabled" : "disabled", capacity_);
    }

    // Non-movable copy semantics
    LRUCache(const LRUCache&)            = delete;
    LRUCache& operator=(const LRUCache&) = delete;
    LRUCache(LRUCache&& other) noexcept { *this = std::move(other); }
    LRUCache& operator=(LRUCache&& other) noexcept {
        if (this == &other) return *this;
        std::unique_lock this_lock(mutex_, std::defer_lock);
        std::unique_lock other_lock(other.mutex_, std::defer_lock);
        std::lock(this_lock, other_lock);
        enabled_ = other.enabled_;
        capacity_ = other.capacity_;
        cache_list_ = std::move(other.cache_list_);
        cache_map_ = std::move(other.cache_map_);
        stats_ = other.stats_;
        return *this;
    }
    ~LRUCache() = default;

    [[nodiscard]] value_type* get(const key_type& key) {
        if (!enabled_) [[unlikely]] return nullptr;
        std::unique_lock lock(mutex_);
        auto it = cache_map_.find(key);
        if (it == cache_map_.end()) {
            ++stats_.misses;
            return nullptr;
        }
        move_to_front(it);
        ++stats_.hits;
        return &it->second.second;
    }

    [[nodiscard]] value_type* peek(const key_type& key) const {
        if (!enabled_) [[unlikely]] return nullptr;
        std::shared_lock lock(mutex_);
        auto it = cache_map_.find(key);
        return it == cache_map_.end() ? nullptr : &it->second.second;
    }

    template <typename V>
    void put(const key_type& key, V&& value) {
        if (!enabled_) [[unlikely]] return;
        std::unique_lock lock(mutex_);
        insert_or_update(key, std::forward<V>(value));
    }

    template <typename ValueFactory>
    value_type& get_or_emplace(const key_type& key, ValueFactory&& factory) {
        std::unique_lock lock(mutex_);
        auto it = cache_map_.find(key);
        if (it != cache_map_.end()) {
            move_to_front(it);
            return it->second.second;
        }
        value_type new_value = factory();
        insert_or_update(key, std::move(new_value));
        return cache_map_.find(key)->second.second;
    }

    [[nodiscard]] bool contains(const key_type& key) const {
        if (!enabled_) return false;
        std::shared_lock lock(mutex_);
        return cache_map_.find(key) != cache_map_.end();
    }

    bool erase(const key_type& key) {
        if (!enabled_) return false;
        std::unique_lock lock(mutex_);
        auto it = cache_map_.find(key);
        if (it == cache_map_.end()) return false;
        cache_list_.erase(it->second.first);
        cache_map_.erase(it);
        return true;
    }

    void clear() {
        std::unique_lock lock(mutex_);
        cache_list_.clear();
        cache_map_.clear();
        stats_.reset();
    }

    [[nodiscard]] size_type size() const {
        if (!enabled_) return 0;
        std::shared_lock lock(mutex_);
        return cache_map_.size();
    }

    [[nodiscard]] size_type get_capacity() const { return capacity_; }

    void resize(size_type new_capacity) {
        if (!enabled_) return;
        std::unique_lock lock(mutex_);
        capacity_ = new_capacity;
        shrink_if_needed();
        cache_map_.reserve(capacity_);
    }

    void setEnabled(bool state) {
        std::unique_lock lock(mutex_);
        enabled_ = state;
        LOG_WARNING(Core, "LRU Cache state changed to: {}", state ? "enabled" : "disabled");
        if (!enabled_) clear();
    }

    [[nodiscard]] bool isEnabled() const { return enabled_; }

    [[nodiscard]] Statistics stats() const {
        std::shared_lock lock(mutex_);
        return stats_;
    }

private:
    using list_type      = std::list<key_type>;
    using list_iterator  = typename list_type::iterator;
    using map_value_type = std::pair<list_iterator, value_type>;
    using map_type       = std::unordered_map<key_type, map_value_type>;

    template <typename V>
    void insert_or_update(const key_type& key, V&& value) {
        auto it = cache_map_.find(key);
        if (it != cache_map_.end()) {
            it->second.second = std::forward<V>(value);
            move_to_front(it);
            return;
        }
        // evict LRU if full
        if (cache_map_.size() >= capacity_) {
            const auto& lru_key = cache_list_.back();
            cache_map_.erase(lru_key);
            cache_list_.pop_back();
        }
        cache_list_.push_front(key);
        cache_map_[key] = {cache_list_.begin(), std::forward<V>(value)};
    }

    void move_to_front(typename map_type::iterator it) {
        cache_list_.splice(cache_list_.begin(), cache_list_, it->second.first);
        it->second.first = cache_list_.begin();
    }

    void shrink_if_needed() {
        while (cache_map_.size() > capacity_) {
            const auto& lru_key = cache_list_.back();
            cache_map_.erase(lru_key);
            cache_list_.pop_back();
        }
    }

private:
    mutable std::shared_mutex mutex_;
    bool enabled_{true};
    size_type capacity_;
    list_type cache_list_;
    map_type cache_map_;
    mutable Statistics stats_;
};