cobble 0.1.0

A flexible embedded key-value storage engine for distributed systems as well as single-node applications.
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
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

//! Module for memtable implementations and management.
//! Static dispatch is used for method calls to avoid virtual call overhead.
mod hash;
mod iter;
mod manager;
mod skiplist;
mod vec;
mod vlog;

use crate::error::Result;
use crate::iterator::KvIterator;
use crate::r#type::{KvValue, RefKey, RefValue};
pub(crate) use hash::HashMemtable;
pub(crate) use skiplist::SkiplistMemtable;
use std::collections::BTreeMap;
use std::sync::Arc;
pub(crate) use vec::VecMemtable;

/// Type alias for memtable reclaimer function.
pub(crate) type MemtableReclaimer = Arc<dyn Fn(u64) + Send + Sync>;

#[allow(unused_imports)]
pub(crate) use manager::{
    ActiveMemtable, ImmutableMemtable, MemtableFlushResult, MemtableManager,
    MemtableManagerMetrics, MemtableManagerOptions,
};

/// Trait for memtable implementations.
pub(crate) trait Memtable {
    fn put(&mut self, key: &[u8], value: &[u8]) -> Result<()>;
    fn put_ref(&mut self, key: &RefKey<'_>, value: &RefValue<'_>, num_columns: usize)
    -> Result<()>;
    fn put_ref_rewritten(
        &mut self,
        key: &RefKey<'_>,
        plan: &vlog::RewrittenValuePlan<'_>,
        num_columns: usize,
    ) -> Result<()>;
    fn get(&self, key: &[u8]) -> Option<&[u8]>;
    fn get_all(&self, key: &[u8]) -> Self::ValueIter<'_>;
    fn remaining_capacity(&self) -> usize;
    fn is_empty(&self) -> bool;
    fn append_blob(&mut self, data: &[u8]) -> Result<usize>;
    fn read_blob(&self, offset: usize, len: usize) -> Option<&[u8]>;
    fn flush_blobs_to_vlog_writer(
        &self,
        entries: &BTreeMap<u32, (usize, usize)>,
        writer: &mut crate::vlog::VlogWriter<Box<dyn crate::file::SequentialWriteFile>>,
    ) -> Result<()>;
    fn write_vlog_data_since(
        &self,
        entries: &BTreeMap<u32, (usize, usize)>,
        offset: u32,
        writer: &mut dyn crate::file::SequentialWriteFile,
    ) -> Result<usize>;
    fn blob_cursor_checkpoint(&self) -> usize;
    fn rollback_blob_cursor(&mut self, checkpoint: usize);
    fn data_offset(&self) -> usize;
    fn write_data_since(
        &self,
        offset: usize,
        writer: &mut dyn crate::file::SequentialWriteFile,
    ) -> Result<usize>;

    fn iter(&self) -> Self::KvIter<'_>;

    type ValueIter<'a>: Iterator<Item = &'a [u8]>
    where
        Self: 'a;

    type KvIter<'a>: KvIterator<'a>
    where
        Self: 'a;
}

pub(crate) enum MemtableImpl {
    Hash(HashMemtable),
    Skiplist(SkiplistMemtable),
    Vec(VecMemtable),
}

pub(crate) enum MemtableValueIter<'a> {
    Hash(hash::MemtableValueIter<'a>),
    Skiplist(skiplist::MemtableValueIter<'a>),
    Vec(vec::MemtableValueIter<'a>),
}

impl<'a> Iterator for MemtableValueIter<'a> {
    type Item = &'a [u8];

    fn next(&mut self) -> Option<Self::Item> {
        match self {
            Self::Hash(iter) => iter.next(),
            Self::Skiplist(iter) => iter.next(),
            Self::Vec(iter) => iter.next(),
        }
    }
}

pub(crate) enum MemtableKvIter<'a> {
    Hash(hash::MemtableKvIterator<'a>),
    Skiplist(skiplist::MemtableKvIterator<'a>),
    Vec(vec::MemtableKvIterator<'a>),
}

impl<'a> KvIterator<'a> for MemtableKvIter<'a> {
    fn seek(&mut self, target: &[u8]) -> Result<()> {
        match self {
            Self::Hash(iter) => iter.seek(target),
            Self::Skiplist(iter) => iter.seek(target),
            Self::Vec(iter) => iter.seek(target),
        }
    }

    fn seek_to_first(&mut self) -> Result<()> {
        match self {
            Self::Hash(iter) => iter.seek_to_first(),
            Self::Skiplist(iter) => iter.seek_to_first(),
            Self::Vec(iter) => iter.seek_to_first(),
        }
    }

    fn next(&mut self) -> Result<bool> {
        match self {
            Self::Hash(iter) => iter.next(),
            Self::Skiplist(iter) => iter.next(),
            Self::Vec(iter) => iter.next(),
        }
    }

    fn valid(&self) -> bool {
        match self {
            Self::Hash(iter) => iter.valid(),
            Self::Skiplist(iter) => iter.valid(),
            Self::Vec(iter) => iter.valid(),
        }
    }

    fn key(&self) -> Result<Option<&[u8]>> {
        match self {
            Self::Hash(iter) => iter.key(),
            Self::Skiplist(iter) => iter.key(),
            Self::Vec(iter) => iter.key(),
        }
    }

    fn take_key(&mut self) -> Result<Option<bytes::Bytes>> {
        match self {
            Self::Hash(iter) => iter.take_key(),
            Self::Skiplist(iter) => iter.take_key(),
            Self::Vec(iter) => iter.take_key(),
        }
    }

    fn take_value(&mut self) -> Result<Option<KvValue>> {
        match self {
            Self::Hash(iter) => iter.take_value(),
            Self::Skiplist(iter) => iter.take_value(),
            Self::Vec(iter) => iter.take_value(),
        }
    }
}

impl Memtable for MemtableImpl {
    fn put(&mut self, key: &[u8], value: &[u8]) -> Result<()> {
        match self {
            Self::Hash(memtable) => memtable.put(key, value),
            Self::Skiplist(memtable) => memtable.put(key, value),
            Self::Vec(memtable) => memtable.put(key, value),
        }
    }

    fn put_ref(
        &mut self,
        key: &RefKey<'_>,
        value: &RefValue<'_>,
        num_columns: usize,
    ) -> Result<()> {
        match self {
            Self::Hash(memtable) => memtable.put_ref(key, value, num_columns),
            Self::Skiplist(memtable) => memtable.put_ref(key, value, num_columns),
            Self::Vec(memtable) => memtable.put_ref(key, value, num_columns),
        }
    }

    fn put_ref_rewritten(
        &mut self,
        key: &RefKey<'_>,
        plan: &vlog::RewrittenValuePlan<'_>,
        num_columns: usize,
    ) -> Result<()> {
        match self {
            Self::Hash(memtable) => memtable.put_ref_rewritten(key, plan, num_columns),
            Self::Skiplist(memtable) => memtable.put_ref_rewritten(key, plan, num_columns),
            Self::Vec(memtable) => memtable.put_ref_rewritten(key, plan, num_columns),
        }
    }

    fn get(&self, key: &[u8]) -> Option<&[u8]> {
        match self {
            Self::Hash(memtable) => memtable.get(key),
            Self::Skiplist(memtable) => memtable.get(key),
            Self::Vec(memtable) => memtable.get(key),
        }
    }

    fn get_all(&self, key: &[u8]) -> Self::ValueIter<'_> {
        match self {
            Self::Hash(memtable) => MemtableValueIter::Hash(memtable.get_all(key)),
            Self::Skiplist(memtable) => MemtableValueIter::Skiplist(memtable.get_all(key)),
            Self::Vec(memtable) => MemtableValueIter::Vec(memtable.get_all(key)),
        }
    }

    fn remaining_capacity(&self) -> usize {
        match self {
            Self::Hash(memtable) => memtable.remaining_capacity(),
            Self::Skiplist(memtable) => memtable.remaining_capacity(),
            Self::Vec(memtable) => memtable.remaining_capacity(),
        }
    }

    fn is_empty(&self) -> bool {
        match self {
            Self::Hash(memtable) => memtable.is_empty(),
            Self::Skiplist(memtable) => memtable.is_empty(),
            Self::Vec(memtable) => memtable.is_empty(),
        }
    }

    fn append_blob(&mut self, data: &[u8]) -> Result<usize> {
        match self {
            Self::Hash(memtable) => memtable.append_blob(data),
            Self::Skiplist(memtable) => memtable.append_blob(data),
            Self::Vec(memtable) => memtable.append_blob(data),
        }
    }

    fn read_blob(&self, offset: usize, len: usize) -> Option<&[u8]> {
        match self {
            Self::Hash(memtable) => memtable.read_blob(offset, len),
            Self::Skiplist(memtable) => memtable.read_blob(offset, len),
            Self::Vec(memtable) => memtable.read_blob(offset, len),
        }
    }

    fn flush_blobs_to_vlog_writer(
        &self,
        entries: &BTreeMap<u32, (usize, usize)>,
        writer: &mut crate::vlog::VlogWriter<Box<dyn crate::file::SequentialWriteFile>>,
    ) -> Result<()> {
        match self {
            Self::Hash(memtable) => memtable.flush_blobs_to_vlog_writer(entries, writer),
            Self::Skiplist(memtable) => memtable.flush_blobs_to_vlog_writer(entries, writer),
            Self::Vec(memtable) => memtable.flush_blobs_to_vlog_writer(entries, writer),
        }
    }

    fn write_vlog_data_since(
        &self,
        entries: &BTreeMap<u32, (usize, usize)>,
        offset: u32,
        writer: &mut dyn crate::file::SequentialWriteFile,
    ) -> Result<usize> {
        match self {
            Self::Hash(memtable) => memtable.write_vlog_data_since(entries, offset, writer),
            Self::Skiplist(memtable) => memtable.write_vlog_data_since(entries, offset, writer),
            Self::Vec(memtable) => memtable.write_vlog_data_since(entries, offset, writer),
        }
    }

    fn blob_cursor_checkpoint(&self) -> usize {
        match self {
            Self::Hash(memtable) => memtable.blob_cursor_checkpoint(),
            Self::Skiplist(memtable) => memtable.blob_cursor_checkpoint(),
            Self::Vec(memtable) => memtable.blob_cursor_checkpoint(),
        }
    }

    fn rollback_blob_cursor(&mut self, checkpoint: usize) {
        match self {
            Self::Hash(memtable) => memtable.rollback_blob_cursor(checkpoint),
            Self::Skiplist(memtable) => memtable.rollback_blob_cursor(checkpoint),
            Self::Vec(memtable) => memtable.rollback_blob_cursor(checkpoint),
        }
    }

    fn data_offset(&self) -> usize {
        match self {
            Self::Hash(memtable) => memtable.data_offset(),
            Self::Skiplist(memtable) => memtable.data_offset(),
            Self::Vec(memtable) => memtable.data_offset(),
        }
    }

    fn write_data_since(
        &self,
        offset: usize,
        writer: &mut dyn crate::file::SequentialWriteFile,
    ) -> Result<usize> {
        match self {
            Self::Hash(memtable) => memtable.write_data_since(offset, writer),
            Self::Skiplist(memtable) => memtable.write_data_since(offset, writer),
            Self::Vec(memtable) => memtable.write_data_since(offset, writer),
        }
    }

    fn iter(&self) -> Self::KvIter<'_> {
        match self {
            Self::Hash(memtable) => MemtableKvIter::Hash(memtable.iter()),
            Self::Skiplist(memtable) => MemtableKvIter::Skiplist(memtable.iter()),
            Self::Vec(memtable) => MemtableKvIter::Vec(memtable.iter()),
        }
    }

    type ValueIter<'a>
        = MemtableValueIter<'a>
    where
        Self: 'a;

    type KvIter<'a>
        = MemtableKvIter<'a>
    where
        Self: 'a;
}