Fixes bug with radix_delete()
[akaros.git] / kern / src / radix.c
1 /* Copyright (c) 2010 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Radix Trees!  Just the basics, doesn't do tagging or anything fancy. */
6
7 #include <ros/errno.h>
8 #include <radix.h>
9 #include <slab.h>
10 #include <string.h>
11 #include <stdio.h>
12
13 struct kmem_cache *radix_kcache;
14 static struct radix_node *__radix_lookup_node(struct radix_tree *tree,
15                                               unsigned long key,
16                                               bool extend);
17 static void __radix_remove_slot(struct radix_node *r_node, struct radix_node **slot);
18
19 /* Initializes the radix tree system, mostly just builds the kcache */
20 void radix_init(void)
21 {
22         radix_kcache = kmem_cache_create("radix_nodes", sizeof(struct radix_node),
23                                          __alignof__(struct radix_node), 0, 0, 0);
24 }
25
26 /* Initializes a tree dynamically */
27 void radix_tree_init(struct radix_tree *tree)
28 {
29         tree->root = 0;
30         tree->depth = 0;
31         tree->upper_bound = 0;
32 }
33
34 /* Will clean up all the memory associated with a tree.  Shouldn't be necessary
35  * if you delete all of the items, which you should do anyways since they are
36  * usually void*.  Might expand this to have a function to call on every leaf
37  * slot. */
38 void radix_tree_destroy(struct radix_tree *tree)
39 {
40         /* Currently, we may have a root node, even if all the elements were removed
41          */
42         panic("Not implemented");
43 }
44
45 /* Attempts to insert an item in the tree at the given key.  ENOMEM if we ran
46  * out of memory, EEXIST if an item is already in the tree. */
47 int radix_insert(struct radix_tree *tree, unsigned long key, void *item)
48 {
49         printd("RADIX: insert %08p at %d\n", item, key);
50         struct radix_node *r_node;
51         void **slot;
52         /* Is the tree tall enough?  if not, it needs to grow a level.  This will
53          * also create the initial node (upper bound starts at 0). */
54         while (key >= tree->upper_bound) {
55                 r_node = kmem_cache_alloc(radix_kcache, 0);
56                 if (!r_node)
57                         return -ENOMEM;
58                 memset(r_node, 0, sizeof(struct radix_node));
59                 if (tree->root) {
60                         /* tree->root is the old root, now a child of the future root */
61                         r_node->items[0] = tree->root;
62                         tree->root->parent = r_node;
63                         tree->root->my_slot = (struct radix_node**)&r_node->items[0];
64                         r_node->num_items = 1;
65                 } else {
66                         /* if there was no root before, we're both the root and a leaf */
67                         r_node->leaf = TRUE;
68                         r_node->parent = 0;
69                 }
70                 tree->root = r_node;
71                 r_node->my_slot = &tree->root;
72                 tree->depth++;
73                 tree->upper_bound = 1 << (LOG_RNODE_SLOTS * tree->depth);
74         }
75         assert(tree->root);
76         /* the tree now thinks it is tall enough, so find the last node, insert in
77          * it, etc */
78         r_node = __radix_lookup_node(tree, key, TRUE);
79         assert(r_node);         /* we want an ENOMEM actually, but i want to see this */
80         slot = &r_node->items[key & (NR_RNODE_SLOTS - 1)];
81         if (*slot)
82                 return -EEXIST;
83         *slot = item;
84         r_node->num_items++;
85         return 0;
86 }
87
88 /* Removes an item from it's parent's structure, freeing the parent if there is
89  * nothing left, potentially recursively. */
90 static void __radix_remove_slot(struct radix_node *r_node, struct radix_node **slot)
91 {
92         assert(*slot);          /* make sure there is something there */
93         *slot = 0;
94         r_node->num_items--;
95         /* this check excludes the root, but the if else handles it.  For now, once
96          * we have a root, we'll always keep it (will need some changing in
97          * radix_insert() */
98         if (!r_node->num_items && r_node->parent) {
99                 if (r_node->parent)
100                         __radix_remove_slot(r_node->parent, r_node->my_slot);
101                 else                    /* we're the last node, attached to the actual tree */
102                         *(r_node->my_slot) = 0;
103                 kmem_cache_free(radix_kcache, r_node);
104         }
105 }
106
107 /* Removes a key/item from the tree, returning that item (the void*).  If it
108  * detects a radix_node is now unused, it will dealloc that node.  Though the
109  * tree will still think it is tall enough to handle its old upper_bound.  It
110  * won't "shrink". */
111 void *radix_delete(struct radix_tree *tree, unsigned long key)
112 {
113         printd("RADIX: delete %d\n", key);
114         void **slot;
115         void *retval;
116         struct radix_node *r_node = __radix_lookup_node(tree, key, 0);
117         if (!r_node)
118                 return 0;
119         slot = &r_node->items[key & (NR_RNODE_SLOTS - 1)];
120         retval = *slot;
121         if (retval) {
122                 __radix_remove_slot(r_node, (struct radix_node**)slot); 
123         } else {
124                 /* it's okay to delete an empty, but i want to know about it for now */
125                 warn("Tried to remove a non-existant item from a radix tree!");
126         }
127         return retval;
128 }
129
130 /* Returns the item for a given key.  0 means no item, etc. */
131 void *radix_lookup(struct radix_tree *tree, unsigned long key)
132 {
133         printd("RADIX: lookup %d\n", key);
134         void **slot = radix_lookup_slot(tree, key);
135         if (!slot)
136                 return 0;
137         return *slot;
138 }
139
140 /* Returns a pointer to the radix_node holding a given key.  0 if there is no
141  * such node, due to the tree being too small or something.
142  *
143  * If the depth is greater than one, we need to walk down the tree a level.  The
144  * key is 'partitioned' among the levels of the tree, like so:
145  * ......444444333333222222111111
146  *
147  * If an interior node of the tree is missing, this will add one if it was
148  * directed to extend the tree. */
149 static struct radix_node *__radix_lookup_node(struct radix_tree *tree,
150                                               unsigned long key, bool extend)
151 {
152         printd("RADIX: lookup_node %d, %d\n", key, extend);
153         unsigned long idx;
154         struct radix_node *child_node, *r_node = tree->root;
155         if (key >= tree->upper_bound) {
156                 if (extend)
157                         warn("Bound (%d) not set for key %d!\n", tree->upper_bound, key);
158                 return 0;
159         }
160         for (int i = tree->depth; i > 1; i--) {  /* i = ..., 4, 3, 2 */
161                 idx = (key >> (LOG_RNODE_SLOTS * (i - 1))) & (NR_RNODE_SLOTS - 1);
162                 /* There might not be a node at this part of the tree */
163                 if (!r_node->items[idx]) {
164                         if (!extend) {
165                                 return 0;
166                         } else {
167                                 /* so build one, possibly returning 0 if we couldn't */
168                                 child_node = kmem_cache_alloc(radix_kcache, 0);
169                                 if (!child_node)
170                                         return 0;
171                                 r_node->items[idx] = child_node;
172                                 memset(child_node, 0, sizeof(struct radix_node));
173                                 /* when we are on the last iteration (i == 2), the child will be
174                                  * a leaf. */
175                                 child_node->leaf = (i == 2) ? TRUE : FALSE;
176                                 child_node->parent = r_node;
177                                 child_node->my_slot = (struct radix_node**)&r_node->items[idx];
178                                 r_node->num_items++;
179                                 r_node = (struct radix_node*)r_node->items[idx];
180                         }
181                 } else {
182                         r_node = (struct radix_node*)r_node->items[idx];
183                 }
184         }
185         return r_node;
186 }
187
188 /* Returns a pointer to the slot for the given key.  0 if there is no such slot,
189  * etc */
190 void **radix_lookup_slot(struct radix_tree *tree, unsigned long key)
191 {
192         printd("RADIX: lookup slot %d\n", key);
193         struct radix_node *r_node = __radix_lookup_node(tree, key, FALSE);
194         if (!r_node)
195                 return 0;
196         key = key & (NR_RNODE_SLOTS - 1);
197         return &r_node->items[key];
198 }
199
200 int radix_gang_lookup(struct radix_tree *tree, void **results,
201                       unsigned long first, unsigned int max_items)
202 {
203         panic("Not implemented");
204         return -1; /* TODO! */
205 }
206
207
208 int radix_grow(struct radix_tree *tree, unsigned long max)
209 {
210         panic("Not implemented");
211         return -1; /* TODO! */
212 }
213
214 int radix_preload(struct radix_tree *tree, int flags)
215 {
216         panic("Not implemented");
217         return -1; /* TODO! */
218 }
219
220
221 void *radix_tag_set(struct radix_tree *tree, unsigned long key, int tag)
222 {
223         panic("Tagging not implemented!");
224         return (void*)-1; /* TODO! */
225 }
226
227 void *radix_tag_clear(struct radix_tree *tree, unsigned long key, int tag)
228 {
229         panic("Tagging not implemented!");
230         return (void*)-1; /* TODO! */
231 }
232
233 int radix_tag_get(struct radix_tree *tree, unsigned long key, int tag)
234 {
235         panic("Tagging not implemented!");
236         return -1; /* TODO! */
237 }
238
239 int radix_tree_tagged(struct radix_tree *tree, int tag)
240 {
241         panic("Tagging not implemented!");
242         return -1; /* TODO! */
243 }
244
245 int radix_tag_gang_lookup(struct radix_tree *tree, void **results,
246                           unsigned long first, unsigned int max_items, int tag)
247 {
248         panic("Tagging not implemented!");
249         return -1; /* TODO! */
250 }
251
252 void print_radix_tree(struct radix_tree *tree)
253 {
254         printk("Tree %08p, Depth: %d, Bound: %d\n", tree, tree->depth,
255                tree->upper_bound);
256
257         void print_rnode(struct radix_node *r_node, int depth)
258         {
259                 if (!r_node)
260                         return;
261                 char buf[32] = {0};
262                 for (int i = 0; i < depth; i++)
263                         buf[i] = '\t';
264                 printk("%sRnode %08p, parent %08p, myslot %08p, %d items, leaf? %d\n",
265                        buf, r_node, r_node->parent, r_node->my_slot, r_node->num_items,
266                        r_node->leaf);
267                 for (int i = 0; i < NR_RNODE_SLOTS; i++) {
268                         if (!r_node->items[i])
269                                 continue;
270                         if (r_node->leaf)
271                                 printk("\t%sRnode Item %d: %08p\n", buf, i, r_node->items[i]);
272                         else
273                                 print_rnode(r_node->items[i], depth + 1);
274                 }
275         }
276         print_rnode(tree->root, 0);
277 }