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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
use std::{collections::HashSet, fmt, mem, path::Path, sync::Arc};
use crate::{env::Env, util::shutdown::ShutdownNotifier};
mod error;
pub(crate) use error::{Error, Result};
mod page_txn;
use futures::lock::Mutex;
pub(crate) use page_txn::Guard;
mod page_table;
use page_table::PageTable;
pub(crate) use page_table::{MIN_ID, NAN_ID};
mod meta;
pub(crate) use meta::{NewFile, StreamEdit, VersionEdit};
mod version;
use version::{DeltaVersion, Version, VersionOwner, VersionUpdateReason};
mod jobs;
pub(crate) use jobs::RewritePage;
use jobs::{cleanup::CleanupCtx, flush::FlushCtx, reclaim::ReclaimCtx};
mod write_buffer;
pub(crate) use write_buffer::{RecordRef, WriteBuffer};
mod buffer_set;
mod manifest;
pub(crate) use manifest::Manifest;
mod page_file;
pub(crate) use page_file::{ChecksumType, Compression, FileInfo, MapFileInfo, PageFiles};
mod recover;
mod strategy;
pub(crate) use strategy::{MinDeclineRateStrategyBuilder, StrategyBuilder};
mod cache;
pub(crate) use cache::{clock::ClockCache, Cache, CacheEntry};
mod stats;
pub use stats::StoreStats;
use self::stats::{AtomicJobStats, AtomicWritebufStats};
#[non_exhaustive]
#[derive(Clone, Debug)]
pub struct Options {
pub write_buffer_capacity: u32,
pub max_write_buffers: usize,
pub use_direct_io: bool,
pub max_space_amplification_percent: usize,
pub space_used_high: u64,
pub file_base_size: usize,
pub cache_capacity: usize,
pub cache_estimated_entry_charge: usize,
pub cache_file_reader_capacity: u64,
pub prepopulate_cache_on_flush: bool,
pub separate_hot_cold_files: bool,
pub compression_on_flush: Compression,
pub compression_on_cold_compact: Compression,
pub page_checksum_type: ChecksumType,
}
impl Default for Options {
fn default() -> Self {
Self {
write_buffer_capacity: 128 << 20,
max_write_buffers: 8,
use_direct_io: false,
max_space_amplification_percent: 100,
space_used_high: u64::MAX,
file_base_size: 64 << 20,
cache_capacity: 8 << 20,
cache_estimated_entry_charge: 8 << 10,
cache_file_reader_capacity: 5000,
prepopulate_cache_on_flush: false,
separate_hot_cold_files: true,
compression_on_flush: Compression::SNAPPY,
compression_on_cold_compact: Compression::ZSTD,
page_checksum_type: ChecksumType::NONE,
}
}
}
pub(crate) struct PageStore<E: Env> {
options: Options,
#[allow(unused)]
env: E,
table: PageTable,
version_owner: Arc<VersionOwner>,
page_files: Arc<PageFiles<E>>,
manifest: Arc<Mutex<Manifest<E>>>,
job_stats: Arc<AtomicJobStats>,
writebuf_stats: Arc<AtomicWritebufStats>,
jobs: Vec<E::JoinHandle<()>>,
shutdown: ShutdownNotifier,
}
impl<E: Env> PageStore<E> {
pub(crate) async fn open<P, R>(env: E, path: P, options: Options, rewriter: R) -> Result<Self>
where
P: AsRef<Path>,
R: RewritePage<E>,
{
let (
next_page_file_id,
next_map_file_id,
manifest,
table,
page_files,
delta,
orphan_page_files,
) = Self::recover(env.to_owned(), path, &options).await?;
let version = Version::new(
options.write_buffer_capacity,
next_page_file_id,
options.max_write_buffers,
delta,
);
let version_owner = Arc::new(VersionOwner::new(version));
let manifest = Arc::new(futures::lock::Mutex::new(manifest));
let page_files = Arc::new(page_files);
let shutdown = ShutdownNotifier::new();
let job_stats = Arc::default();
let writebuf_stats = Arc::default();
let mut store = PageStore {
options,
env,
table,
version_owner,
page_files,
manifest,
job_stats,
writebuf_stats,
jobs: Vec::new(),
shutdown,
};
store.spawn_flush_job();
store.spawn_cleanup_job();
store.spawn_reclaim_job(next_map_file_id, rewriter, orphan_page_files);
Ok(store)
}
#[inline]
pub(crate) fn guard(&self) -> Guard<E> {
Guard::new(
self.version(),
self.table.clone(),
self.page_files.clone(),
self.writebuf_stats.clone(),
)
}
pub(crate) fn stats(&self) -> StoreStats {
let (page_cache, file_reader_cache) = self.page_files.stats();
let writebuf = self.writebuf_stats.snapshot();
let jobs = self.job_stats.snapshot();
StoreStats {
page_cache,
file_reader_cache,
writebuf,
jobs,
}
}
pub(crate) async fn close(mut self) {
self.shutdown.terminate();
let jobs = mem::take(&mut self.jobs);
for job in jobs {
job.await;
}
}
#[inline]
fn version(&self) -> Arc<Version> {
self.version_owner.current()
}
fn spawn_flush_job(&mut self) {
let job = FlushCtx::new(
self.options.clone(),
self.shutdown.subscribe(),
self.job_stats.clone(),
self.version_owner.clone(),
self.page_files.clone(),
self.manifest.clone(),
);
let handle = self.env.spawn_background(job.run());
self.jobs.push(handle);
}
fn spawn_cleanup_job(&mut self) {
let job = CleanupCtx::new(self.shutdown.subscribe(), self.page_files.clone());
let handle = self.env.spawn_background(job.run(self.version()));
self.jobs.push(handle);
}
fn spawn_reclaim_job<R>(
&mut self,
next_map_file_id: u32,
rewriter: R,
orphan_page_files: HashSet<u32>,
) where
R: RewritePage<E>,
{
let strategy_builder = Box::new(MinDeclineRateStrategyBuilder);
let job = ReclaimCtx::new(
self.options.clone(),
self.shutdown.subscribe(),
rewriter,
strategy_builder,
self.table.clone(),
self.page_files.clone(),
self.version_owner.clone(),
self.manifest.clone(),
next_map_file_id,
orphan_page_files,
self.job_stats.clone(),
self.writebuf_stats.clone(),
);
let handle = self.env.spawn_background(job.run(self.version()));
self.jobs.push(handle);
}
}
impl<E: Env> Drop for PageStore<E> {
fn drop(&mut self) {
self.shutdown.terminate();
}
}
impl<E: Env> fmt::Debug for PageStore<E> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("PageStore").finish()
}
}