mware/hashtable.h

   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
  10  *
  11  * This file implements a portable hash table, with the following features:
  12  *
  13  * \li Open double-hashing. The maximum number of elements is fixed. The double hashing
  14  * function improves recovery in case of collisions.
  15  * \li Configurable size (which is clamped to a power of two)
  16  * \li Visiting interface through iterator (returns the element in random order).
  17  * \li The key is stored within the data and a hook is used to extract it. Optionally, it
  18  * is possible to store a copy of the key within the hash table.
  19  *
  20  * Since the hashing is open, there is no way to remove elements from the table. Instead, a
  21  * function is provided to clear the table completely.
  22  *
  23  * The data stored within the table must be a pointer. The NULL pointer is used as
  24  * a marker for a free node, so it is invalid to store a NULL pointer in the table
  25  * with \c ht_insert().
  26  *
  27  * \version $Id$
  28  *
  29  * \author Giovanni Bajo <rasky@develer.com>
  30  */
  31
  32 /*
  33  * $Log$
  34  * Revision 1.2  2004/08/04 15:52:54  rasky
  35  * Merge da SC: fixato namespace dell'include guard
  36  *
  37  * Revision 1.1  2004/07/14 14:08:16  rasky
  38  * Implementazione di una tabella hash
  39  *
  40  * Revision 1.10  2004/06/14 15:17:15  rasky
  41  * Qualche fix alla documentazione Doxygen
  42  *
  43  * Revision 1.9  2004/06/14 15:15:24  rasky
  44  * Cambiato key_data in un union invece di castare
  45  * Aggiunto un ASSERT sull'indice calcolata nella key_internal_get_ptr
  46  *
  47  * Revision 1.8  2004/06/14 14:59:40  rasky
  48  * Rinominanta la macro di configurazione per rispettare il namespace, e aggiunta in un punto in cui mancava
  49  *
  50  * Revision 1.7  2004/06/12 15:18:05  rasky
  51  * Nuova hashtable con chiave esterna o interna a scelta, come discusso
  52  *
  53  * Revision 1.6  2004/05/26 16:33:31  rasky
  54  * Aggiunta interfaccia per visita della hashtable tramite iteratori
  55  *
  56  * Revision 1.5  2004/05/24 18:42:23  rasky
  57  * Fixato un commento doxygen
  58  *
  59  * Revision 1.4  2004/05/24 15:28:20  rasky
  60  * Sistemata la documentazione, rimossa keycmp in favore della memcmp
  61  *
  62  */
  63
  64
  65 #ifndef MWARE_HASHTABLE_H
  66 #define MWARE_HASHTABLE_H
  67
  68 #include <compiler.h>
  69 #include <kdebug.h>
  70
  71 /*! Enable/disable support to declare special hash tables which maintain a copy of
  72  *  the key internally instead of relying on the hook to extract it from the data.
  73  */
  74 #define CONFIG_HT_OPTIONAL_INTERNAL_KEY      1
  75
  76 //! Maximum length of the internal key (use (2^n)-1 for slight speedup)
  77 #define INTERNAL_KEY_MAX_LENGTH     15
  78
  79 /*! Hook to get the key from \a data, which is an element of the hash table. The
  80  *  key must be returned together with \a key_length (in words).
  81  */
  82 typedef const void* (*hook_get_key)(const void* data, uint8_t* key_length);
  83
  84 /*! Hash table description
  85  *
  86  * \note This structures MUST NOT be accessed directly. Its definition is
  87  * provided in the header file only for optimization purposes (see the rationale
  88  * in hashtable.c).
  89  *
  90  * \note If new elements must be added to this list, please double check
  91  * \c DECLARE_HASHTABLE, which requires the existing elements to be at the top.
  92  */
  93 struct HashTable
  94 {
  95         const void** mem;            //!< Buckets of data
  96         uint16_t max_elts_log2;      //!< Log2 of the size of the table
  97         struct {
  98                 bool key_internal : 1;   //!< true if the key is copied internally
  99         } flags;
 100         union {
 101                 hook_get_key hook;       //!< Hook to get the key
 102                 uint8_t* mem;            //!< Pointer to the key memory
 103         } key_data;
 104 };
 105
 106 //! Iterator to walk the hash table
 107 typedef struct
 108 {
 109         const void** pos;
 110         const void** end;
 111 } HashIterator;
 112
 113 /*! Declare a hash table in the current scope
 114  *
 115  * \param name Variable name
 116  * \param size Number of elements
 117  * \param hook_gk Hook to be used to extract the key from the node
 118  *
 119  * \note The number of elements will be rounded down to the nearest
 120  * power of two.
 121  *
 122  */
 123 #define DECLARE_HASHTABLE(name, size, hook_gk) \
 124         static const void* name##_nodes[1 << UINT32_LOG2(size)]; \
 125         struct HashTable name = { name##_nodes, UINT32_LOG2(size), { false }, hook_gk }
 126
 127 /*! Exactly like \c DECLARE_HASHTABLE, but the variable will be declared as static. */
 128 #define DECLARE_HASHTABLE_STATIC(name, size, hook_gk) \
 129         static const void* name##_nodes[1 << UINT32_LOG2(size)]; \
 130         static struct HashTable name = { name##_nodes, UINT32_LOG2(size), { false }, hook_gk }
 131
 132 #if CONFIG_HT_OPTIONAL_INTERNAL_KEY
 133         /*! Declare a hash table with internal copies of the keys. This version does not
 134          *  require a hook, nor it requires the user to allocate static memory for the keys.
 135          *  It is mostly suggested for tables whose keys are computed on the fly and need
 136          *  to be stored somewhere.
 137          */
 138         #define DECLARE_HASHTABLE_INTERNALKEY(name, size) \
 139                 static uint8_t name##_keys[(1 << UINT32_LOG2(size)) * (INTERNAL_KEY_MAX_LENGTH + 1)]; \
 140                 static const void* name##_nodes[1 << UINT32_LOG2(size)]; \
 141                 struct HashTable name = { name##_nodes, UINT32_LOG2(size), { true }, name##_keys }
 142
 143         /*! Exactly like \c DECLARE_HASHTABLE_INTERNALKEY, but the variable will be declared as static. */
 144         #define DECLARE_HASHTABLE_INTERNALKEY_STATIC(name, size) \
 145                 static uint8_t name##_keys[(1 << UINT32_LOG2(size)) * (INTERNAL_KEY_MAX_LENGTH + 1)]; \
 146                 static const void* name##_nodes[1 << UINT32_LOG2(size)]; \
 147                 static struct HashTable name = { name##_nodes, UINT32_LOG2(size), { true }, name##_keys }
 148 #endif
 149
 150 /*! Initialize (and clear) a hash table in a memory buffer.
 151  *
 152  * \param ht Hash table declared with \c DECLARE_HASHTABLE
 153  *
 154  * \note This function must be called before using the hash table. Optionally,
 155  * it can be called later in the program to clear the hash table,
 156  * removing all its elements.
 157  */
 158 void ht_init(struct HashTable* ht);
 159
 160 /*! Insert an element into the hash table
 161  *
 162  * \param ht Handle of the hash table
 163  * \param data Data to be inserted into the table
 164  * \return true if insertion was successful, false otherwise (table is full)
 165  *
 166  * \note The key for the element to insert is extract from the data with
 167  * the hook. This means that this function cannot be called for hashtables
 168  * with internal keys.
 169  *
 170  * \note If an element with the same key already exists in the table,
 171  * it will be overwritten.
 172  *
 173  * \note It is not allowed to store NULL in the table. If you pass NULL as data,
 174  * the function call will fail.
 175  */
 176 bool ht_insert(struct HashTable* ht, const void* data);
 177
 178 /*! Insert an element into the hash table
 179  *
 180  * \param ht Handle of the hash table
 181  * \param key Key of the element
 182  * \param key_length Length of the key in characters
 183  * \param data Data to be inserted into the table
 184  * \return true if insertion was successful, false otherwise (table is full)
 185  *
 186  * \note If this function is called for hash table with external keys,
 187  * the key provided must be match the key that would be extracted with the
 188  * hook, otherwise the function will fail.
 189  *
 190  * \note If an element with the same key already exists in the table,
 191  * it will be overwritten.
 192  *
 193  * \note It is not allowed to store NULL in the table. If you pass NULL as data,
 194  * the function call will fail.
 195  */
 196 bool ht_insert_with_key(struct HashTable* ht, const void* key, uint8_t key_length, const void* data);
 197
 198 /*! Find an element in the hash table
 199  *
 200  * \param ht Handle of the hash table
 201  * \param key Key of the element
 202  * \param key_length Length of the key in characters
 203  * \return Data of the element, or NULL if no element was found for the given key.
 204  */
 205 const void* ht_find(struct HashTable* ht, const void* key, uint8_t key_length);
 206
 207 /*! Similar to \c ht_insert_with_key() but \a key is an ASCIIZ string */
 208 #define ht_insert_str(ht, key, data)         ht_insert_with_key(ht, key, strlen(key), data)
 209
 210 /*! Similar to \c ht_find() but \a key is an ASCIIZ string */
 211 #define ht_find_str(ht, key)                 ht_find(ht, key, strlen(key))
 212
 213 //! Get an iterator to the begin of the hash table \a ht
 214 INLINE HashIterator ht_iter_begin(struct HashTable* ht)
 215 {
 216         HashIterator h;
 217
 218         h.pos = &ht->mem[0];
 219         h.end = &ht->mem[1 << ht->max_elts_log2];
 220
 221         while (h.pos != h.end && !*h.pos)
 222                 ++h.pos;
 223
 224         return h;
 225 }
 226
 227 /*! Get an iterator to the (exclusive) end of the hash table \a ht
 228  *
 229  *  \note Like in STL, the end iterator is not a valid iterator (you
 230  *  cannot call \c ht_iter_get() on it), and it must be used only to
 231  *  detect if we reached the end of the iteration (through \c ht_iter_cmp()).
 232  */
 233 INLINE HashIterator ht_iter_end(struct HashTable* ht)
 234 {
 235         HashIterator h;
 236
 237         h.pos = h.end = &ht->mem[1 << ht->max_elts_log2];
 238
 239         return h;
 240 }
 241
 242 //! Compare \a it1 and \a it2 for equality
 243 INLINE bool ht_iter_cmp(HashIterator it1, HashIterator it2)
 244 {
 245         ASSERT(it1.end == it2.end);
 246         return it1.pos == it2.pos;
 247 }
 248
 249 //! Get the element within the hash table \a ht pointed by the iterator \a iter
 250 INLINE const void* ht_iter_get(HashIterator iter)
 251 { return *iter.pos; }
 252
 253 /*! Return an iterator pointing to the element following \a h
 254  *
 255  * \note The order of the elements visited during the iteration is casual,
 256  * and depends on the implementation.
 257  *
 258  */
 259 INLINE HashIterator ht_iter_next(HashIterator h)
 260 {
 261         ++h.pos;
 262         while (h.pos != h.end && !(*h.pos))
 263                 ++h.pos;
 264
 265         return h;
 266 }
 267
 268 #endif /* MWARE_HASHTABLE_H */