cachewell/
lib.rs

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
use lru::LruCache;
use std::{hash::Hash, num::NonZeroUsize};

enum Value<V> {
    Detached,
    Pinned(V),
    Regular(V),
}

impl<V> Value<V> {
    fn get(&self) -> &V {
        match self {
            Value::Detached => panic!("Value is detached"),
            Value::Pinned(v) => v,
            Value::Regular(v) => v,
        }
    }

    fn get_mut(&mut self) -> &mut V {
        match self {
            Value::Detached => panic!("Value is detached"),
            Value::Pinned(v) => v,
            Value::Regular(v) => v,
        }
    }

    fn out(self, pin_count: &mut usize) -> V {
        match self {
            Value::Detached => panic!("Value is detached"),
            Value::Pinned(v) => {
                *pin_count -= 1;
                v
            }
            Value::Regular(v) => v,
        }
    }
}

pub struct Cache<K: Clone + PartialEq + Eq + Hash, V> {
    entries: LruCache<K, Value<V>>,
    detach_count: usize,
    pin_count: usize,
}

impl<K: Clone + PartialEq + Eq + Hash, V> Cache<K, V> {
    pub fn attach(&mut self, key: &K, val: V) {
        let (key, d_val) = self
            .entries
            .pop_entry(key)
            .expect("Cannot attach: Requested entry is not cached");
        assert!(
            matches!(d_val, Value::Detached),
            "Only detached entries can be attached"
        );
        self.entries.push(key, Value::Regular(val));
        self.detach_count -= 1;
    }

    // NOTE: This will also detach pinned entries
    pub fn detach(&mut self, key: &K) -> V {
        let (key, val) = self
            .entries
            .pop_entry(key)
            .expect("Cannot detach: Requested entry is not cached");
        self.entries.push(key, Value::Detached);
        self.detach_count += 1;
        val.out(&mut self.pin_count)
    }

    // NOTE: This will also evict pinned entries
    pub fn empty(&mut self) -> Vec<(K, V)> {
        let mut entries = Vec::new();
        while let Some((key, val)) = self.entries.pop_lru() {
            entries.push((key, val.out(&mut self.pin_count)))
        }
        entries
    }

    pub fn get(&mut self, key: &K) -> &V {
        self.entries
            .get(key)
            .expect("Cannot get: Requested entry is not cached")
            .get()
    }

    pub fn get_mut(&mut self, key: &K) -> &mut V {
        self.entries
            .get_mut(key)
            .expect("Cannot get_mut: Requested entry is not cached")
            .get_mut()
    }

    pub fn is_cached(&self, key: &K) -> bool {
        self.entries.contains(key)
    }

    pub fn len(&self) -> usize {
        self.entries.len()
    }

    pub fn margin(&self) -> usize {
        self.entries.cap().get() - self.detach_count - self.pin_count
    }

    pub fn new(cap: NonZeroUsize) -> Self {
        Self {
            entries: LruCache::new(cap),
            detach_count: 0,
            pin_count: 0,
        }
    }

    pub fn pin(&mut self, key: &K) {
        let (key, val) = self
            .entries
            .pop_entry(key)
            .expect("Cannot pin: Requested entry is not cached");
        self.entries
            .push(key, Value::Pinned(val.out(&mut self.pin_count)));
        self.pin_count += 1;
    }

    pub fn pop(&mut self, key: &K) -> V {
        self.entries
            .pop(key)
            .expect("Cannot pop: Requested entry is not cached")
            .out(&mut self.pin_count)
    }

    pub fn pop_lru(&mut self) -> Option<(K, V)> {
        self.refresh();
        self.entries.pop_lru().map(|(k, v)| (k, v.out(&mut 0)))
    }

    pub fn push(&mut self, key: K, val: V) -> Option<(K, V)> {
        self.refresh();
        self.entries
            .push(key, Value::Regular(val))
            .map(|(k, v)| (k, v.out(&mut 0)))
    }

    fn refresh(&mut self) {
        if self.entries.len() < self.entries.cap().get() {
            return;
        }
        assert!(
            self.margin() > 0,
            "Cache Overflow -- Capacity: {}, Detached: {}, Pinned: {}",
            self.entries.cap().get(),
            self.detach_count,
            self.pin_count
        );
        loop {
            let key = match self.entries.peek_lru() {
                Some((key, val)) if !matches!(val, Value::Regular(_)) => key.clone(),
                _ => break,
            };
            self.entries.promote(&key);
        }
    }

    pub fn unpin(&mut self, key: &K) {
        let (key, val) = self
            .entries
            .pop_entry(key)
            .expect("Cannot unpin: Requested entry is not cached");
        self.entries
            .push(key, Value::Regular(val.out(&mut self.pin_count)));
    }
}