mware/hashtable.c

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright (C) 2004 Giovanni Bajo
   5  * Copyright (C) 2004 Develer S.r.l. (http://www.develer.com/)
   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.2  2004/08/25 14:12:09  rasky
  65  *#* Aggiornato il comment block dei log RCS
  66  *#*
  67  *#* Revision 1.1  2004/07/14 14:08:16  rasky
  68  *#* Implementazione di una tabella hash
  69  *#*
  70  *#* Revision 1.13  2004/07/12 16:33:36  rasky
  71  *#* Aggiunta nuova ASSERT2, con stringa di descrizione del problema (disabilitabile tramite una macro di configurazione)
  72  *#* Modificato il codice del firmware per utilizzare ASSERT2
  73  *#* Modificato il progetto in modo da disabilitare le stringhe di errore nel target xROM-xRAM
  74  *#*
  75  *#* Revision 1.12  2004/06/14 15:15:24  rasky
  76  *#* Cambiato key_data in un union invece di castare
  77  *#* Aggiunto un ASSERT sull'indice calcolata nella key_internal_get_ptr
  78  *#*
  79  *#* Revision 1.11  2004/06/14 15:09:04  rasky
  80  *#* Cambiati i messaggi di assert (è inutile citare il nome della funzione)
  81  *#*
  82  *#* Revision 1.10  2004/06/14 15:07:38  rasky
  83  *#* Convertito il loop di calc_hash a interi (per farlo ottimizzare maggiormente)
  84  *#*
  85  *#* Revision 1.9  2004/06/14 14:59:40  rasky
  86  *#* Rinominanta la macro di configurazione per rispettare il namespace, e aggiunta in un punto in cui mancava
  87  *#*
  88  *#* Revision 1.8  2004/06/12 15:18:05  rasky
  89  *#* Nuova hashtable con chiave esterna o interna a scelta, come discusso
  90  *#*
  91  *#* Revision 1.7  2004/06/04 17:16:31  rasky
  92  *#* 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
  93  *#*
  94  *#* Revision 1.6  2004/05/26 16:36:50  rasky
  95  *#* Aggiunto il rationale per l'interfaccia degli iteratori
  96  *#*
  97  *#* Revision 1.5  2004/05/24 15:28:20  rasky
  98  *#* Sistemata la documentazione, rimossa keycmp in favore della memcmp
  99  *#*
 100  *#*/
 101 #include "hashtable.h"
 102 #include <drv/kdebug.h>
 103 #include <compiler.h>
 104 #include <string.h>
 105
 106
 107 #define ROTATE_LEFT_16(num, count)     (((num) << (count)) | ((num) >> (16-(count))))
 108 #define ROTATE_RIGHT_16(num, count)    ROTATE_LEFT_16(num, 16-(count))
 109
 110 typedef const void** HashNodePtr;
 111 #define NODE_EMPTY(node)               (!*(node))
 112 #define HT_HAS_INTERNAL_KEY(ht)        (CONFIG_HT_OPTIONAL_INTERNAL_KEY && ht->flags.key_internal)
 113
 114 /*! For hash tables with internal keys, compute the pointer to the internal key for a given \a node. */
 115 INLINE uint8_t* key_internal_get_ptr(struct HashTable* ht, HashNodePtr node)
 116 {
 117         uint8_t* key_buf = ht->key_data.mem;
 118         size_t index;
 119
 120         // Compute the index of the node and use it to move within the whole key buffer
 121         index = node - &ht->mem[0];
 122         ASSERT(index < (1 << ht->max_elts_log2));
 123         key_buf += index * (INTERNAL_KEY_MAX_LENGTH + 1);
 124
 125         return key_buf;
 126 }
 127
 128
 129 INLINE void node_get_key(struct HashTable* ht, HashNodePtr node, const void** key, uint8_t* key_length)
 130 {
 131         if (HT_HAS_INTERNAL_KEY(ht))
 132         {
 133                 uint8_t* k = key_internal_get_ptr(ht, node);
 134
 135                 // Key has its length stored in the first byte
 136                 *key_length = *k++;
 137                 *key = k;
 138         }
 139         else
 140                 *key = ht->key_data.hook(*node, key_length);
 141 }
 142
 143 INLINE bool node_key_match(struct HashTable* ht, HashNodePtr node, const void* key, uint8_t key_length)
 144 {
 145         const void* key2;
 146         uint8_t key2_length;
 147
 148         node_get_key(ht, node, &key2, &key2_length);
 149
 150         return (key_length == key2_length && memcmp(key, key2, key_length) == 0);
 151 }
 152
 153 static uint16_t calc_hash(const void* _key, uint8_t key_length)
 154 {
 155         const char* key = (const char*)_key;
 156         uint16_t hash = key_length;
 157         int i;
 158         int len = (int)key_length;
 159
 160         for (i = 0; i < len; ++i)
 161                 hash = ROTATE_LEFT_16(hash, 4) ^ key[i];
 162
 163         return hash ^ (hash >> 6) ^ (hash >> 13);
 164 }
 165
 166 static HashNodePtr perform_lookup(struct HashTable* ht,
 167                                   const void* key, uint8_t key_length)
 168 {
 169         uint16_t hash = calc_hash(key, key_length);
 170         uint16_t mask = ((1 << ht->max_elts_log2) - 1);
 171         uint16_t index = hash & mask;
 172         uint16_t first_index = index;
 173         uint16_t step;
 174         HashNodePtr node;
 175
 176         // Fast-path optimization: we check immediately if the current node
 177         //  is the one we were looking for, so we save the computation of the
 178         //  increment step in the common case.
 179         node = &ht->mem[index];
 180         if (NODE_EMPTY(node)
 181                 || node_key_match(ht, node, key, key_length))
 182                 return node;
 183
 184         // Increment while going through the hash table in case of collision.
 185         //  This implements the double-hash technique: we use the higher part
 186         //  of the hash as a step increment instead of just going to the next
 187         //  element, to minimize the collisions.
 188         // Notice that the number must be odd to be sure that the whole table
 189         //  is traversed. Actually MCD(table_size, step) must be 1, but
 190         //  table_size is always a power of 2, so we just ensure that step is
 191         //  never a multiple of 2.
 192         step = (ROTATE_RIGHT_16(hash, ht->max_elts_log2) & mask) | 1;
 193
 194         do
 195         {
 196                 index += step;
 197                 index &= mask;
 198
 199                 node = &ht->mem[index];
 200                 if (NODE_EMPTY(node)
 201                         || node_key_match(ht, node, key, key_length))
 202                         return node;
 203
 204                 // The check is done after the key compare. This actually causes
 205                 //  one more compare in the case the table is full (since the first
 206                 //  element was compared at the very start, and then at the end),
 207                 //  but it makes faster the common path where we enter this loop
 208                 //  for the first time, and index will not match first_index for
 209                 //  sure.
 210         } while (index != first_index);
 211
 212         return NULL;
 213 }
 214
 215 void ht_init(struct HashTable* ht)
 216 {
 217         memset(ht->mem, 0, sizeof(ht->mem[0]) * (1 << ht->max_elts_log2));
 218 }
 219
 220 static bool insert(struct HashTable* ht, const void* key, uint8_t key_length, const void* data)
 221 {
 222         HashNodePtr node;
 223
 224         if (!data)
 225                 return false;
 226
 227         if (HT_HAS_INTERNAL_KEY(ht))
 228                 key_length = MIN(key_length, INTERNAL_KEY_MAX_LENGTH);
 229
 230         node = perform_lookup(ht, key, key_length);
 231         if (!node)
 232                 return false;
 233
 234         if (HT_HAS_INTERNAL_KEY(ht))
 235         {
 236                 uint8_t* k = key_internal_get_ptr(ht, node);
 237                 *k++ = key_length;
 238                 memcpy(k, key, key_length);
 239         }
 240
 241         *node = data;
 242         return true;
 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 bool ht_insert(struct HashTable* ht, const void* data)
 264 {
 265         const void* key;
 266         uint8_t key_length;
 267
 268 #ifdef _DEBUG
 269         if (HT_HAS_INTERNAL_KEY(ht))
 270         {
 271                 ASSERT("parameter cannot be a hash table with internal keys - use ht_insert_with_key()"
 272                        && 0);
 273                 return false;
 274         }
 275 #endif
 276
 277         key = ht->key_data.hook(data, &key_length);
 278
 279         return insert(ht, key, key_length, data);
 280 }
 281
 282 const void* ht_find(struct HashTable* ht, const void* key, uint8_t key_length)
 283 {
 284         HashNodePtr node;
 285
 286         if (HT_HAS_INTERNAL_KEY(ht))
 287                 key_length = MIN(key_length, INTERNAL_KEY_MAX_LENGTH);
 288
 289         node = perform_lookup(ht, key, key_length);
 290
 291         if (!node || NODE_EMPTY(node))
 292                 return NULL;
 293
 294         return *node;
 295 }
 296
 297
 298 #if 0
 299
 300 #include <stdlib.h>
 301
 302 bool ht_test(void);
 303
 304 static const void* test_get_key(const void* ptr, uint8_t* length)
 305 {
 306         const char* s = ptr;
 307         *length = strlen(s);
 308         return s;
 309 }
 310
 311 #define NUM_ELEMENTS   256
 312 DECLARE_HASHTABLE_STATIC(test1, 256, test_get_key);
 313 DECLARE_HASHTABLE_INTERNALKEY_STATIC(test2, 256);
 314
 315 static char data[NUM_ELEMENTS][10];
 316 static char keydomain[] = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
 317
 318 static bool single_test(void)
 319 {
 320         int i;
 321
 322         ht_init(&test1);
 323         ht_init(&test2);
 324
 325         for (i=0;i<NUM_ELEMENTS;i++)
 326         {
 327                 int k;
 328                 int klen;
 329
 330                 do
 331                 {
 332                         klen = (rand() % 8) + 1;
 333                         for (k=0;k<klen;k++)
 334                                 data[i][k] = keydomain[rand() % (sizeof(keydomain)-1)];
 335                         data[i][k]=0;
 336                 } while (ht_find_str(&test1, data[i]) != NULL);
 337
 338                 ASSERT(ht_insert(&test1, data[i]));
 339                 ASSERT(ht_insert_str(&test2, data[i], data[i]));
 340         }
 341
 342         for (i=0;i<NUM_ELEMENTS;i++)
 343         {
 344                 char *found1, *found2;
 345
 346                 found1 = (char*)ht_find_str(&test1, data[i]);
 347                 if (strcmp(found1, data[i]) != 0)
 348                 {
 349                         ASSERT(strcmp(found1,data[i]) == 0);
 350                         return false;
 351                 }
 352
 353                 found2 = (char*)ht_find_str(&test2, data[i]);
 354                 if (strcmp(found2, data[i]) != 0)
 355                 {
 356                         ASSERT(strcmp(found2,data[i]) == 0);
 357                         return false;
 358                 }
 359         }
 360
 361         return true;
 362 }
 363
 364 static uint16_t rand_seeds[] = { 1, 42, 666, 0xDEAD, 0xBEEF, 0x1337, 0xB00B };
 365
 366 bool ht_test(void)
 367 {
 368         int i;
 369
 370         for (i=0;i<countof(rand_seeds);++i)
 371         {
 372                 srand(rand_seeds[i]);
 373                 if (!single_test())
 374                 {
 375                         kprintf("ht_test failed\n");
 376                         return false;
 377                 }
 378         }
 379
 380         kprintf("ht_test successful\n");
 381         return true;
 382 }
 383
 384 #endif