Restored ivy based compilation.
[akaros.git] / kern / include / hashtable.h
1 /* Copyright (C) 2002 Christopher Clark <firstname.lastname@cl.cam.ac.uk> */
2
3 #ifndef __ROS_KERN_HASHTABLE_H__
4 #define __ROS_KERN_HASHTABLE_H__
5
6 #ifdef __DEPUTY__
7 #pragma nodeputy
8 #endif
9
10 #ifdef __SHARC__
11 #pragma nosharc
12 #endif
13
14 #include <ros/common.h>
15
16 /*****************************************************************************/
17 typedef struct hash_entry
18 {
19     void *k, *v;
20     size_t h;
21     struct hash_entry *next;
22 } hash_entry_t;
23
24 typedef struct hashtable {
25     size_t tablelength;
26     hash_entry_t **table;
27     size_t entrycount;
28     size_t loadlimit;
29     size_t primeindex;
30     size_t (*hashfn) (void *k);
31     ssize_t (*eqfn) (void *k1, void *k2);
32 } hashtable_t;
33
34 size_t hash(struct hashtable *h, void *k);
35 static inline size_t indexFor(unsigned int tablelength, unsigned int hashvalue)
36 {
37         return (hashvalue % tablelength);
38 };
39 #define freekey(X) kfree(X)
40
41 /*****************************************************************************/
42
43 /* Example of use:
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 /*****************************************************************************
100  * create_hashtable
101    
102  * @name                    create_hashtable
103  * @param   minsize         minimum initial size of hashtable
104  * @param   hashfunction    function for hashing keys
105  * @param   key_eq_fn       function for determining key equality
106  * @return                  newly created hashtable or NULL on failure
107  */
108
109 hashtable_t *
110 create_hashtable(size_t minsize,
111                  size_t (*hashfunction) (void*),
112                  ssize_t (*key_eq_fn) (void*,void*));
113
114 /*****************************************************************************
115  * hashtable_insert
116    
117  * @name        hashtable_insert
118  * @param   h   the hashtable to insert into
119  * @param   k   the key - hashtable claims ownership and will free on removal
120  * @param   v   the value - does not claim ownership
121  * @return      non-zero for successful insertion
122  *
123  * This function will cause the table to expand if the insertion would take
124  * the ratio of entries to table size over the maximum load factor.
125  *
126  * This function does not check for repeated insertions with a duplicate key.
127  * The value returned when using a duplicate key is undefined -- when
128  * the hashtable changes size, the order of retrieval of duplicate key
129  * entries is reversed.
130  * If in doubt, remove before insert.
131  */
132
133 ssize_t 
134 hashtable_insert(hashtable_t *h, void *k, void *v);
135
136 #define DEFINE_HASHTABLE_INSERT(fnname, keytype, valuetype) \
137 ssize_t fnname (hashtable_t *h, keytype *k, valuetype *v) \
138 { \
139     return hashtable_insert(h,k,v); \
140 }
141
142 /*****************************************************************************
143  * hashtable_search
144    
145  * @name        hashtable_search
146  * @param   h   the hashtable to search
147  * @param   k   the key to search for  - does not claim ownership
148  * @return      the value associated with the key, or NULL if none found
149  */
150
151 void *
152 hashtable_search(hashtable_t *h, void *k);
153
154 #define DEFINE_HASHTABLE_SEARCH(fnname, keytype, valuetype) \
155 valuetype * fnname (hashtable_t *h, keytype *k) \
156 { \
157     return (valuetype *) (hashtable_search(h,k)); \
158 }
159
160 /*****************************************************************************
161  * hashtable_remove
162    
163  * @name        hashtable_remove
164  * @param   h   the hashtable to remove the item from
165  * @param   k   the key to search for  - does not claim ownership
166  * @return      the value associated with the key, or NULL if none found
167  */
168
169 void * /* returns value */
170 hashtable_remove(hashtable_t *h, void *k);
171
172 #define DEFINE_HASHTABLE_REMOVE(fnname, keytype, valuetype) \
173 valuetype * fnname (hashtable_t *h, keytype *k) \
174 { \
175     return (valuetype *) (hashtable_remove(h,k)); \
176 }
177
178
179 /*****************************************************************************
180  * hashtable_count
181    
182  * @name        hashtable_count
183  * @param   h   the hashtable
184  * @return      the number of items stored in the hashtable
185  */
186 size_t
187 hashtable_count(hashtable_t *h);
188
189
190 /*****************************************************************************
191  * hashtable_destroy
192    
193  * @name        hashtable_destroy
194  * @param   h   the hashtable
195  * @param       free_values     whether to call 'free' on the remaining values
196  */
197
198 void
199 hashtable_destroy(hashtable_t *h, int free_values);
200
201 #endif /* __ROS_KERN_HASHTABLE_H__ */
202
203 /*
204  * Copyright (c) 2002, Christopher Clark
205  * All rights reserved.
206  * 
207  * Redistribution and use in source and binary forms, with or without
208  * modification, are permitted provided that the following conditions
209  * are met:
210  * 
211  * * Redistributions of source code must retain the above copyright
212  * notice, this list of conditions and the following disclaimer.
213  * 
214  * * Redistributions in binary form must reproduce the above copyright
215  * notice, this list of conditions and the following disclaimer in the
216  * documentation and/or other materials provided with the distribution.
217  * 
218  * * Neither the name of the original author; nor the names of any contributors
219  * may be used to endorse or promote products derived from this software
220  * without specific prior written permission.
221  * 
222  * 
223  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
224  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
225  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
226  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER
227  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
228  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
229  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
230  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
231  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
232  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
233  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
234 */