Add missing header.
[bertos.git] / mware / hashtable.c
1 /*!
2  * \file
3  * <!--
4  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
5  * Copyright 2004 Giovanni Bajo
6  * All Rights Reserved.
7  * -->
8  *
9  * \brief Portable hash table implementation
10  *
11  * Some rationales of our choices in implementation:
12  *
13  * \li For embedded systems, it is vital to allocate the table in static memory. To do
14  * so, it is necessary to expose the \c HashNode and \c HashTable structures in the header file.
15  * Nevertheless, they should be used as opaque types (that is, the users should not
16  * access the structure fields directly).
17  *
18  * \li To statically allocate the structures, a macro is provided. With this macro, we
19  * are hiding completely \c HashNode to the user (who only manipulates \c HashTable). Without
20  * the macro, the user would have had to define both the \c HashNode and the \c HashTable
21  * manually, and pass both of them to \c ht_init() (which would have created the link between
22  * the two). Instead, the link is created with a literal initialization.
23  *
24  * \li The hash table is created as power of two to remove the divisions from the code.
25  * Of course, hash functions work at their best when the table size is a prime number.
26  * When calculating the modulus to convert the hash value to an index, the actual operation
27  * becomes a bitwise AND: this is fast, but truncates the value losing bits. Thus, the higher
28  * bits are first "merged" with the lower bits through some XOR operations (see the last line of
29  * \c calc_hash()).
30  *
31  * \li To minimize the memory occupation, there is no flag to set for the empty node. An
32  * empty node is recognized by its data pointer set to NULL. It is then invalid to store
33  * NULL as data pointer in the table.
34  *
35  * \li The visiting interface through iterators is implemented with pass-by-value semantic.
36  * While this is overkill for medium-to-stupid compilers, it is the best designed from an
37  * user point of view. Moreover, being totally inlined (defined completely in the header),
38  * even a stupid compiler should be able to perform basic optimizations on it.
39  * We thought about using a pass-by-pointer semantic but it was much more awful to use, and
40  * the compiler is then forced to spill everything to the stack (unless it is *very* smart).
41  *
42  * \li The current implementation allows to either store the key internally (that is, copy
43  * the key within the hash table) or keep it external (that is, a hook is used to extract
44  * the key from the data in the node). The former is more memory-hungry of course, as it
45  * allocated static space to store the key copies. The overhead to keep both methods at
46  * the same time is minimal:
47  *    <ul>
48  *    <li>There is a run-time check in node_get_key which is execute per each node visited.</li>
49  *    <li>Theoretically, there is no memory overhead. In practice, there were no
50  *        flags in \c struct HashTable till now, so we had to add a first bit flag, but the
51  *        overhead will disappear if a second flag is added for a different reason later.</li>
52  *    <li>There is a little interface overhead, since we have two different versions of
53  *        \c ht_insert(), one with the key passed as parameter and one without, but in
54  *        the common case (external keys) both can be used.</li>
55  *    </ul>
56  *
57  * \version $Id$
58  *
59  * \author Giovanni Bajo <rasky@develer.com>
60  */
61
62 /*#*
63  *#* $Log$
64  *#* Revision 1.3  2004/10/03 20:43:22  bernie
65  *#* Import changes from sc/firmware.
66  *#*
67  *#* Revision 1.12  2004/06/14 15:15:24  rasky
68  *#* Cambiato key_data in un union invece di castare
69  *#* Aggiunto un ASSERT sull'indice calcolata nella key_internal_get_ptr
70  *#*
71  *#* Revision 1.11  2004/06/14 15:09:04  rasky
72  *#* Cambiati i messaggi di assert (è inutile citare il nome della funzione)
73  *#*
74  *#* Revision 1.10  2004/06/14 15:07:38  rasky
75  *#* Convertito il loop di calc_hash a interi (per farlo ottimizzare maggiormente)
76  *#*
77  *#* Revision 1.9  2004/06/14 14:59:40  rasky
78  *#* Rinominanta la macro di configurazione per rispettare il namespace, e aggiunta in un punto in cui mancava
79  *#*
80  *#* Revision 1.8  2004/06/12 15:18:05  rasky
81  *#* Nuova hashtable con chiave esterna o interna a scelta, come discusso
82  *#*
83  *#* Revision 1.7  2004/06/04 17:16:31  rasky
84  *#* Fixato un bug nel caso in cui la chiave ecceda la dimensione massima: il clamp non può essere fatto dentro la perform_lookup perché anche la ht_insert deve avere il valore clampato a disposizione per fare la memcpy
85  *#*
86  *#* Revision 1.6  2004/05/26 16:36:50  rasky
87  *#* Aggiunto il rationale per l'interfaccia degli iteratori
88  *#*
89  *#* Revision 1.5  2004/05/24 15:28:20  rasky
90  *#* Sistemata la documentazione, rimossa keycmp in favore della memcmp
91  *#*
92  *#*/
93
94 #include "hashtable.h"
95 #include <debug.h>
96 #include <compiler.h>
97
98 #include <string.h>
99
100
101 #define ROTATE_LEFT_16(num, count)     (((num) << (count)) | ((num) >> (16-(count))))
102 #define ROTATE_RIGHT_16(num, count)    ROTATE_LEFT_16(num, 16-(count))
103
104 typedef const void** HashNodePtr;
105 #define NODE_EMPTY(node)               (!*(node))
106 #define HT_HAS_INTERNAL_KEY(ht)        (CONFIG_HT_OPTIONAL_INTERNAL_KEY && ht->flags.key_internal)
107
108 /*! For hash tables with internal keys, compute the pointer to the internal key for a given \a node. */
109 INLINE uint8_t* key_internal_get_ptr(struct HashTable* ht, HashNodePtr node)
110 {
111         uint8_t* key_buf = ht->key_data.mem;
112         size_t index;
113
114         // Compute the index of the node and use it to move within the whole key buffer
115         index = node - &ht->mem[0];
116         ASSERT(index < (1 << ht->max_elts_log2));
117         key_buf += index * (INTERNAL_KEY_MAX_LENGTH + 1);
118
119         return key_buf;
120 }
121
122
123 INLINE void node_get_key(struct HashTable* ht, HashNodePtr node, const void** key, uint8_t* key_length)
124 {
125         if (HT_HAS_INTERNAL_KEY(ht))
126         {
127                 uint8_t* k = key_internal_get_ptr(ht, node);
128
129                 // Key has its length stored in the first byte
130                 *key_length = *k++;
131                 *key = k;
132         }
133         else
134                 *key = ht->key_data.hook(*node, key_length);
135 }
136
137
138 INLINE bool node_key_match(struct HashTable* ht, HashNodePtr node, const void* key, uint8_t key_length)
139 {
140         const void* key2;
141         uint8_t key2_length;
142
143         node_get_key(ht, node, &key2, &key2_length);
144
145         return (key_length == key2_length && memcmp(key, key2, key_length) == 0);
146 }
147
148
149 static uint16_t calc_hash(const void* _key, uint8_t key_length)
150 {
151         const char* key = (const char*)_key;
152         uint16_t hash = key_length;
153         int i;
154         int len = (int)key_length;
155
156         for (i = 0; i < len; ++i)
157                 hash = ROTATE_LEFT_16(hash, 4) ^ key[i];
158
159         return hash ^ (hash >> 6) ^ (hash >> 13);
160 }
161
162
163 static HashNodePtr perform_lookup(struct HashTable* ht,
164                                   const void* key, uint8_t key_length)
165 {
166         uint16_t hash = calc_hash(key, key_length);
167         uint16_t mask = ((1 << ht->max_elts_log2) - 1);
168         uint16_t index = hash & mask;
169         uint16_t first_index = index;
170         uint16_t step;
171         HashNodePtr node;
172
173         // Fast-path optimization: we check immediately if the current node
174         //  is the one we were looking for, so we save the computation of the
175         //  increment step in the common case.
176         node = &ht->mem[index];
177         if (NODE_EMPTY(node)
178                 || node_key_match(ht, node, key, key_length))
179                 return node;
180
181         // Increment while going through the hash table in case of collision.
182         //  This implements the double-hash technique: we use the higher part
183         //  of the hash as a step increment instead of just going to the next
184         //  element, to minimize the collisions.
185         // Notice that the number must be odd to be sure that the whole table
186         //  is traversed. Actually MCD(table_size, step) must be 1, but
187         //  table_size is always a power of 2, so we just ensure that step is
188         //  never a multiple of 2.
189         step = (ROTATE_RIGHT_16(hash, ht->max_elts_log2) & mask) | 1;
190
191         do
192         {
193                 index += step;
194                 index &= mask;
195
196                 node = &ht->mem[index];
197                 if (NODE_EMPTY(node)
198                         || node_key_match(ht, node, key, key_length))
199                         return node;
200
201                 // The check is done after the key compare. This actually causes
202                 //  one more compare in the case the table is full (since the first
203                 //  element was compared at the very start, and then at the end),
204                 //  but it makes faster the common path where we enter this loop
205                 //  for the first time, and index will not match first_index for
206                 //  sure.
207         } while (index != first_index);
208
209         return NULL;
210 }
211
212
213 void ht_init(struct HashTable* ht)
214 {
215         memset(ht->mem, 0, sizeof(ht->mem[0]) * (1 << ht->max_elts_log2));
216 }
217
218
219 static bool insert(struct HashTable* ht, const void* key, uint8_t key_length, const void* data)
220 {
221         HashNodePtr node;
222
223         if (!data)
224                 return false;
225
226         if (HT_HAS_INTERNAL_KEY(ht))
227                 key_length = MIN(key_length, INTERNAL_KEY_MAX_LENGTH);
228
229         node = perform_lookup(ht, key, key_length);
230         if (!node)
231                 return false;
232
233         if (HT_HAS_INTERNAL_KEY(ht))
234         {
235                 uint8_t* k = key_internal_get_ptr(ht, node);
236                 *k++ = key_length;
237                 memcpy(k, key, key_length);
238         }
239
240         *node = data;
241         return true;
242 }
243
244
245 bool ht_insert_with_key(struct HashTable* ht, const void* key, uint8_t key_length, const void* data)
246 {
247 #ifdef _DEBUG
248         if (!HT_HAS_INTERNAL_KEY(ht))
249         {
250                 // Construct a fake node and use it to match the key
251                 HashNodePtr node = &data;
252                 if (!node_key_match(ht, node, key, key_length))
253                 {
254                         ASSERT2(0, "parameter key is different from the external key");
255                         return false;
256                 }
257         }
258 #endif
259
260         return insert(ht, key, key_length, data);
261 }
262
263
264 bool ht_insert(struct HashTable* ht, const void* data)
265 {
266         const void* key;
267         uint8_t key_length;
268
269 #ifdef _DEBUG
270         if (HT_HAS_INTERNAL_KEY(ht))
271         {
272                 ASSERT("parameter cannot be a hash table with internal keys - use ht_insert_with_key()"
273                        && 0);
274                 return false;
275         }
276 #endif
277
278         key = ht->key_data.hook(data, &key_length);
279
280         return insert(ht, key, key_length, data);
281 }
282
283
284 const void* ht_find(struct HashTable* ht, const void* key, uint8_t key_length)
285 {
286         HashNodePtr node;
287
288         if (HT_HAS_INTERNAL_KEY(ht))
289                 key_length = MIN(key_length, INTERNAL_KEY_MAX_LENGTH);
290
291         node = perform_lookup(ht, key, key_length);
292
293         if (!node || NODE_EMPTY(node))
294                 return NULL;
295
296         return *node;
297 }
298
299
300 #if 0
301
302 #include <stdlib.h>
303
304 bool ht_test(void);
305
306 static const void* test_get_key(const void* ptr, uint8_t* length)
307 {
308         const char* s = ptr;
309         *length = strlen(s);
310         return s;
311 }
312
313 #define NUM_ELEMENTS   256
314 DECLARE_HASHTABLE_STATIC(test1, 256, test_get_key);
315 DECLARE_HASHTABLE_INTERNALKEY_STATIC(test2, 256);
316
317 static char data[NUM_ELEMENTS][10];
318 static char keydomain[] = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
319
320 static bool single_test(void)
321 {
322         int i;
323
324         ht_init(&test1);
325         ht_init(&test2);
326
327         for (i=0;i<NUM_ELEMENTS;i++)
328         {
329                 int k;
330                 int klen;
331
332                 do
333                 {
334                         klen = (rand() % 8) + 1;
335                         for (k=0;k<klen;k++)
336                                 data[i][k] = keydomain[rand() % (sizeof(keydomain)-1)];
337                         data[i][k]=0;
338                 } while (ht_find_str(&test1, data[i]) != NULL);
339
340                 ASSERT(ht_insert(&test1, data[i]));
341                 ASSERT(ht_insert_str(&test2, data[i], data[i]));
342         }
343
344         for (i=0;i<NUM_ELEMENTS;i++)
345         {
346                 char *found1, *found2;
347
348                 found1 = (char*)ht_find_str(&test1, data[i]);
349                 if (strcmp(found1, data[i]) != 0)
350                 {
351                         ASSERT(strcmp(found1,data[i]) == 0);
352                         return false;
353                 }
354
355                 found2 = (char*)ht_find_str(&test2, data[i]);
356                 if (strcmp(found2, data[i]) != 0)
357                 {
358                         ASSERT(strcmp(found2,data[i]) == 0);
359                         return false;
360                 }
361         }
362
363         return true;
364 }
365
366 static uint16_t rand_seeds[] = { 1, 42, 666, 0xDEAD, 0xBEEF, 0x1337, 0xB00B };
367
368 bool ht_test(void)
369 {
370         int i;
371
372         for (i=0;i<countof(rand_seeds);++i)
373         {
374                 srand(rand_seeds[i]);
375                 if (!single_test())
376                 {
377                         kprintf("ht_test failed\n");
378                         return false;
379                 }
380         }
381
382         kprintf("ht_test successful\n");
383         return true;
384 }
385
386 #endif