k_cache/
cache.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
use std::hash::Hash;
use std::marker::PhantomData;
use std::sync::atomic::AtomicBool;
use std::sync::Arc;
use std::{
    borrow::Borrow,
    collections::{HashMap, VecDeque},
    hash::BuildHasher,
};

pub trait Weigher<K, V> {
    fn weigh(_k: &K, _v: &V) -> usize {
        1
    }
}

#[derive(Debug, Clone)]
pub struct One;
impl<K, V> Weigher<K, V> for One {}

struct SieveEntry<D> {
    data: D,
    visited: Arc<AtomicBool>,
}

pub struct Cache<K, V, S, W: Weigher<K, V> = One> {
    map: HashMap<K, SieveEntry<V>, S>,
    sieve_pool: VecDeque<SieveEntry<K>>,
    sieve_hand: usize,
    max_weight: usize,
    weight: usize,
    _phantom: PhantomData<W>,
}

impl<K, V, S, W> Cache<K, V, S, W>
where
    K: Eq + Hash + Clone,
    S: BuildHasher,
    W: Weigher<K, V>,
{
    pub fn new(hasher: S, max_weight: usize) -> Self {
        Self {
            map: HashMap::with_hasher(hasher),
            sieve_pool: VecDeque::new(),
            sieve_hand: 0,
            max_weight,
            weight: 0,
            _phantom: PhantomData,
        }
    }

    pub fn put(&mut self, key: K, value: V) {
        let new_weight = self.make_room_for(&key, &value);
        self.weight += new_weight;
        let visited = Arc::new(AtomicBool::new(true));
        if let Some(replaced) = self.map.insert(
            key.clone(),
            SieveEntry {
                data: value,
                visited: visited.clone(),
            },
        ) {
            let replaced_weight = W::weigh(&key, &replaced.data);
            match self.weight.checked_sub(replaced_weight) {
                Some(new_weight) => self.weight = new_weight,
                None => {
                    log::error!("weight underflow");
                    self.weight = 0;
                }
            }
        }
        self.sieve_pool.push_back(SieveEntry {
            data: key.clone(),
            visited,
        });
    }

    pub fn get<Q>(&self, key: &Q) -> Option<&V>
    where
        K: Borrow<Q>,
        Q: Hash + Eq + ?Sized,
    {
        match self.map.get(key) {
            Some(entry) => {
                entry
                    .visited
                    .store(true, std::sync::atomic::Ordering::Relaxed);
                Some(&entry.data)
            }
            None => None,
        }
    }

    fn make_room_for(&mut self, key: &K, value: &V) -> usize {
        let entry_weight = W::weigh(key, value);
        while self.max_weight < self.weight + entry_weight {
            let sieve_entry = &mut self.sieve_pool[self.sieve_hand];
            let visited = sieve_entry
                .visited
                .swap(false, std::sync::atomic::Ordering::Relaxed);
            if visited {
                self.sieve_hand = (self.sieve_hand + 1) % self.sieve_pool.len();
            } else {
                let sieve_key_entry = self
                    .sieve_pool
                    .swap_remove_back(self.sieve_hand)
                    .expect("the index must be present");
                match self.map.remove(&sieve_key_entry.data) {
                    Some(removed) => {
                        let removed_weight = W::weigh(&sieve_key_entry.data, &removed.data);
                        match self.weight.checked_sub(removed_weight) {
                            Some(new_weight) => self.weight = new_weight,
                            None => {
                                log::error!("weight underflow");
                                self.weight = 0;
                            }
                        }
                    }
                    None => {
                        log::debug!("garbage collecting sieve entry as {}", self.sieve_hand);
                    }
                }

                if self.sieve_hand == self.sieve_pool.len() {
                    self.sieve_hand = 0;
                }
            }
        }
        entry_weight
    }
}