File: lru_cache.h

package info (click to toggle)
asymptote 3.02%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 33,400 kB
  • sloc: cpp: 172,516; ansic: 69,728; python: 14,967; sh: 5,599; javascript: 4,866; lisp: 1,507; perl: 1,417; makefile: 1,028; yacc: 610; lex: 449; xml: 182; asm: 8
file content (187 lines) | stat: -rw-r--r-- 4,603 bytes parent folder | download | duplicates (2)
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
#pragma once

#include <algorithm>
#include <cassert>
#include <limits>
#include <memory>
#include <vector>
#include <cstdint>
// Cache that evicts old entries which have not been used recently. Implemented
// using array/linear search so this works well for small array sizes.
template<typename TKey, typename TValue>
struct LruCache
{
    explicit LruCache(int max_entries);

    // Fetches an entry for |key|. If it does not exist, |allocator| will be
    // invoked to create one.
    template<typename TAllocator>
    TValue Get(TKey const& key, TAllocator allocator);
    // Returns true if there is an entry for |key|.
    bool Has(TKey const& key);
    // Fetches the entry for |filename| and updates it's usage so it is less
    // likely to be evicted.
    bool TryGet(TKey const& key, TValue* dest);
    // TryGetEntry, except the entry is removed from the cache.
    bool TryTake(TKey const& key, TValue* dest);
    // Inserts an entry. Evicts the oldest unused entry if there is no space.
    void Insert(TKey const& key, TValue const& value);

    // Call |func| on existing entries. If |func| returns false iteration
    // terminates early.
    template<typename TFunc>
    void IterateValues(TFunc func);

    // Empties the cache
    void Clear(void);

private:
    // There is a global score counter, when we access an element we increase
    // its score to the current global value, so it has the highest overall
    // score. This means that the oldest/least recently accessed value has the
    // lowest score.
    //
    // There is a bit of special logic to handle score overlow.
    struct Entry
    {
        uint32_t score = 0;
        TKey key;
        TValue value;
        bool operator<(Entry const& other) const
        {
            return score < other.score;
        }
    };

    void IncrementScore();

    std::vector<Entry> entries_;
    int max_entries_ = 1;
    uint32_t next_score_ = 0;
};

template<typename TKey, typename TValue>
LruCache<TKey, TValue>::LruCache(int max_entries) : max_entries_(max_entries)
{
    assert(max_entries > 0);
}

template<typename TKey, typename TValue>
template<typename TAllocator>
TValue LruCache<TKey, TValue>::Get(TKey const& key, TAllocator allocator)
{
    for (Entry& entry : entries_)
    {
        if (entry.key == key)
        {
            return entry.value;
        }
    }

    auto result = allocator();
    Insert(key, result);
    return result;
}

template<typename TKey, typename TValue>
bool LruCache<TKey, TValue>::Has(TKey const& key)
{
    for (Entry& entry : entries_)
    {
        if (entry.key == key)
        {
            return true;
        }
    }
    return false;
}

template<typename TKey, typename TValue>
bool LruCache<TKey, TValue>::TryGet(TKey const& key, TValue* dest)
{
    // Assign new score.
    for (Entry& entry : entries_)
    {
        if (entry.key == key)
        {
            entry.score = next_score_;
            IncrementScore();
            if (dest)
            {
                *dest = entry.value;
            }
            return true;
        }
    }

    return false;
}

template<typename TKey, typename TValue>
bool LruCache<TKey, TValue>::TryTake(TKey const& key, TValue* dest)
{
    for (size_t i = 0; i < entries_.size(); ++i)
    {
        if (entries_[i].key == key)
        {
            if (dest)
            {
                *dest = entries_[i].value;
            }
            entries_.erase(entries_.begin() + i);
            return true;
        }
    }

    return false;
}

template<typename TKey, typename TValue>
void LruCache<TKey, TValue>::Insert(TKey const& key, TValue const& value)
{
    if ((int)entries_.size() >= max_entries_)
    {
        entries_.erase(std::min_element(entries_.begin(), entries_.end()));
    }

    Entry entry;
    entry.score = next_score_;
    IncrementScore();
    entry.key = key;
    entry.value = value;
    entries_.push_back(entry);
}

template<typename TKey, typename TValue>
template<typename TFunc>
void LruCache<TKey, TValue>::IterateValues(TFunc func)
{
    for (Entry& entry : entries_)
    {
        if (!func(entry.value))
        {
            break;
        }
    }
}

template<typename TKey, typename TValue>
void LruCache<TKey, TValue>::IncrementScore()
{
    // Overflow.
    if (++next_score_ == 0)
    {
        std::sort(entries_.begin(), entries_.end());
        for (Entry& entry : entries_)
        {
            entry.score = next_score_++;
        }
    }
}

template<typename TKey, typename TValue>
void LruCache<TKey, TValue>::Clear(void)
{
    entries_.clear();
    next_score_ = 0;
}