mace-kv 0.0.34

A fast, cross-platform embedded key-value storage engine with ACID, MVCC, and flash-optimized storage
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
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

use std::alloc::{Layout, alloc, dealloc, realloc};

use super::align_up;

pub(crate) struct Block {
    data: *mut u8,
    refs: *mut u32,
    len: usize,
    align: usize,
}

impl Block {
    fn get_ref(x: *mut u32) -> &'static mut u32 {
        unsafe { &mut *x.cast::<u32>() }
    }

    fn alloc_impl(len: usize, align: usize, layout: Layout) -> Self {
        let data = unsafe { alloc(layout) };
        let refs = unsafe { alloc(Layout::new::<u32>()).cast::<u32>() };
        *Self::get_ref(refs) = 1;
        Self {
            data,
            refs,
            len,
            align,
        }
    }

    pub(crate) fn alloc(size: usize) -> Self {
        let layout = Layout::array::<u8>(size).expect("bad layout");
        Self::alloc_impl(size, 0, layout)
    }

    #[allow(unused)]
    pub(crate) fn aligned_alloc(size: usize, align: usize) -> Self {
        let len = align_up(size, align);
        let layout = Layout::from_size_align(len, align).expect("bad layout");
        Self::alloc_impl(size, align, layout)
    }

    pub(crate) fn zero(&self) {
        let len = if self.align == 0 {
            self.len
        } else {
            self.aligned_len()
        };
        unsafe {
            self.data.write_bytes(0, len);
        }
    }

    pub(crate) fn data(&self) -> *mut u8 {
        self.data
    }

    pub(crate) fn len(&self) -> usize {
        self.len
    }

    pub(crate) fn aligned_len(&self) -> usize {
        align_up(self.len, self.align)
    }

    pub(crate) fn mut_slice<'a, T>(&self, off: usize, count: usize) -> &'a mut [T] {
        debug_assert!(off + count * size_of::<T>() <= self.len);

        unsafe { std::slice::from_raw_parts_mut(self.data.add(off).cast::<T>(), count) }
    }

    pub(crate) fn slice<'a, T>(&self, off: usize, count: usize) -> &'a [T] {
        debug_assert!(off + count * size_of::<T>() <= self.len);

        unsafe { std::slice::from_raw_parts(self.data.add(off).cast::<T>(), count) }
    }

    pub(crate) fn realloc(&mut self, size: usize) {
        assert_eq!(self.align, 0);
        self.data = unsafe {
            let layout = Layout::array::<u8>(self.len).unwrap();
            realloc(self.data, layout, size)
        };
        self.len = size;
    }
}

impl Clone for Block {
    fn clone(&self) -> Self {
        *Self::get_ref(self.refs) += 1;
        Self {
            data: self.data,
            refs: self.refs,
            len: self.len,
            align: self.align,
        }
    }
}

impl Drop for Block {
    fn drop(&mut self) {
        *Self::get_ref(self.refs) -= 1;
        if *Self::get_ref(self.refs) == 0 {
            if self.align == 0 {
                unsafe { dealloc(self.data, Layout::array::<u8>(self.len).unwrap()) };
            } else {
                let align = self.align;
                unsafe {
                    dealloc(
                        self.data,
                        Layout::from_size_align(self.aligned_len(), align).expect("bad layout"),
                    );
                }
            }

            unsafe {
                dealloc(self.refs.cast::<u8>(), Layout::new::<u32>());
            }
        }
    }
}

pub(crate) struct Ring {
    data: Block,
    head: usize,
    tail: usize,
}

impl Ring {
    pub(crate) fn new(cap: usize) -> Self {
        let data = Block::alloc(cap);
        data.zero();
        assert!(data.len().is_power_of_two());
        Self {
            data,
            head: 0,
            tail: 0,
        }
    }

    pub(crate) fn avail(&self) -> usize {
        self.data.len() - self.distance()
    }

    // NOTE: the request buffer never wraps around
    pub(crate) fn prod<'a>(&mut self, size: usize) -> &'a mut [u8] {
        debug_assert!(self.avail() >= size);
        let mut b = self.tail;
        self.tail = self.tail.wrapping_add(size);

        b &= self.mask();
        self.data.mut_slice(b, size)
    }

    pub(crate) fn cons(&mut self, pos: usize) {
        self.head = self.head.wrapping_add(pos);
    }

    pub(crate) fn distance(&self) -> usize {
        self.tail.wrapping_sub(self.head)
    }

    pub(crate) fn head(&self) -> usize {
        self.head & self.mask()
    }

    pub(crate) fn tail(&self) -> usize {
        self.tail & self.mask()
    }

    pub(crate) fn slice(&self, pos: usize, len: usize) -> &[u8] {
        self.data.slice(pos, len)
    }

    pub(crate) fn mask(&self) -> usize {
        self.data.len() - 1
    }

    pub(crate) fn len(&self) -> usize {
        self.data.len()
    }
}