Removes Ivy annotations (XCC)
[akaros.git] / kern / include / hashtable.h
1 /* Copyright (C) 2002, 2004 Christopher Clark <firstname.lastname@cl.cam.ac.uk>
2  * 
3  * Modified 2009 by Barret Rhoden <brho@cs.berkeley.edu>
4  * Changes include:
5  *   - No longer frees keys or values.  It's up to the client to do that.
6  *   - Provides common hash and equality functions (meant for longs)
7  *   - Uses the slab allocator for hash entry allocation.
8  *   - Merges the iterator code with the main hash table code, mostly to avoid
9  *   externing the hentry cache.
10  *   - hash for each */
11
12 #ifndef __ROS_KERN_HASHTABLE_H__
13 #define __ROS_KERN_HASHTABLE_H__
14
15 #include <ros/common.h>
16
17 /*****************************************************************************/
18 typedef struct hash_entry
19 {
20     void *k, *v;
21     size_t h;
22     struct hash_entry *next;
23 } hash_entry_t;
24
25 typedef struct hashtable {
26     size_t tablelength;
27     hash_entry_t **table;
28     size_t entrycount;
29     size_t loadlimit;
30     size_t primeindex;
31     size_t (*hashfn) (void *k);
32     ssize_t (*eqfn) (void *k1, void *k2);
33 } hashtable_t;
34
35 static inline size_t indexFor(unsigned int tablelength, unsigned int hashvalue)
36 {
37         return (hashvalue % tablelength);
38 };
39
40 /*****************************************************************************/
41
42 /* Example of use:
43  *              hashtable_init(); // Do this once during kernel initialization
44  *
45  *      struct hashtable  *h;
46  *      struct some_key   *k;
47  *      struct some_value *v;
48  *
49  *      static size_t         hash_from_key_fn( void *k );
50  *      static ssize_t        keys_equal_fn ( void *key1, void *key2 );
51  *
52  *      h = create_hashtable(16, hash_from_key_fn, keys_equal_fn);
53  *      k = (struct some_key *)     kmalloc(sizeof(struct some_key));
54  *      v = (struct some_value *)   kmalloc(sizeof(struct some_value));
55  *
56  *      (initialise k and v to suitable values)
57  * 
58  *      if (! hashtable_insert(h,k,v) )
59  *      {     panic("Hashtable broken...\n");       }
60  *
61  *      if (NULL == (found = hashtable_search(h,k) ))
62  *      {    printk("not found!");                  }
63  *
64  *      if (NULL == (found = hashtable_remove(h,k) ))
65  *      {    printk("Not found\n");                 }
66  *
67  */
68
69 /* Macros may be used to define type-safe(r) hashtable access functions, with
70  * methods specialized to take known key and value types as parameters.
71  * 
72  * Example:
73  *
74  * Insert this at the start of your file:
75  *
76  * DEFINE_HASHTABLE_INSERT(insert_some, struct some_key, struct some_value);
77  * DEFINE_HASHTABLE_SEARCH(search_some, struct some_key, struct some_value);
78  * DEFINE_HASHTABLE_REMOVE(remove_some, struct some_key, struct some_value);
79  *
80  * This defines the functions 'insert_some', 'search_some' and 'remove_some'.
81  * These operate just like hashtable_insert etc., with the same parameters,
82  * but their function signatures have 'struct some_key *' rather than
83  * 'void *', and hence can generate compile time errors if your program is
84  * supplying incorrect data as a key (and similarly for value).
85  *
86  * Note that the hash and key equality functions passed to create_hashtable
87  * still take 'void *' parameters instead of 'some key *'. This shouldn't be
88  * a difficult issue as they're only defined and passed once, and the other
89  * functions will ensure that only valid keys are supplied to them.
90  *
91  * The cost for this checking is increased code size and runtime overhead
92  * - if performance is important, it may be worth switching back to the
93  * unsafe methods once your program has been debugged with the safe methods.
94  * This just requires switching to some simple alternative defines - eg:
95  * #define insert_some hashtable_insert
96  *
97  */
98
99 /* Call this once on bootup, after initializing the slab allocator.  */
100 void hashtable_init(void);
101
102 /* Common hash/equals functions.  Don't call these directly. */
103 size_t __generic_hash(void *k);
104 ssize_t __generic_eq(void *k1, void *k2);
105
106 /*****************************************************************************
107  * create_hashtable
108    
109  * @name                    create_hashtable
110  * @param   minsize         minimum initial size of hashtable
111  * @param   hashfunction    function for hashing keys
112  * @param   key_eq_fn       function for determining key equality
113  * @return                  newly created hashtable or NULL on failure
114  */
115
116 hashtable_t *
117 create_hashtable(size_t minsize,
118                  size_t (*hashfunction) (void*),
119                  ssize_t (*key_eq_fn) (void*,void*));
120
121 /*****************************************************************************
122  * hashtable_insert
123    
124  * @name        hashtable_insert
125  * @param   h   the hashtable to insert into
126  * @param   k   the key
127  * @param   v   the value
128  * @return      non-zero for successful insertion
129  *
130  * This function will cause the table to expand if the insertion would take
131  * the ratio of entries to table size over the maximum load factor.
132  *
133  * This function does not check for repeated insertions with a duplicate key.
134  * The value returned when using a duplicate key is undefined -- when
135  * the hashtable changes size, the order of retrieval of duplicate key
136  * entries is reversed.
137  * If in doubt, remove before insert.
138  */
139
140 ssize_t 
141 hashtable_insert(hashtable_t *h, void *k, void *v);
142
143 #define DEFINE_HASHTABLE_INSERT(fnname, keytype, valuetype) \
144 ssize_t fnname (hashtable_t *h, keytype *k, valuetype *v) \
145 { \
146     return hashtable_insert(h,k,v); \
147 }
148
149 /*****************************************************************************
150  * hashtable_search
151    
152  * @name        hashtable_search
153  * @param   h   the hashtable to search
154  * @param   k   the key to search for
155  * @return      the value associated with the key, or NULL if none found
156  */
157
158 void *
159 hashtable_search(hashtable_t *h, void *k);
160
161 #define DEFINE_HASHTABLE_SEARCH(fnname, keytype, valuetype) \
162 valuetype * fnname (hashtable_t *h, keytype *k) \
163 { \
164     return (valuetype *) (hashtable_search(h,k)); \
165 }
166
167 /*****************************************************************************
168  * hashtable_remove
169    
170  * @name        hashtable_remove
171  * @param   h   the hashtable to remove the item from
172  * @param   k   the key to search for
173  * @return      the value associated with the key, or NULL if none found
174  *
175  * Caller ought to free the key, if appropriate.
176  */
177
178 void * /* returns value */
179 hashtable_remove(hashtable_t *h, void *k);
180
181 #define DEFINE_HASHTABLE_REMOVE(fnname, keytype, valuetype) \
182 valuetype * fnname (hashtable_t *h, keytype *k) \
183 { \
184     return (valuetype *) (hashtable_remove(h,k)); \
185 }
186
187
188 /*****************************************************************************
189  * hashtable_count
190    
191  * @name        hashtable_count
192  * @param   h   the hashtable
193  * @return      the number of items stored in the hashtable
194  */
195
196 size_t
197 hashtable_count(hashtable_t *h);
198
199
200 /*****************************************************************************
201  * hashtable_destroy
202    
203  * @name        hashtable_destroy
204  * @param   h   the hashtable
205  *
206  * This will not free the values or the keys.  Each user of the hashtable may
207  * have a different way of freeing (such as the slab allocator, kfree, or
208  * nothing (key is just an integer)).
209  *
210  * If the htable isn't empty, you ought to iterate through and destroy manually.
211  * This will warn if you try to destroy an non-empty htable.
212  */
213
214 void
215 hashtable_destroy(hashtable_t *h);
216
217 /***************************** Hashtable Iterator ****************************/
218 /*****************************************************************************/
219 /* This struct is only concrete here to allow the inlining of two of the
220  * accessor functions. */
221 typedef struct hashtable_itr {
222     hashtable_t *h;
223     hash_entry_t *e;
224     hash_entry_t *parent;
225     size_t index;
226 } hashtable_itr_t;
227
228 /*****************************************************************************/
229 /* hashtable_iterator.  Be sure to kfree this when you are done.
230  */
231
232 hashtable_itr_t *
233 hashtable_iterator(hashtable_t *h);
234
235 /*****************************************************************************/
236 /* hashtable_iterator_key
237  * - return the key of the (key,value) pair at the current position
238  *
239  * Keep this in sync with the non-externed version in the .c */
240
241 extern inline void *
242 hashtable_iterator_key(hashtable_itr_t *i)
243 {
244     return i->e->k;
245 }
246
247 /*****************************************************************************/
248 /* value - return the value of the (key,value) pair at the current position
249  *
250  * Keep this in sync with the non-externed version in the .c */
251
252 extern inline void *
253 hashtable_iterator_value(hashtable_itr_t *i)
254 {
255     return i->e->v;
256 }
257
258 /*****************************************************************************/
259 /* advance - advance the iterator to the next element
260  *           returns zero if advanced to end of table */
261
262 ssize_t
263 hashtable_iterator_advance(hashtable_itr_t *itr);
264
265 /*****************************************************************************/
266 /* remove - remove current element and advance the iterator to the next element
267  *          NB: if you need the key or value to free it, read it before
268  *          removing. ie: beware memory leaks!  this will not remove the key.
269  *          returns zero if advanced to end of table */
270
271 ssize_t
272 hashtable_iterator_remove(hashtable_itr_t *itr);
273
274 /*****************************************************************************/
275 /* search - overwrite the supplied iterator, to point to the entry
276  *          matching the supplied key.
277  *          h points to the hashtable to be searched.
278  *          returns zero if not found. */
279 ssize_t
280 hashtable_iterator_search(hashtable_itr_t *itr,
281                           hashtable_t *h, void *k);
282
283 #define DEFINE_HASHTABLE_ITERATOR_SEARCH(fnname, keytype) \
284 ssize_t fnname (hashtable_itr_t *i, hashtable_t *h, keytype *k) \
285 { \
286     return (hashtable_iterator_search(i,h,k)); \
287 }
288
289 /* Runs func on each member of the hash table */
290 void hash_for_each(struct hashtable *hash, void func(void*));
291 /* Same, but removes the item too */
292 void hash_for_each_remove(struct hashtable *hash, void func(void*));
293
294 #endif /* __ROS_KERN_HASHTABLE_H__ */
295
296 /*
297  * Copyright (c) 2002, 2004, Christopher Clark
298  * All rights reserved.
299  * 
300  * Redistribution and use in source and binary forms, with or without
301  * modification, are permitted provided that the following conditions
302  * are met:
303  * 
304  * * Redistributions of source code must retain the above copyright
305  * notice, this list of conditions and the following disclaimer.
306  * 
307  * * Redistributions in binary form must reproduce the above copyright
308  * notice, this list of conditions and the following disclaimer in the
309  * documentation and/or other materials provided with the distribution.
310  * 
311  * * Neither the name of the original author; nor the names of any contributors
312  * may be used to endorse or promote products derived from this software
313  * without specific prior written permission.
314  * 
315  * 
316  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
317  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
318  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
319  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER
320  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
321  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
322  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
323  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
324  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
325  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
326  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
327 */