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