Subversion Repositories HelenOS-historic

Rev

Rev 1177 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 1177 Rev 1702
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
-
 
30
 * @{
-
 
31
 */
-
 
32
/** @file
-
 
33
 */
-
 
34
 
29
#ifndef __BTREE_H__
35
#ifndef __BTREE_H__
30
#define __BTREE_H__
36
#define __BTREE_H__
31
 
37
 
32
#include <arch/types.h>
38
#include <arch/types.h>
33
#include <typedefs.h>
39
#include <typedefs.h>
34
#include <adt/list.h>
40
#include <adt/list.h>
35
 
41
 
36
#define BTREE_M     5
42
#define BTREE_M     5
37
#define BTREE_MAX_KEYS  (BTREE_M - 1)
43
#define BTREE_MAX_KEYS  (BTREE_M - 1)
38
 
44
 
39
typedef __u64 btree_key_t;
45
typedef __u64 btree_key_t;
40
 
46
 
41
/** B-tree node structure. */
47
/** B-tree node structure. */
42
struct btree_node {
48
struct btree_node {
43
    /** Number of keys. */
49
    /** Number of keys. */
44
    count_t keys;
50
    count_t keys;
45
 
51
 
46
    /** 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. */
47
    btree_key_t key[BTREE_MAX_KEYS + 1];
53
    btree_key_t key[BTREE_MAX_KEYS + 1];
48
 
54
 
49
    /**
55
    /**
50
     * 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.
51
     * There is room for storing value for the extra key.
57
     * There is room for storing value for the extra key.
52
     */
58
     */
53
    void *value[BTREE_MAX_KEYS + 1];
59
    void *value[BTREE_MAX_KEYS + 1];
54
   
60
   
55
    /**
61
    /**
56
     * 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.
57
     * 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].
58
     * 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].
59
     * ...
65
     * ...
60
     * 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.
61
     */
67
     */
62
    btree_node_t *subtree[BTREE_M + 1];
68
    btree_node_t *subtree[BTREE_M + 1];
63
 
69
 
64
    /** Pointer to parent node. Root node has NULL parent. */
70
    /** Pointer to parent node. Root node has NULL parent. */
65
    btree_node_t *parent;
71
    btree_node_t *parent;
66
 
72
 
67
    /** 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. */
68
    link_t leaf_link;
74
    link_t leaf_link;
69
 
75
 
70
    /** Variables needed by btree_print(). */  
76
    /** Variables needed by btree_print(). */  
71
    link_t bfs_link;
77
    link_t bfs_link;
72
    int depth;
78
    int depth;
73
};
79
};
74
 
80
 
75
/** B-tree structure. */
81
/** B-tree structure. */
76
struct btree {
82
struct btree {
77
    btree_node_t *root; /**< B-tree root node pointer. */
83
    btree_node_t *root; /**< B-tree root node pointer. */
78
    link_t leaf_head;   /**< Leaf-level list head. */
84
    link_t leaf_head;   /**< Leaf-level list head. */
79
};
85
};
80
 
86
 
81
extern void btree_init(void);
87
extern void btree_init(void);
82
 
88
 
83
extern void btree_create(btree_t *t);
89
extern void btree_create(btree_t *t);
84
extern void btree_destroy(btree_t *t);
90
extern void btree_destroy(btree_t *t);
85
 
91
 
86
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);
87
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);
88
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);
89
 
95
 
90
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);
91
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);
92
 
98
 
93
extern void btree_print(btree_t *t);
99
extern void btree_print(btree_t *t);
94
#endif
100
#endif
-
 
101
 
-
 
102
 /** @}
-
 
103
 */
-
 
104
 
95
 
105