mintkv 0.1.0

A simple kv library based on btree
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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
use core::panic;
use std::usize;

use crate::bytes;

use super::constant::{
    DEFAULT_MAX_THRESHOLD, DEFAULT_MIN_THRESHOLD, HEAD_INTERNAL_NODE_SIZE, HEAD_LEAF_NODE_SIZE,
};
use super::error::Error;

type Offset = u64;
type Key = Vec<u8>;
type Value = Vec<u8>;

#[derive(Default, Clone, Debug)]
pub struct KeyValue {
    pub key: Key,
    pub value: Value,
}

// KeyValue[#TODO] (should add some comments)
impl KeyValue {
    pub fn new(key: &[u8], value: &[u8]) -> Self {
        Self {
            key: key.into(),
            value: value.into(),
        }
    }
}

pub enum TypedNode {
    Internal(InternalNode),
    Leaf(LeafNode),
    Empty,
}

// LeafNode[#TODO] (shoule add some comments )
#[derive(Default)]
pub struct LeafNode {
    pub keyvalues: Vec<KeyValue>,
    pub prev_offset: Offset,
    pub next_offset: Offset,
}

#[derive(Default)]
pub struct InternalNode {
    pub keys: Vec<Key>,
    pub children: Vec<Offset>,
}

const NODEASLEAF: u8 = 0;
const NODEASINTERNAL: u8 = 1;

pub struct Node {
    pub offset: Offset, // cost 8B
    pub data: TypedNode,
    pub is_leaf: bool,
}

// Node[#TODO] (should add some comments)
impl Node {
    pub fn new_empty(offset: Offset) -> Self {
        Self {
            offset,
            data: TypedNode::Empty,
            is_leaf: true,
        }
    }
    pub fn new_leaf(offset: Offset) -> Self {
        Self {
            offset,
            data: TypedNode::Leaf(LeafNode::default()),
            is_leaf: true,
        }
    }
    pub fn new_internal(offset: Offset) -> Self {
        Self {
            offset,
            data: TypedNode::Internal(InternalNode::default()),
            is_leaf: false,
        }
    }

    pub fn leaf_data(&mut self) -> &mut LeafNode {
        if let TypedNode::Leaf(ref mut leaf_node) = self.data {
            leaf_node
        } else {
            panic!("Expected leaf node, But got internal node");
        }
    }

    pub fn internal_data(&mut self) -> &mut InternalNode {
        if let TypedNode::Internal(ref mut internal_node) = self.data {
            internal_node
        } else {
            panic!("Expected internal node, But got leaf node");
        }
    }

    pub fn display(&self) {
        match self.data {
            TypedNode::Internal(ref interla_node) => {
                println!(
                    "IN:{}, Keys: {:?}, Children: {:?}",
                    self.offset, interla_node.keys, interla_node.children
                );
            }
            TypedNode::Leaf(ref leaf_node) => {
                /* let mut keys = vec![];
                for kv in leaf_node.keyvalues.iter() {
                    keys.push(kv.key.to_string());
                }
                println!("LN:{}, Keys: {:?}", self.offset, keys); */
            }
            TypedNode::Empty => todo!(),
        }
    }
}

///  node format , value is offset if the node is internal node, else value is String
/// |-----------------------------------------------------------------------------------|
/// | node type | key number  |   .............. Data ....                              |
/// |  1B       |  2B         |   ........................                              |
/// |-----------------------------------------------------------------------------------|
/// |                          DATA                                                     |
/// | c0 | len(k0) |  k0 | len(v0)  | v0 |  c1 |  len(k1) | k2 | len(v2) | v2 | ........|
/// | 8B |  1B     | xx  |  1B      | xx |  8B |  1B      | x  |  1B     | xxx| ........|
/// |-----------------------------------------------------------------------------------|
///
impl Node {
    pub fn serialize(&self, buf: &mut [u8]) {
        match self.data {
            TypedNode::Internal(ref internal_node) => self.serialize_internal(internal_node, buf),
            TypedNode::Leaf(ref leaf_node) => self.serialize_leaf(leaf_node, buf),
            _ => {}
        };
    }

    fn serialize_internal(&self, internal_node: &InternalNode, buf: &mut [u8]) {
        let mut offset = 0;
        // write node type, which cost 1B
        buf[offset] = NODEASINTERNAL;
        offset += 1;

        // write numbers of keys, which cost 8B
        let key_num = internal_node.keys.len() as u64;
        buf[offset..offset + 8].clone_from_slice(u64::to_le_bytes(key_num).as_ref());
        offset += 8;

        // write keys into page
        for key in internal_node.keys.iter() {
            // write the length of keys into page , which cost 2B
            let key_size = key.len();
            buf[offset..offset + 2].clone_from_slice(u16::to_le_bytes(key_size as u16).as_ref());
            offset += 2;
            // write key into page, which cost key_size
            buf[offset..offset + key_size].clone_from_slice(key);
            offset += key_size;
        }

        // write number of child into page, which cost 8B
        let child_num = internal_node.children.len() as u64;
        buf[offset..offset + 8].clone_from_slice(u64::to_le_bytes(child_num).as_ref());
        offset += 8;

        // write children into page, which child cost 8B
        for &child in internal_node.children.iter() {
            buf[offset..offset + 8].clone_from_slice(u64::to_le_bytes(child).as_ref());
            offset += 8;
        }
    }

    fn serialize_leaf(&self, leaf_node: &LeafNode, buf: &mut [u8]) {
        let mut offset = 0;
        // write node type, which cost 1B
        buf[offset] = NODEASLEAF;
        offset += 1;

        // write prev_offset, which cost 8B
        buf[offset..offset + 8].clone_from_slice(u64::to_le_bytes(leaf_node.prev_offset).as_ref());
        offset += 8;

        // write next_offset, which cost 8B
        buf[offset..offset + 8].clone_from_slice(u64::to_le_bytes(leaf_node.next_offset).as_ref());
        offset += 8;

        // write numbers of keys, which cost 8B
        let key_num = leaf_node.keyvalues.len() as u64;
        buf[offset..offset + 8].clone_from_slice(u64::to_le_bytes(key_num).as_ref());
        offset += 8;

        // write key value into page
        for kv in leaf_node.keyvalues.iter() {
            // write key size into page,which cost 2B
            let key_size = kv.key.len();
            buf[offset..offset + 2].clone_from_slice(u16::to_le_bytes(key_size as u16).as_ref());
            offset += 2;

            // write key into page
            buf[offset..offset + key_size].clone_from_slice(kv.key.as_ref());
            offset += key_size;

            // write value size into page, which cost 2B
            let value_size = kv.value.len();
            buf[offset..offset + 2].clone_from_slice(u16::to_le_bytes(value_size as u16).as_ref());
            offset += 2;

            // write value bytes into page, which cost value_size * B
            buf[offset..offset + value_size].clone_from_slice(kv.value.as_ref());
            offset += value_size;
        }
    }

    pub fn deserialize(&mut self, buf: &[u8]) {
        // get node type at first Byte
        let ntype = buf[0];
        if ntype == NODEASLEAF {
            self.deserialize_leaf(buf);
        } else {
            self.deserialize_internal(buf);
        }
    }
    fn deserialize_internal(&mut self, buf: &[u8]) {
        let mut offset = 0;
        self.is_leaf = buf[offset] == NODEASLEAF;
        offset += 1;

        // get number of keys, which should read 8B from buffer
        let keys_num = u64::from_le_bytes(buf[offset..offset + 8].try_into().unwrap());
        offset += 8;
        // get keys from buffer,
        let mut keys = vec![];

        for _ in 0..keys_num {
            // get size of key, which should be read 2B
            let key_size = u16::from_le_bytes(buf[offset..offset + 2].try_into().unwrap()) as usize;
            offset += 2;

            // get key String from buffer, which should be read key_size * B
            let mut key_bytes = vec![0; key_size];
            key_bytes.clone_from_slice(buf[offset..offset + key_size].into());
            offset += key_size;

            keys.push(key_bytes);
        }
        // get children
        let mut children = vec![];
        let children_num = u64::from_le_bytes(buf[offset..offset + 8].try_into().unwrap());
        offset += 8;
        for _ in 0..children_num {
            let child = u64::from_le_bytes(buf[offset..offset + 8].try_into().unwrap());
            offset += 8;
            children.push(child);
        }

        self.data = TypedNode::Internal(InternalNode { keys, children });
    }

    fn deserialize_leaf(&mut self, buf: &[u8]) {
        let mut offset = 0;

        // read nodetype
        self.is_leaf = buf[offset] == NODEASLEAF;
        offset += 1;

        // get preoffset
        let prev_offset = u64::from_le_bytes(buf[offset..offset + 8].try_into().unwrap());
        offset += 8;

        //
        // get nextoffset
        let next_offset = u64::from_le_bytes(buf[offset..offset + 8].try_into().unwrap());
        offset += 8;

        let kv_num = u64::from_le_bytes(buf[offset..offset + 8].try_into().unwrap());
        offset += 8;

        let mut key_values = Vec::with_capacity(kv_num as usize);
        for _ in 0..kv_num {
            // get key size, which we should read 2B from buffer
            let key_size = u16::from_le_bytes(buf[offset..offset + 2].try_into().unwrap()) as usize;
            offset += 2;

            // get key bytes, which we should read key_size * B from buffer
            let mut key_bytes = vec![0; key_size];
            key_bytes.clone_from_slice(buf[offset..offset + key_size].try_into().unwrap());
            offset += key_size;

            // get value size, which we should read 2B from buffer
            let val_size = u16::from_le_bytes(buf[offset..offset + 2].try_into().unwrap()) as usize;
            offset += 2;

            // get value bytes, which we should read value_size * B from buffer
            let mut value_bytes = vec![0; val_size];
            value_bytes.clone_from_slice(buf[offset..offset + val_size].try_into().unwrap());
            offset += val_size;

            key_values.push(KeyValue {
                key: key_bytes,
                value: value_bytes,
            });
        }
        self.data = TypedNode::Leaf(LeafNode {
            keyvalues: key_values,
            prev_offset,
            next_offset,
        });
    }

    pub fn split(&mut self, new_offset: Offset) -> Result<(Key, Node), Error> {
        let split_index = self.get_split_index();
        if split_index == -1 {
            return Err(Error::Generic);
        }
        let splited_index = split_index as usize;
        match self.data {
            TypedNode::Internal(ref mut internal_node) => {
                let middle_item = internal_node.keys[splited_index].clone();
                let mut new_node = Node::new_internal(new_offset);
                new_node
                    .internal_data()
                    .keys
                    .extend_from_slice(internal_node.keys[splited_index + 1..].as_ref());
                internal_node.keys.drain(splited_index..);
                new_node
                    .internal_data()
                    .children
                    .extend_from_slice(internal_node.children[splited_index + 1..].as_ref());
                internal_node.children.drain(splited_index + 1..);

                Ok((middle_item, new_node))
            }
            TypedNode::Leaf(ref mut leaf_node) => {
                if leaf_node.keyvalues.len() < 2 {
                    return Err(Error::Generic);
                }
                let splited_index = 1;
                let middle_item = leaf_node.keyvalues[splited_index].clone();
                let mut new_node = Node::new_leaf(new_offset);
                new_node
                    .leaf_data()
                    .keyvalues
                    .extend_from_slice(&leaf_node.keyvalues[splited_index..]);
                leaf_node.keyvalues.drain(splited_index..);
                leaf_node.next_offset = new_node.offset;
                new_node.leaf_data().prev_offset = self.offset;
                Ok((middle_item.key, new_node))
            }
            TypedNode::Empty => Err(Error::Generic),
        }
    }

    pub fn can_spare_element(&self) -> bool {
        match self.data {
            TypedNode::Internal(ref internal_node) => internal_node.keys.len() > 1,
            TypedNode::Leaf(ref leaf_node) => leaf_node.keyvalues.len() > 1,
            TypedNode::Empty => todo!(),
        }
    }

    pub fn find_key_in_leaf(&self, key: &[u8]) -> (bool, usize) {
        if let TypedNode::Leaf(ref leaf_node) = self.data {
            for (idx, elem) in leaf_node.keyvalues.iter().enumerate() {
                match bytes::compare(&elem.key, key) {
                    std::cmp::Ordering::Equal => {
                        return (true, idx);
                    }
                    std::cmp::Ordering::Greater => {
                        return (false, idx);
                    }
                    std::cmp::Ordering::Less => {}
                }
            }
            (false, leaf_node.keyvalues.len())
        } else {
            panic!("this is not leaf node");
        }
    }

    pub fn find_key_in_internal(&self, key: &[u8]) -> (usize, Offset) {
        if let TypedNode::Internal(ref internal_node) = self.data {
            for (idx, elem) in internal_node.keys.iter().enumerate() {
                /* match elem.as_str().cmp(key) { */
                match bytes::compare(&elem, key) {
                    std::cmp::Ordering::Equal => {
                        return (idx + 1, internal_node.children[idx + 1]);
                    }
                    std::cmp::Ordering::Greater => {
                        return (idx, internal_node.children[idx]);
                    }
                    std::cmp::Ordering::Less => {}
                }
            }
            (
                internal_node.keys.len(),
                *internal_node.children.last().unwrap(),
            )
        } else {
            panic!("this is not internal node");
        }
    }

    fn get_split_index(&self) -> i32 {
        match self.data {
            TypedNode::Internal(ref internal_node) => {
                let mut threshold_value = HEAD_INTERNAL_NODE_SIZE;
                for idx in 0..internal_node.keys.len() {
                    threshold_value += internal_node.keys[idx].len() + 2 + 8;
                    if threshold_value > DEFAULT_MIN_THRESHOLD as usize {
                        return idx as i32;
                    }
                }
                -1
            }
            TypedNode::Leaf(ref leaf_node) => {
                // 8B for the last child
                let mut threshold_value = HEAD_LEAF_NODE_SIZE + 8;
                for (idx, kv) in leaf_node.keyvalues.iter().enumerate() {
                    threshold_value += kv.key.len() + kv.value.len() + 4;
                    if threshold_value > DEFAULT_MIN_THRESHOLD as usize {
                        return idx as i32;
                    }
                }
                -1
            }
            TypedNode::Empty => -1,
        }
    }

    pub fn is_underflow(&self) -> bool {
        match self.data {
            TypedNode::Internal(ref internal_node) => {
                let mut threshold_value = HEAD_INTERNAL_NODE_SIZE;
                for idx in 0..internal_node.keys.len() {
                    threshold_value += internal_node.keys[idx].len() + 2 + 8;
                }
                threshold_value < DEFAULT_MIN_THRESHOLD as usize
            }
            TypedNode::Leaf(ref leaf_node) => {
                let mut threshold_value = HEAD_LEAF_NODE_SIZE + 8;
                for kv in leaf_node.keyvalues.iter() {
                    threshold_value += kv.key.len() + kv.value.len() + 4;
                }
                threshold_value < DEFAULT_MIN_THRESHOLD as usize
            }
            TypedNode::Empty => todo!(),
        }
        /* self.leaf_items.len() < max_kvs().div(2) */
    }

    pub fn is_overflow(&self) -> bool {
        match self.data {
            TypedNode::Internal(ref internal_node) => {
                let mut threshold_value = HEAD_INTERNAL_NODE_SIZE;
                for idx in 0..internal_node.keys.len() {
                    /* if idx > DEFAULT_MAX_LEAF_ITEMS_NUM as usize {
                        return true;
                    } */
                    threshold_value += internal_node.keys[idx].len() + 2 + 8;
                }
                (threshold_value as f64) > DEFAULT_MAX_THRESHOLD
            }
            TypedNode::Leaf(ref leaf_node) => {
                let mut threshold_value = HEAD_INTERNAL_NODE_SIZE + 8;
                for kv in leaf_node.keyvalues.iter() {
                    /* if idx > DEFAULT_MAX_LEAF_ITEMS_NUM as usize{
                        return true;
                    } */
                    threshold_value += kv.key.len() + kv.value.len() + 4;
                }
                (threshold_value as f64) > DEFAULT_MAX_THRESHOLD
            }
            TypedNode::Empty => todo!(),
        }
    }
}