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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
use std::collections::HashMap;
use std::hash::Hash;
use std::sync::{Arc, RwLock};
use chrono::Duration;
use crate::cache::{self, CacheEntry};
pub use crate::Cache;
const TREE_META: &[u8] = b":meta:";
const KEY_FORMAT: &[u8] = b"format";
const KEY_FORMAT_VERSION: &[u8] = b"version";
const VALUE_FORMAT: &[u8] = b"disk-cache";
const VALUE_FORMAT_VERSION: &[u8] = &[0, 1, 0];
pub struct CacheManager {
db: sled::Db,
}
impl CacheManager {
pub fn new(options: &CacheManagerOptions) -> Result<Self, sled::Error> {
let config = sled::Config::default()
.path(&options.path)
.mode(sled::Mode::HighThroughput)
.flush_every_ms(Some(10_000))
.use_compression(options.use_compression)
.temporary(options.use_temporary);
let db = match config.open() {
Ok(db) => db,
Err(sled::Error::Corruption { .. }) => {
warn!(target: "disk-cache", "Cache file corrupted, recreating");
let _ = std::fs::remove_dir_all(&options.path);
config.create_new(true).open()?
}
other => other?,
};
let meta_tree = db.open_tree(TREE_META)?;
let is_correct_format = meta_tree
.get(KEY_FORMAT)?
.map(|format| format == VALUE_FORMAT)
.unwrap_or(false);
let is_correct_version = meta_tree
.get(KEY_FORMAT_VERSION)?
.map(|version| version == VALUE_FORMAT_VERSION)
.unwrap_or(false);
debug!(target: "disk-cache", "is_correct_format: {}", is_correct_format);
debug!(target: "disk-cache", "is_correct_version: {}", is_correct_version);
if !is_correct_format || !is_correct_version {
for tree in db.tree_names() {
debug!(target: "disk-cache", "dropping tree: {:?}", tree);
db.drop_tree(tree).or_else(|e| match e {
sled::Error::Unsupported(_) =>
{
Ok(false)
}
other => Err(other),
})?;
}
}
let meta_tree = db.open_tree(":meta:")?;
meta_tree.insert(KEY_FORMAT, VALUE_FORMAT)?;
meta_tree.insert(KEY_FORMAT_VERSION, VALUE_FORMAT_VERSION)?;
Ok(CacheManager { db })
}
fn get_cache_name(name: &str) -> String {
format!("cache:{}", name)
}
fn get_meta_name(name: &str) -> String {
format!("meta:{}", name)
}
fn get_expiry_name(name: &str) -> String {
format!("expiry:{}", name)
}
pub fn purge(&self, name: &str) -> sled::Result<bool> {
let cache = self.db.drop_tree(Self::get_cache_name(name))?;
let meta = self.db.drop_tree(Self::get_meta_name(name))?;
Ok(cache || meta)
}
pub fn cache<K, V>(&self, name: &str, options: &CacheOptions) -> sled::Result<Cache<K, V>>
where
K: Send
+ Clone
+ Hash
+ Eq
+ for<'de> serde::Deserialize<'de>
+ serde::Serialize
+ Sync
+ 'static,
V: Send + Clone + for<'de> serde::Deserialize<'de> + serde::Serialize + Sync + 'static,
{
let content_key = Self::get_cache_name(name);
let meta_key = Self::get_meta_name(name);
let expiry_key = Self::get_expiry_name(name);
let version = [
(options.version & 0xFF) as u8,
((options.version >> 8) & 0xFF) as u8,
((options.version >> 16) & 0xFF) as u8,
((options.version >> 24) & 0xFF) as u8,
];
let format_changed = self.db.open_tree(&meta_key)?
.get(KEY_FORMAT_VERSION)?
.map(|k| {
debug!(target: "disk-cache", "Cache version: {:?}, expected {:?}", k.as_ref(), version);
k.as_ref() != version
})
.unwrap_or(true);
if format_changed || options.purge {
debug!(target: "disk-cache", "We need to cleanup this cache - format_changed:{} options.purge:{}", format_changed, options.purge);
self.db.drop_tree(&content_key)?;
self.db.drop_tree(&expiry_key)?;
}
self.db
.open_tree(meta_key)?
.insert(KEY_FORMAT_VERSION, &version)?;
let in_memory: Arc<RwLock<HashMap<K, CacheEntry<V>>>> =
Arc::new(RwLock::new(HashMap::new()));
let content = self.db.open_tree(content_key)?;
let expiry = self.db.open_tree(expiry_key)?;
{
let start = tokio::time::Instant::now()
+ tokio::time::Duration::from_secs(
options.initial_disk_cleanup_after.num_seconds() as u64,
);
let duration =
tokio::time::Duration::from_secs(options.memory_duration.num_seconds() as u64);
let in_memory = in_memory.clone();
let expiry = expiry.clone();
let content = content.clone();
tokio::spawn(async move {
let mut interval = tokio::time::interval_at(start, duration);
loop {
let _ = interval.tick().await;
cache::cleanup_disk_cache::<K, V>(&expiry, &content);
if Arc::strong_count(&in_memory) == 1 {
return;
}
cache::cleanup_memory_cache(&in_memory);
}
});
}
Ok(cache::Cache {
in_memory,
content,
expiry,
memory_duration: options.memory_duration,
disk_duration: options.disk_duration,
})
}
}
#[derive(TypedBuilder)]
pub struct CacheManagerOptions {
#[builder(setter(into))]
path: std::path::PathBuf,
#[builder(default = false)]
use_compression: bool,
#[builder(default = false)]
use_temporary: bool,
}
#[derive(TypedBuilder)]
pub struct CacheOptions {
#[builder(default=Duration::hours(1))]
memory_duration: Duration,
#[builder(default=Duration::days(1))]
disk_duration: Duration,
#[builder(default=Duration::seconds(10))]
initial_disk_cleanup_after: Duration,
#[builder(default = false)]
purge: bool,
#[builder(default = 0)]
version: u32,
}
impl Default for CacheOptions {
fn default() -> Self {
CacheOptions::builder().build()
}
}