cache.rs 89.2%

83 of 93 lines run, 38 of 79 functions · run #542 on main · run missed

//! Caches of rendered output keyed by what the output depends on (hub spec
//! §16.3): the BLAKE3 of the content and of anything else that changes the
//! result, such as a Markdown file's link bases or a file's name, which
//! picks its syntax. Bounded by the bytes they hold; the least recently
//! used entries go first.

use std::collections::HashMap;
use std::sync::{Arc, Mutex};

pub struct Lru<V> {
    inner: Mutex<Inner<V>>,
}

struct Inner<V> {
    budget: usize,
    used: usize,
    tick: u64,
    hits: u64,
    misses: u64,
    map: HashMap<[u8; 32], (u64, Arc<V>, usize)>,
}

/// Something whose size counts against a cache's budget.
pub trait Weigh {
    fn weight(&self) -> usize;
}

impl Weigh for String {
    fn weight(&self) -> usize {
        self.len() + 32
    }
}

impl Weigh for Vec<String> {
    fn weight(&self) -> usize {
        self.iter().map(|s| s.len() + 24).sum::<usize>() + 32
    }
}

/// The key for a set of parts: BLAKE3 of each part's length and bytes.
pub fn key(parts: &[&[u8]]) -> [u8; 32] {
    let mut h = blake3::Hasher::new();
    for p in parts {
        h.update(&(p.len() as u64).to_le_bytes());
        h.update(p);
    }
    *h.finalize().as_bytes()
}

impl<V: Weigh> Lru<V> {
    pub fn new(budget: usize) -> Lru<V> {
        Lru { inner: Mutex::new(Inner { budget, used: 0, tick: 0, hits: 0, misses: 0, map: HashMap::new() }) }
    }

    /// The cached value for `key`, or `make()` stored and returned. `make`
    /// runs without the lock held, so a slow render blocks nobody.
    pub fn get_or(&self, key: [u8; 32], make: impl FnOnce() -> V) -> Arc<V> {
        {
            let mut g = self.inner.lock().unwrap_or_else(|p| p.into_inner());
            g.tick += 1;
            let tick = g.tick;
            if let Some(entry) = g.map.get_mut(&key) {
                entry.0 = tick;
                let v = entry.1.clone();
                g.hits += 1;
                return v;
            }
            g.misses += 1;
        }
        let value = Arc::new(make());
        let weight = value.weight();
        let mut g = self.inner.lock().unwrap_or_else(|p| p.into_inner());
        if weight > g.budget / 4 {
            return value; // too big to be worth keeping
        }
        g.tick += 1;
        let tick = g.tick;
        if let Some(old) = g.map.insert(key, (tick, value.clone(), weight)) {
            g.used -= old.2;
        }
        g.used += weight;
        while g.used > g.budget {
            let Some((&oldest, _)) = g.map.iter().min_by_key(|(_, e)| e.0) else { break };
            if let Some(e) = g.map.remove(&oldest) {
                g.used -= e.2;
            }
        }
        value
    }

    /// (hits, misses, bytes held).
    pub fn stats(&self) -> (u64, u64, usize) {
        let g = self.inner.lock().unwrap_or_else(|p| p.into_inner());
        (g.hits, g.misses, g.used)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn hits_misses_and_eviction() {
        let c: Lru<String> = Lru::new(400);
        let mut runs = 0;
        for _ in 0..3 {
            c.get_or(key(&[b"a"]), || {
                runs += 1;
                "x".repeat(50)
            });
        }
        assert_eq!(runs, 1, "rendered once");
        assert_eq!(c.stats().0, 2);
        // Filling past the budget drops the least recently used.
        c.get_or(key(&[b"b"]), || "y".repeat(90));
        c.get_or(key(&[b"a"]), || unreachable!());
        c.get_or(key(&[b"c"]), || "z".repeat(90));
        c.get_or(key(&[b"d"]), || "w".repeat(90));
        assert!(c.stats().2 <= 400);
        let mut again = false;
        c.get_or(key(&[b"b"]), || {
            again = true;
            String::new()
        });
        assert!(again, "b was the least recently used and went first");
        // Something larger than a quarter of the budget is not kept.
        c.get_or(key(&[b"huge"]), || "h".repeat(200));
        let mut rerun = false;
        c.get_or(key(&[b"huge"]), || {
            rerun = true;
            String::new()
        });
        assert!(rerun);
        // Parts are length-framed: ("ab","c") and ("a","bc") differ.
        assert_ne!(key(&[b"ab", b"c"]), key(&[b"a", b"bc"]));
    }
}

1		//! Caches of rendered output keyed by what the output depends on (hub spec
2		//! §16.3): the BLAKE3 of the content and of anything else that changes the
3		//! result, such as a Markdown file's link bases or a file's name, which
4		//! picks its syntax. Bounded by the bytes they hold; the least recently
5		//! used entries go first.
6
7		use std::collections::HashMap;
8		use std::sync::{Arc, Mutex};
9
10		pub struct Lru<V> {
11		inner: Mutex<Inner<V>>,
12		}
13
14		struct Inner<V> {
15		budget: usize,
16		used: usize,
17		tick: u64,
18		hits: u64,
19		misses: u64,
20		map: HashMap<[u8; 32], (u64, Arc<V>, usize)>,
21		}
22
23		/// Something whose size counts against a cache's budget.
24		pub trait Weigh {
25		fn weight(&self) -> usize;
26		}
27
28		impl Weigh for String {
29	68×	fn weight(&self) -> usize {
30	68×	self.len() + 32
31	68×	}
32		}
33
34		impl Weigh for Vec<String> {
35	16×	fn weight(&self) -> usize {
36	49×	self.iter().map(\|s\| s.len() + 24).sum::<usize>() + 32
37	16×	}
38		}
39
40		/// The key for a set of parts: BLAKE3 of each part's length and bytes.
41	347×	pub fn key(parts: &[&[u8]]) -> [u8; 32] {
42	347×	let mut h = blake3::Hasher::new();
43	1276×	for p in parts {
44	1276×	h.update(&(p.len() as u64).to_le_bytes());
45	1276×	h.update(p);
46	1276×	}
47	347×	*h.finalize().as_bytes()
48	347×	}
49
50		impl<V: Weigh> Lru<V> {
51	53×	pub fn new(budget: usize) -> Lru<V> {
52	53×	Lru { inner: Mutex::new(Inner { budget, used: 0, tick: 0, hits: 0, misses: 0, map: HashMap::new() }) }
53	53×	}
54
55		/// The cached value for `key`, or `make()` stored and returned. `make`
56		/// runs without the lock held, so a slow render blocks nobody.
57	345×	pub fn get_or(&self, key: [u8; 32], make: impl FnOnce() -> V) -> Arc<V> {
58		{
59	345×	let mut g = self.inner.lock().unwrap_or_else(\|p\| p.into_inner());
60	345×	g.tick += 1;
61	345×	let tick = g.tick;
62	345×	if let Some(entry) = g.map.get_mut(&key) {
63	243×	entry.0 = tick;
64	243×	let v = entry.1.clone();
65	243×	g.hits += 1;
66	243×	return v;
67	102×	}
68	102×	g.misses += 1;
69		}
70	102×	let value = Arc::new(make());
71	102×	let weight = value.weight();
72	102×	let mut g = self.inner.lock().unwrap_or_else(\|p\| p.into_inner());
73	102×	if weight > g.budget / 4 {
74	4×	return value; // too big to be worth keeping
75	98×	}
76	98×	g.tick += 1;
77	98×	let tick = g.tick;
78	98×	if let Some(old) = g.map.insert(key, (tick, value.clone(), weight)) {
79	0×	g.used -= old.2;
80	98×	}
81	98×	g.used += weight;
82	98×	while g.used > g.budget {
83	0×	let Some((&oldest, _)) = g.map.iter().min_by_key(\|(_, e)\| e.0) else { break };
84	0×	if let Some(e) = g.map.remove(&oldest) {
85	0×	g.used -= e.2;
86	0×	}
87		}
88	98×	value
89	345×	}
90
91		/// (hits, misses, bytes held).
92	4×	pub fn stats(&self) -> (u64, u64, usize) {
93	4×	let g = self.inner.lock().unwrap_or_else(\|p\| p.into_inner());
94	4×	(g.hits, g.misses, g.used)
95	4×	}
96		}
97
98		#[cfg(test)]
99		mod tests {
100		use super::*;
101
102		#[test]
103	1×	fn hits_misses_and_eviction() {
104	1×	let c: Lru<String> = Lru::new(400);
105	1×	let mut runs = 0;
106	1×	for _ in 0..3 {
107	3×	c.get_or(key(&[b"a"]), \|\| {
108	1×	runs += 1;
109	1×	"x".repeat(50)
110	1×	});
111		}
112	1×	assert_eq!(runs, 1, "rendered once");
113	1×	assert_eq!(c.stats().0, 2);
114		// Filling past the budget drops the least recently used.
115	1×	c.get_or(key(&[b"b"]), \|\| "y".repeat(90));
116	1×	c.get_or(key(&[b"a"]), \|\| unreachable!());
117	1×	c.get_or(key(&[b"c"]), \|\| "z".repeat(90));
118	1×	c.get_or(key(&[b"d"]), \|\| "w".repeat(90));
119	1×	assert!(c.stats().2 <= 400);
120	1×	let mut again = false;
121	1×	c.get_or(key(&[b"b"]), \|\| {
122	1×	again = true;
123	1×	String::new()
124	1×	});
125	1×	assert!(again, "b was the least recently used and went first");
126		// Something larger than a quarter of the budget is not kept.
127	1×	c.get_or(key(&[b"huge"]), \|\| "h".repeat(200));
128	1×	let mut rerun = false;
129	1×	c.get_or(key(&[b"huge"]), \|\| {
130	1×	rerun = true;
131	1×	String::new()
132	1×	});
133	1×	assert!(rerun);
134		// Parts are length-framed: ("ab","c") and ("a","bc") differ.
135	1×	assert_ne!(key(&[b"ab", b"c"]), key(&[b"a", b"bc"]));
136	1×	}
137		}

`/`	Search
`g` `c`	Code
`g` `h`	History
`g` `b`	Bookmarks
`g` `t`	Trust
`y`	Permalink to this state (files and trees)
`?`	This sheet

Coverage / crates/hub/src/render/cache.rs 89.2%

Keyboard