holt 0.7.3

An adaptive-radix-tree metadata storage engine for path-shaped keys, with per-blob concurrency and crash-safe persistence.
Documentation 
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

//! Copy-on-write frame snapshot.
//!
//! A [`Snapshot`] is a stable, point-in-time view of a tree (or a
//! prefix subtree). It copies only the root frame into memory up front
//! and shares all other frames with the live tree. Later writes *fork*
//! (copy-on-write) the individual frames a snapshot still references
//! instead of overwriting them in place, so the snapshot stays stable
//! with 1× read amplification and without MVCC version chains.
//!
//! Creation is O(one frame copy); the per-write cost is zero while no
//! snapshot is live, and bounded by the root→leaf frame path length on
//! the first write to each region while one is. Dropping the handle (or
//! calling [`Snapshot::retire`]) retires the snapshot and lowers the
//! global fork barrier.

use std::ops::Deref;
use std::sync::Arc;

use crate::store::BufferManager;

use super::view::View;

/// A stable copy-on-write snapshot of a tree or prefix subtree.
///
/// Created by [`crate::Tree::snapshot`]. Reads see the tree exactly as
/// it was at creation time regardless of concurrent or subsequent live
/// writes. All [`View`] read operations are available through `Deref`
/// (`snapshot.get(..)`, `snapshot.range()`, `snapshot.scan(..)`, …).
///
/// The snapshot is retired when the handle is dropped; hold it for as
/// long as the stable view is needed.
pub struct Snapshot {
    view: Option<View>,
    store: Arc<BufferManager>,
    epoch: u64,
    retired: bool,
}

impl Snapshot {
    pub(crate) fn new(view: View, store: Arc<BufferManager>, epoch: u64) -> Self {
        Self {
            view: Some(view),
            store,
            epoch,
            retired: false,
        }
    }

    /// This snapshot's epoch — its position on the global copy-on-write
    /// timeline. Frames with `created_epoch <= epoch` are the ones this
    /// snapshot may reference and that live writes must fork.
    #[must_use]
    pub fn epoch(&self) -> u64 {
        self.epoch
    }

    /// The underlying scoped read view.
    #[must_use]
    pub fn view(&self) -> &View {
        self.view.as_ref().expect("snapshot retired")
    }

    /// Retire the snapshot now, releasing its hold on the fork barrier.
    /// Equivalent to dropping the handle, but explicit. Idempotent.
    pub fn retire(mut self) {
        self.retire_inner();
    }

    fn retire_inner(&mut self) {
        if !self.retired {
            self.retired = true;
            drop(self.view.take());
            self.store.retire_snapshot(self.epoch);
        }
    }
}

impl Deref for Snapshot {
    type Target = View;

    fn deref(&self) -> &View {
        self.view()
    }
}

impl Drop for Snapshot {
    fn drop(&mut self) {
        self.retire_inner();
    }
}

impl std::fmt::Debug for Snapshot {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Snapshot")
            .field("epoch", &self.epoch)
            .field("scope", &self.view.as_ref().map(View::scope))
            .finish_non_exhaustive()
    }
}