nikidb 0.1.1

an embedded k-v storage written in rust, similar to boltdb
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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
use crate::bucket::{Bucket, IBucket, MAX_FILL_PERCENT, MIN_FILL_PERCENT};
use crate::db::DBImpl;
use crate::error::NKResult;
use crate::page::{
    BranchPageElementSize, BranchPageFlag, BucketLeafFlag, LeafPageElementSize, LeafPageFlag, Page,
    Pgid, MIN_KEY_PERPAGE,
};
use crate::tx::TxImpl;
use std::cell::{Ref, RefCell, RefMut};
use std::rc::Rc;
use std::rc::Weak;
use std::str;
use std::sync::Arc;
use std::vec;

#[derive(Clone)]
pub(crate) struct Node(pub(crate) Rc<RefCell<NodeImpl>>);

#[derive(Clone)]
pub(crate) struct NodeImpl {
    pub(crate) is_leaf: bool,
    pub(crate) inodes: Vec<INode>,
    pub(crate) parent: Option<Weak<RefCell<NodeImpl>>>,
    unbalanced: bool,
    spilled: bool,
    pub(crate) pgid: Pgid,
    pub(crate) children: Vec<Node>,
    key: Option<Vec<u8>>,
}

impl NodeImpl {
    pub(crate) fn new() -> NodeImpl {
        Self {
            is_leaf: false,
            inodes: Vec::new(),
            parent: None,
            unbalanced: false,
            spilled: false,
            pgid: 0,
            children: Vec::new(),
            key: None,
        }
    }

    pub fn leaf(mut self, is_leaf: bool) -> NodeImpl {
        self.is_leaf = is_leaf;
        self
    }

    pub fn parent(mut self, parent: Weak<RefCell<NodeImpl>>) -> NodeImpl {
        self.parent = Some(parent);
        self
    }

    pub(crate) fn build(self) -> Node {
        Node(Rc::new(RefCell::new(self)))
    }
}

impl Node {
    #[inline]
    pub(crate) fn node_mut(&self) -> RefMut<'_, NodeImpl> {
        (*(self.0)).borrow_mut()
    }
    #[inline]
    pub(crate) fn node(&self) -> Ref<'_, NodeImpl> {
        self.0.borrow()
    }

    pub(crate) fn child_at(
        &mut self,
        bucket: &mut Bucket,
        index: usize,
        parent: Option<Weak<RefCell<NodeImpl>>>,
    ) -> Node {
        if self.node().is_leaf {
            panic!("invalid childAt{} on a leaf node", index);
        }
        let pgid = self.node().inodes[index].pgid;
        bucket.node(pgid, parent)
    }

    fn min_keys(&self) -> usize {
        if self.node().is_leaf {
            1
        } else {
            2
        }
    }

    pub(crate) fn size(&self) -> usize {
        let mut sz = Page::header_size();
        let elsz = self.page_element_size();
        let a = self.node();
        for i in 0..a.inodes.len() {
            let item = a.inodes.get(i).unwrap();
            sz += elsz + item.key.len() + item.value.len();
        }
        sz
    }

    fn page_element_size(&self) -> usize {
        if self.node().is_leaf {
            return LeafPageElementSize;
        }
        BranchPageElementSize
    }

    pub(crate) fn print(&self, db: &DBImpl) {
        println!("node pgid:{}", self.node().pgid);
        for n in self.node().inodes.iter() {
            print!(
                "flags:{},key:{:?},value:{:?},pgid:{} || ",
                n.flags,
                str::from_utf8(n.key.as_slice()).unwrap(),
                n.value,
                n.pgid
            );
            println!("");
            if n.flags & BucketLeafFlag as u32 != 0 {
                let ibucket = crate::u8_to_struct::<IBucket>(n.value.as_slice());
                let p = unsafe { &*db.page(ibucket.root) };
                let mut node = NodeImpl::new().build();
                node.read(p);
                node.print(db);
            }
            if n.pgid != 0 {
                let p = unsafe { &*db.page(n.pgid) };
                let mut node = NodeImpl::new().build();
                node.read(p);
                node.print(db);
            }
        }
        println!("");
    }

    pub(crate) fn read(&mut self, p: &Page) {
        let mut node_mut = self.node_mut();
        node_mut.pgid = p.id;
        node_mut.is_leaf = (p.flags & LeafPageFlag) != 0;
        let count = p.count as usize;
        node_mut.inodes = Vec::with_capacity(count);
        for i in 0..count {
            let mut inode = INode::new();
            if node_mut.is_leaf {
                let elem = p.leaf_page_element(i);
                inode.flags = elem.flags;
                inode.key = elem.key().to_vec();
                inode.value = elem.value().to_vec();
            } else {
                let elem = p.branch_page_element(i);
                inode.pgid = elem.pgid;
                inode.key = elem.key().to_vec();
            }
            assert!(inode.key.len() > 0, "read: zero-length inode key");
            node_mut.inodes.push(inode);
        }

        if node_mut.inodes.len() > 0 {
            let key = { node_mut.inodes.first().unwrap().key.clone() };
            node_mut.key = Some(key);
        } else {
            node_mut.key = None
        }
    }

    pub(crate) fn del(&mut self, key: &[u8]) {
        let (exact, index) = {
            match self
                .node()
                .inodes
                .binary_search_by(|inode| inode.key.as_slice().cmp(key))
            {
                Ok(v) => (true, v),
                Err(e) => (false, e),
            }
        };
        if !exact {
            return;
        }
        self.node_mut().inodes.remove(index);
        self.node_mut().unbalanced = true;
    }

    pub(crate) fn put(&self, old_key: &[u8], new_key: &[u8], value: &[u8], pgid: Pgid, flags: u32) {
        // if pgid > bucket.tx().unwrap().meta.borrow().pgid {
        //     panic!(
        //         "pgid {} above high water mark {}",
        //         pgid,
        //         bucket.tx().unwrap().meta.borrow().pgid,
        //     )
        // } else
        if old_key.len() <= 0 {
            panic!("put: zero-length old key")
        } else if new_key.len() <= 0 {
            panic!("put: zero-length new key")
        }
        let (exact, index) = {
            match self
                .node()
                .inodes
                .binary_search_by(|inode| inode.key.as_slice().cmp(old_key))
            {
                Ok(v) => (true, v),
                Err(e) => (false, e),
            }
        };
        {
            let mut n1 = self.node_mut();
            if !exact {
                n1.inodes.insert(index, INode::new());
            }
            let inode = n1.inodes.get_mut(index).unwrap();
            inode.flags = flags;
            inode.key = new_key.to_vec();
            inode.value = value.to_vec();
            inode.pgid = pgid;
            assert!(inode.key.len() > 0, "put: zero-length inode key")
        }
    }

    pub(crate) fn write(&self, p: &mut Page) {
        if self.node().is_leaf {
            p.flags = LeafPageFlag;
        } else {
            p.flags = BranchPageFlag;
        }
        if self.node().inodes.len() > 0xFFF {
            panic!(
                "inode overflow: {} (pgid={})",
                self.node().inodes.len(),
                p.id
            );
        }
        p.count = self.node().inodes.len() as u16;
        if p.count == 0 {
            return;
        }

        let mut buf_ptr = unsafe {
            p.data_ptr_mut()
                .add(self.page_element_size() * self.node().inodes.len())
        };

        for (i, item) in self.node().inodes.iter().enumerate() {
            assert!(item.key.len() > 0, "write: zero-length inode key");
            if self.node().is_leaf {
                let elem = p.leaf_page_element_mut(i);
                elem.pos = unsafe { buf_ptr.sub(elem.as_ptr() as usize) } as u32;
                elem.flags = item.flags as u32;
                elem.ksize = item.key.len() as u32;
                elem.vsize = item.value.len() as u32;
            } else {
                let elem = p.branch_page_element_mut(i);
                elem.pos = unsafe { buf_ptr.sub(elem.as_ptr() as usize) } as u32;
                elem.ksize = item.key.len() as u32;
                elem.pgid = item.pgid;
                assert!(elem.pgid != p.id, "write: circular dependency occurred");
            }
            let (klen, vlen) = (item.key.len(), item.value.len());
            unsafe {
                std::ptr::copy_nonoverlapping(item.key.as_ptr(), buf_ptr, klen);
                buf_ptr = buf_ptr.add(klen);
                std::ptr::copy_nonoverlapping(item.value.as_ptr(), buf_ptr, vlen);
                buf_ptr = buf_ptr.add(vlen);
            }
        }
    }

    pub(crate) fn root(&self, node: Node) -> Node {
        if let Some(parent_node) = &self.node().parent {
            let p = parent_node.upgrade().map(Node).unwrap();
            p.root(p.clone())
        } else {
            node
        }
    }

    fn child_index(&self, key: &[u8]) -> usize {
        match self
            .node()
            .inodes
            .binary_search_by(|inode| inode.key.as_slice().cmp(key))
        {
            Ok(v) => v,
            Err(e) => e,
        }
    }

    fn parent(&self) -> Option<Node> {
        match &self.node().parent {
            None => None,
            Some(p) => p.upgrade().map(Node),
        }
    }

    fn next_sibling(&self, bucket: &mut Bucket) -> Option<Node> {
        match self.parent() {
            None => None,
            Some(mut p) => {
                let index = p.child_index(self.node().key.as_ref().unwrap());
                if index as isize > self.num_children() as isize - 1 {
                    return None;
                }
                Some(p.child_at(bucket, index + 1, Some(Rc::downgrade(&p.0))))
            }
        }
    }

    fn prev_sibling(&mut self, bucket: &mut Bucket) -> Option<Node> {
        match self.parent() {
            None => None,
            Some(mut p) => {
                let index = p.child_index(self.node().key.as_ref().unwrap());
                if index == 0 {
                    return None;
                }
                Some(p.child_at(bucket, index - 1, Some(Rc::downgrade(&p.0))))
            }
        }
    }

    pub(crate) fn free(&mut self, bucket: &Bucket) {
        if self.node().pgid != 0 {
            let tx = bucket.tx().unwrap();
            let db = tx.db();
            db.freelist
                .try_write()
                .unwrap()
                .free(bucket.tx().unwrap().meta.borrow().txid, unsafe {
                    &*db.page(self.node().pgid)
                });
            self.node_mut().pgid = 0;
        }
    }

    fn num_children(&self) -> usize {
        self.node().inodes.len()
    }

    fn remove_child(&mut self, target: Node) {
        let index = self
            .node()
            .children
            .iter()
            .position(|c| Rc::ptr_eq(&target.0, &c.0));
        if let Some(i) = index {
            self.node_mut().children.remove(i);
        }
    }

    //删除元素 重平衡
    pub(crate) fn rebalance(&mut self, page_size: usize, b: *const Bucket) -> NKResult<()> {
        let bucket = unsafe { &mut *(b as *mut Bucket) };
        if !self.node_mut().unbalanced {
            return Ok(());
        }
        self.node_mut().unbalanced = false;
        let threshold = page_size / 4;
        if self.size() > threshold && self.node().inodes.len() > self.min_keys() {
            return Ok(());
        }
        //当前节点是根节点,特殊处理
        if self.parent().is_none() {
            //当前节点是branch节点并且只有一个一个inode, 分裂当前节点
            if !self.node().is_leaf && self.node().inodes.len() == 1 {
                // 将root节点的叶子节点上移
                // 创建一个新的子节点,以当前节点作为root节点
                let pgid = self.node().inodes[0].pgid;
                let mut child = bucket.node(pgid, Some(Rc::downgrade(&self.0)));

                let mut node_mut = self.node_mut();
                node_mut.is_leaf = child.node().is_leaf;
                node_mut.inodes = child.node_mut().inodes.drain(..).collect();
                node_mut.children = child.node_mut().children.drain(..).collect();
                //删除老得叶子节点
                child.node_mut().parent = None;
                bucket.nodes.borrow_mut().remove(&child.node().pgid);
                child.free(bucket);
            }
            return Ok(());
        }
        let mut p = self.parent().unwrap();
        //如果当前的节点没有存储key ,移除当前的节点
        if self.num_children() == 0 {
            //如果当前的节点没有叶子节点,并行size<threshold
            //移除当前这个节点
            if let Some(k) = &self.node().key {
                p.del(k);
            }
            p.remove_child(self.clone());
            let pgid = self.node().pgid;
            bucket.nodes.borrow_mut().remove(&pgid);
            self.free(bucket); //释放当前节点对应的page
            p.rebalance(page_size, bucket)?;
            return Ok(());
        }
        //下面的情况是当前节点有数据
        let use_next_sibing = p.child_index(self.node().key.as_ref().unwrap()) == 0; //找到需要rebalance的节点的位置
        let mut target = if use_next_sibing {
            //当前节点是最左边的节点
            self.next_sibling(bucket).unwrap()
        } else {
            //左边的兄弟节点
            self.prev_sibling(bucket).unwrap()
        };
        // 如果当前节点和target节点都太小了,则合并他们
        if use_next_sibing {
            for inode in target.node().inodes.iter() {
                //如果目标节点是当前节点的右边的兄弟节点,则将target节点合并到当前节点,
                if let Some(child) = bucket.nodes.borrow_mut().get_mut(&inode.pgid) {
                    child.parent().unwrap().remove_child(child.clone());
                    child.node_mut().parent = Some(Rc::downgrade(&self.0)); //重新计算其父节点为当前节点
                                                                            //将child加入当前node的子节点中
                    child
                        .parent()
                        .unwrap()
                        .node_mut()
                        .children
                        .push(child.clone());
                }
            }

            let mut p = self.parent().unwrap();
            // 将目标节点的元素添加到当前节点的元素数组中
            self.node_mut()
                .inodes
                .append(&mut target.node_mut().inodes.drain(..).collect::<Vec<INode>>());
            p.del(target.node().key.as_ref().unwrap()); //将目标节点的key从父节点中移除(target节点和n的父节点是同一个)
            p.remove_child(target.clone()); //从目标节点的父节点的叶子节点中移除目标节点
            bucket.nodes.borrow_mut().remove(&target.node().pgid); //删除当前bucket的节点缓存中的目标节点
            target.free(bucket); //释放target节点占有的页面
        } else {
            {
                //如果target节点是当前节点的左边的兄弟节点,则将当前节点合并到左边的兄弟节点
                for inode in self.node().inodes.iter() {
                    if let Some(child) = bucket.nodes.borrow_mut().get_mut(&inode.pgid) {
                        child.parent().unwrap().remove_child(child.clone());
                        child.node_mut().parent = Some(Rc::downgrade(&target.0));
                        child
                            .parent()
                            .unwrap()
                            .node_mut()
                            .children
                            .push(child.clone());
                    }
                }
            } //将当前节点重父节点和当前bucket的缓存中移除,并且将当前节点的元素添加到左边的兄弟节点中
            let mut p = self.parent().unwrap();
            target
                .node_mut()
                .inodes
                .append(&mut self.node_mut().inodes.drain(..).collect::<Vec<INode>>()); // inodes按照key排序,添加到目标节点中仍然是有序的
            p.del(self.node().key.as_ref().unwrap());
            p.remove_child(self.clone());
            bucket.nodes.borrow_mut().remove(&self.node().pgid);
            self.free(bucket);
        }
        self.parent().unwrap().rebalance(page_size, b)
    }

    //添加元素 分裂
    fn split(&self, page_size: usize, fill_percent: f64) -> Vec<Node> {
        let mut nodes = vec![self.clone()];
        let mut node = self.clone();
        while let Some(b) = node.split_two(page_size, fill_percent) {
            nodes.push(b.clone());
            node = b;
        }
        nodes
    }

    fn split_index(&self, threshold: usize) -> (usize, usize) {
        let mut index: usize = 0;
        let mut sz: usize = 0;
        let n = self.node();
        let max = n.inodes.len() - MIN_KEY_PERPAGE;
        let nodes = &n.inodes;
        for (i, node) in nodes.iter().enumerate().take(max) {
            index = i;
            let elsize = self.page_element_size() + node.key.len() + node.value.len();
            if i > MIN_KEY_PERPAGE && sz + elsize > threshold {
                break;
            }
            sz += elsize;
        }
        (index, sz)
    }

    fn split_two(&mut self, page_size: usize, mut fill_percent: f64) -> Option<Node> {
        if self.node().inodes.len() <= MIN_KEY_PERPAGE * 2 || self.node_less_than(page_size) {
            return None;
        }

        if fill_percent < MIN_FILL_PERCENT {
            fill_percent = MIN_FILL_PERCENT;
        } else if fill_percent > MAX_FILL_PERCENT {
            fill_percent = MAX_FILL_PERCENT;
        }
        let threshold = (page_size as f64 * fill_percent) as usize;
        let (split_index, _) = self.split_index(threshold);

        let next = NodeImpl::new().leaf(self.node().is_leaf).build();
        next.node_mut().inodes = self.node_mut().inodes.drain(split_index..).collect();
        Some(next)
    }

    fn node_less_than(&self, v: usize) -> bool {
        let mut sz = Page::header_size();
        let elsz = self.page_element_size();
        let a = self.node();
        for i in 0..a.inodes.len() {
            let item = a.inodes.get(i).unwrap();
            sz += elsz + item.key.len() + item.value.len();
            if sz >= v {
                return false;
            }
        }
        return true;
    }

    //node spill return parent
    pub(crate) fn spill(&self, atx: Arc<TxImpl>, bucket: &Bucket) -> NKResult<Node> {
        if self.node().spilled {
            return Ok(self.clone());
        }

        self.node_mut()
            .children
            .sort_by(|a, b| (*a).node().inodes[0].key.cmp(&(*b).node().inodes[0].key));

        let children = self.node().children.clone();
        for child in children.iter() {
            child.spill(atx.clone(), bucket)?;
        }

        self.node_mut().children.clear();

        let tx = atx.clone();
        let db = tx.db();

        let mut nodes = self.split(db.get_page_size() as usize, bucket.fill_percent);

        // 这里设置父节点信息
        let parent_node = if nodes.len() == 1 {
            if let Some(p) = &nodes.first().unwrap().node().parent {
                p.upgrade().map(Node).clone()
            } else {
                None
            }
        } else {
            if let Some(parent) = &self.node().parent {
                let p = parent.upgrade().map(Node).unwrap();
                for n in nodes.iter_mut() {
                    n.node_mut().parent = Some(parent.clone());
                }
                p.node_mut().children.extend_from_slice(&nodes[1..]);
                Some(p)
            } else {
                let parent = NodeImpl::new().leaf(false).build();
                parent
                    .node_mut()
                    .children
                    .extend_from_slice(nodes.as_slice());
                Some(parent)
            }
        };
        for n in nodes.iter_mut() {
            if n.node().pgid > 0 {
                db.freelist
                    .try_write()
                    .unwrap()
                    .free(tx.meta.borrow().txid, unsafe { &*db.page(n.node().pgid) });
                n.node_mut().pgid = 0;
            }

            let mut p = db.allocate(n.size() / db.get_page_size() as usize + 1)?;
            let page = p.to_page_mut();
            if page.id >= tx.meta.borrow().pgid {
                panic!(
                    "pgid {} above high water mark{}",
                    page.id,
                    tx.meta.borrow().pgid
                );
            }
            n.node_mut().pgid = page.id;
            n.write(page);
            tx.pages.borrow_mut().insert(page.id, p);
            n.node_mut().spilled = true;

            if let Some(parent) = &parent_node {
                // let mut parent_node = parent.upgrade().map(Node).unwrap();
                if let Some(key) = &n.node().key {
                    let pgid = n.node().pgid;
                    parent.put(key, key, &vec![], pgid, 0);
                } else {
                    let n1 = n.node();
                    let inode = n1.inodes.first().unwrap();
                    let pgid = n.node().pgid;
                    parent.put(&inode.key, &inode.key, &vec![], pgid, 0);
                }
                if n.node().parent.is_none() {
                    n.node_mut().parent.replace(Rc::downgrade(&parent.0));
                }
            }
        }

        if let Some(mut p) = parent_node {
            p.node_mut().children.clear();
            return p.spill(atx, bucket);
        }
        return Ok(self.clone());
    }
}

#[derive(Clone, Debug, Default)]
pub(crate) struct INode {
    pub(crate) flags: u32,
    pub(crate) pgid: Pgid,
    pub(crate) key: Vec<u8>,
    pub(crate) value: Vec<u8>,
}

impl INode {
    fn new() -> INode {
        Self {
            ..Default::default()
        }
    }
}

#[cfg(test)]
mod tests {
    use std::ptr::null_mut;

    use crate::db::MmapUtil;

    use super::*;
    #[test]
    fn test_node_new() {
        let mut buf = vec![0u8; 512];
        let mmap = MmapUtil::default();
        let mut node1 = NodeImpl::new().leaf(true).build();
        node1.put(b"aaa", b"aaa", b"001", 0, 0);
        node1.put(b"bbb", b"bbb", b"002", 0, 0);
        let page = mmap.page_in_buffer_mut(&mut buf, 0);
        node1.write(page);
        let mut node2 = NodeImpl::new().leaf(true).build();
        node2.read(page);
        for n in node2.node().inodes.iter() {
            print!(
                "flags:{},key:{:?},value:{:?},pgid:{} || ",
                n.flags, n.key, n.value, n.pgid
            );
        }
    }
}