BNX2X: spatch signed typedefs
[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.  On success, will
47  * also return the slot pointer, if requested. */
48 int radix_insert(struct radix_tree *tree, unsigned long key, void *item,
49                  void ***slot_p)
50 {
51         printd("RADIX: insert %p at %d\n", item, key);
52         struct radix_node *r_node;
53         void **slot;
54         /* Is the tree tall enough?  if not, it needs to grow a level.  This will
55          * also create the initial node (upper bound starts at 0). */
56         while (key >= tree->upper_bound) {
57                 r_node = kmem_cache_alloc(radix_kcache, 0);
58                 if (!r_node)
59                         return -ENOMEM;
60                 memset(r_node, 0, sizeof(struct radix_node));
61                 if (tree->root) {
62                         /* tree->root is the old root, now a child of the future root */
63                         r_node->items[0] = tree->root;
64                         tree->root->parent = r_node;
65                         tree->root->my_slot = (struct radix_node**)&r_node->items[0];
66                         r_node->num_items = 1;
67                 } else {
68                         /* if there was no root before, we're both the root and a leaf */
69                         r_node->leaf = TRUE;
70                         r_node->parent = 0;
71                 }
72                 tree->root = r_node;
73                 r_node->my_slot = &tree->root;
74                 tree->depth++;
75                 tree->upper_bound = 1 << (LOG_RNODE_SLOTS * tree->depth);
76         }
77         assert(tree->root);
78         /* the tree now thinks it is tall enough, so find the last node, insert in
79          * it, etc */
80         r_node = __radix_lookup_node(tree, key, TRUE);
81         assert(r_node);         /* we want an ENOMEM actually, but i want to see this */
82         slot = &r_node->items[key & (NR_RNODE_SLOTS - 1)];
83         if (*slot)
84                 return -EEXIST;
85         *slot = item;
86         r_node->num_items++;
87         if (slot_p)
88                 *slot_p = slot;
89         return 0;
90 }
91
92 /* Removes an item from it's parent's structure, freeing the parent if there is
93  * nothing left, potentially recursively. */
94 static void __radix_remove_slot(struct radix_node *r_node, struct radix_node **slot)
95 {
96         assert(*slot);          /* make sure there is something there */
97         *slot = 0;
98         r_node->num_items--;
99         /* this check excludes the root, but the if else handles it.  For now, once
100          * we have a root, we'll always keep it (will need some changing in
101          * radix_insert() */
102         if (!r_node->num_items && r_node->parent) {
103                 if (r_node->parent)
104                         __radix_remove_slot(r_node->parent, r_node->my_slot);
105                 else                    /* we're the last node, attached to the actual tree */
106                         *(r_node->my_slot) = 0;
107                 kmem_cache_free(radix_kcache, r_node);
108         }
109 }
110
111 /* Removes a key/item from the tree, returning that item (the void*).  If it
112  * detects a radix_node is now unused, it will dealloc that node.  Though the
113  * tree will still think it is tall enough to handle its old upper_bound.  It
114  * won't "shrink". */
115 void *radix_delete(struct radix_tree *tree, unsigned long key)
116 {
117         printd("RADIX: delete %d\n", key);
118         void **slot;
119         void *retval;
120         struct radix_node *r_node = __radix_lookup_node(tree, key, 0);
121         if (!r_node)
122                 return 0;
123         slot = &r_node->items[key & (NR_RNODE_SLOTS - 1)];
124         retval = *slot;
125         if (retval) {
126                 __radix_remove_slot(r_node, (struct radix_node**)slot); 
127         } else {
128                 /* it's okay to delete an empty, but i want to know about it for now */
129                 warn("Tried to remove a non-existant item from a radix tree!");
130         }
131         return retval;
132 }
133
134 /* Returns the item for a given key.  0 means no item, etc. */
135 void *radix_lookup(struct radix_tree *tree, unsigned long key)
136 {
137         printd("RADIX: lookup %d\n", key);
138         void **slot = radix_lookup_slot(tree, key);
139         if (!slot)
140                 return 0;
141         return *slot;
142 }
143
144 /* Returns a pointer to the radix_node holding a given key.  0 if there is no
145  * such node, due to the tree being too small or something.
146  *
147  * If the depth is greater than one, we need to walk down the tree a level.  The
148  * key is 'partitioned' among the levels of the tree, like so:
149  * ......444444333333222222111111
150  *
151  * If an interior node of the tree is missing, this will add one if it was
152  * directed to extend the tree. */
153 static struct radix_node *__radix_lookup_node(struct radix_tree *tree,
154                                               unsigned long key, bool extend)
155 {
156         printd("RADIX: lookup_node %d, %d\n", key, extend);
157         unsigned long idx;
158         struct radix_node *child_node, *r_node = tree->root;
159         if (key >= tree->upper_bound) {
160                 if (extend)
161                         warn("Bound (%d) not set for key %d!\n", tree->upper_bound, key);
162                 return 0;
163         }
164         for (int i = tree->depth; i > 1; i--) {  /* i = ..., 4, 3, 2 */
165                 idx = (key >> (LOG_RNODE_SLOTS * (i - 1))) & (NR_RNODE_SLOTS - 1);
166                 /* There might not be a node at this part of the tree */
167                 if (!r_node->items[idx]) {
168                         if (!extend) {
169                                 return 0;
170                         } else {
171                                 /* so build one, possibly returning 0 if we couldn't */
172                                 child_node = kmem_cache_alloc(radix_kcache, 0);
173                                 if (!child_node)
174                                         return 0;
175                                 r_node->items[idx] = child_node;
176                                 memset(child_node, 0, sizeof(struct radix_node));
177                                 /* when we are on the last iteration (i == 2), the child will be
178                                  * a leaf. */
179                                 child_node->leaf = (i == 2) ? TRUE : FALSE;
180                                 child_node->parent = r_node;
181                                 child_node->my_slot = (struct radix_node**)&r_node->items[idx];
182                                 r_node->num_items++;
183                                 r_node = (struct radix_node*)r_node->items[idx];
184                         }
185                 } else {
186                         r_node = (struct radix_node*)r_node->items[idx];
187                 }
188         }
189         return r_node;
190 }
191
192 /* Returns a pointer to the slot for the given key.  0 if there is no such slot,
193  * etc */
194 void **radix_lookup_slot(struct radix_tree *tree, unsigned long key)
195 {
196         printd("RADIX: lookup slot %d\n", key);
197         struct radix_node *r_node = __radix_lookup_node(tree, key, FALSE);
198         if (!r_node)
199                 return 0;
200         key = key & (NR_RNODE_SLOTS - 1);
201         return &r_node->items[key];
202 }
203
204 int radix_gang_lookup(struct radix_tree *tree, void **results,
205                       unsigned long first, unsigned int max_items)
206 {
207         panic("Not implemented");
208         return -1; /* TODO! */
209 }
210
211
212 int radix_grow(struct radix_tree *tree, unsigned long max)
213 {
214         panic("Not implemented");
215         return -1; /* TODO! */
216 }
217
218 int radix_preload(struct radix_tree *tree, int flags)
219 {
220         panic("Not implemented");
221         return -1; /* TODO! */
222 }
223
224
225 void *radix_tag_set(struct radix_tree *tree, unsigned long key, int tag)
226 {
227         panic("Tagging not implemented!");
228         return (void*)-1; /* TODO! */
229 }
230
231 void *radix_tag_clear(struct radix_tree *tree, unsigned long key, int tag)
232 {
233         panic("Tagging not implemented!");
234         return (void*)-1; /* TODO! */
235 }
236
237 int radix_tag_get(struct radix_tree *tree, unsigned long key, int tag)
238 {
239         panic("Tagging not implemented!");
240         return -1; /* TODO! */
241 }
242
243 int radix_tree_tagged(struct radix_tree *tree, int tag)
244 {
245         panic("Tagging not implemented!");
246         return -1; /* TODO! */
247 }
248
249 int radix_tag_gang_lookup(struct radix_tree *tree, void **results,
250                           unsigned long first, unsigned int max_items, int tag)
251 {
252         panic("Tagging not implemented!");
253         return -1; /* TODO! */
254 }
255
256 void print_radix_tree(struct radix_tree *tree)
257 {
258         printk("Tree %p, Depth: %d, Bound: %d\n", tree, tree->depth,
259                tree->upper_bound);
260
261         void print_rnode(struct radix_node *r_node, int depth)
262         {
263                 if (!r_node)
264                         return;
265                 char buf[32] = {0};
266                 for (int i = 0; i < depth; i++)
267                         buf[i] = '\t';
268                 printk("%sRnode %p, parent %p, myslot %p, %d items, leaf? %d\n",
269                        buf, r_node, r_node->parent, r_node->my_slot, r_node->num_items,
270                        r_node->leaf);
271                 for (int i = 0; i < NR_RNODE_SLOTS; i++) {
272                         if (!r_node->items[i])
273                                 continue;
274                         if (r_node->leaf)
275                                 printk("\t%sRnode Item %d: %p\n", buf, i, r_node->items[i]);
276                         else
277                                 print_rnode(r_node->items[i], depth + 1);
278                 }
279         }
280         print_rnode(tree->root, 0);
281 }