radixdb-storage 1.1.0

Storage contracts and physical persistence engine for RadixDB
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113

use super::super::FormatResult;
use super::model::{invalid, limit, IndexArtifactLayout};

pub const MAX_INDEX_OPEN_METADATA_BYTES: u64 = 512 * 1024 * 1024;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct IndexOpenLimits {
    max_accounted_bytes: u64,
}

impl IndexOpenLimits {
    pub fn new(max_accounted_bytes: u64) -> FormatResult<Self> {
        if max_accounted_bytes == 0 || max_accounted_bytes > MAX_INDEX_OPEN_METADATA_BYTES {
            return Err(limit(
                "metadata-open accounted bytes",
                max_accounted_bytes,
                MAX_INDEX_OPEN_METADATA_BYTES,
            ));
        }
        Ok(Self {
            max_accounted_bytes,
        })
    }

    pub const fn max_accounted_bytes(self) -> u64 {
        self.max_accounted_bytes
    }
}

impl Default for IndexOpenLimits {
    fn default() -> Self {
        Self {
            max_accounted_bytes: MAX_INDEX_OPEN_METADATA_BYTES,
        }
    }
}

#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub struct IndexOpenMetrics {
    read_calls: u64,
    read_bytes: u64,
    accounted_allocation_bytes: u64,
}

impl IndexOpenMetrics {
    pub const fn read_calls(self) -> u64 {
        self.read_calls
    }

    pub const fn read_bytes(self) -> u64 {
        self.read_bytes
    }

    pub const fn accounted_allocation_bytes(self) -> u64 {
        self.accounted_allocation_bytes
    }

    pub(crate) fn record_read(&mut self, bytes: u64) -> FormatResult<()> {
        self.read_calls = self
            .read_calls
            .checked_add(1)
            .ok_or_else(|| invalid("metadata read-call counter overflows"))?;
        self.read_bytes = self
            .read_bytes
            .checked_add(bytes)
            .ok_or_else(|| invalid("metadata read-byte counter overflows"))?;
        Ok(())
    }

    pub(crate) fn account_allocation(
        &mut self,
        bytes: u64,
        limits: IndexOpenLimits,
    ) -> FormatResult<()> {
        let total = self
            .accounted_allocation_bytes
            .checked_add(bytes)
            .ok_or_else(|| invalid("metadata allocation accounting overflows"))?;
        if total > limits.max_accounted_bytes() {
            return Err(limit(
                "metadata-open accounted bytes",
                total,
                limits.max_accounted_bytes(),
            ));
        }
        self.accounted_allocation_bytes = total;
        Ok(())
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct OpenedIndexArtifact {
    layout: IndexArtifactLayout,
    metrics: IndexOpenMetrics,
}

impl OpenedIndexArtifact {
    pub(crate) const fn new(layout: IndexArtifactLayout, metrics: IndexOpenMetrics) -> Self {
        Self { layout, metrics }
    }

    pub const fn layout(&self) -> &IndexArtifactLayout {
        &self.layout
    }

    pub const fn metrics(&self) -> IndexOpenMetrics {
        self.metrics
    }

    pub fn into_layout(self) -> IndexArtifactLayout {
        self.layout
    }
}