Subversion Repositories HelenOS

Rev

Rev 3386 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1101 jermar 1
/*
2071 jermar 2
 * Copyright (c) 2006 Jakub Jermar
1101 jermar 3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
7
 * are met:
8
 *
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
13
 *   documentation and/or other materials provided with the distribution.
14
 * - The name of the author may not be used to endorse or promote products
15
 *   derived from this software without specific prior written permission.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
28
 
1888 jermar 29
/** @addtogroup genericadt
1702 cejka 30
 * @{
31
 */
32
/** @file
33
 */
34
 
1888 jermar 35
#ifndef KERN_BTREE_H_
36
#define KERN_BTREE_H_
1101 jermar 37
 
38
#include <arch/types.h>
39
#include <adt/list.h>
40
 
1140 jermar 41
#define BTREE_M     5
1101 jermar 42
#define BTREE_MAX_KEYS  (BTREE_M - 1)
43
 
1780 jermar 44
typedef uint64_t btree_key_t;
1177 jermar 45
 
1101 jermar 46
/** B-tree node structure. */
2089 decky 47
typedef struct btree_node {
1101 jermar 48
    /** Number of keys. */
4581 mejdrech 49
    size_t keys;
1101 jermar 50
 
2106 jermar 51
    /**
52
     * Keys. We currently support only single keys. Additional room for one
53
     * extra key is provided.
54
     */
1177 jermar 55
    btree_key_t key[BTREE_MAX_KEYS + 1];
1101 jermar 56
 
57
    /**
2106 jermar 58
     * Pointers to values. Sorted according to the key array. Defined only in
59
     * leaf-level. There is room for storing value for the extra key.
1101 jermar 60
     */
61
    void *value[BTREE_MAX_KEYS + 1];
62
 
63
    /**
2106 jermar 64
     * Pointers to descendants of this node sorted according to the key
65
     * array.
66
     *
1140 jermar 67
     * subtree[0] points to subtree with keys lesser than to key[0].
2106 jermar 68
     * subtree[1] points to subtree with keys greater than or equal to
69
     *        key[0] and lesser than key[1].
1101 jermar 70
     * ...
71
     * There is room for storing a subtree pointer for the extra key.
72
     */
2089 decky 73
    struct btree_node *subtree[BTREE_M + 1];
1101 jermar 74
 
75
    /** Pointer to parent node. Root node has NULL parent. */
2089 decky 76
    struct btree_node *parent;
1101 jermar 77
 
2106 jermar 78
    /**
79
     * Link connecting leaf-level nodes. Defined only when this node is a
80
     * leaf. */
1101 jermar 81
    link_t leaf_link;
82
 
2106 jermar 83
    /* Variables needed by btree_print(). */   
1101 jermar 84
    link_t bfs_link;
85
    int depth;
2089 decky 86
} btree_node_t;
1101 jermar 87
 
88
/** B-tree structure. */
2089 decky 89
typedef struct {
1101 jermar 90
    btree_node_t *root; /**< B-tree root node pointer. */
91
    link_t leaf_head;   /**< Leaf-level list head. */
2089 decky 92
} btree_t;
1101 jermar 93
 
1164 jermar 94
extern void btree_init(void);
95
 
1101 jermar 96
extern void btree_create(btree_t *t);
97
extern void btree_destroy(btree_t *t);
98
 
2106 jermar 99
extern void btree_insert(btree_t *t, btree_key_t key, void *value,
100
    btree_node_t *leaf_node);
1177 jermar 101
extern void btree_remove(btree_t *t, btree_key_t key, btree_node_t *leaf_node);
102
extern void *btree_search(btree_t *t, btree_key_t key, btree_node_t **leaf_node);
1101 jermar 103
 
2106 jermar 104
extern btree_node_t *btree_leaf_node_left_neighbour(btree_t *t,
105
    btree_node_t *node);
106
extern btree_node_t *btree_leaf_node_right_neighbour(btree_t *t,
107
    btree_node_t *node);
1147 jermar 108
 
1101 jermar 109
extern void btree_print(btree_t *t);
110
#endif
1702 cejka 111
 
1888 jermar 112
/** @}
1702 cejka 113
 */