glib/ghash.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * MT safe
  22  */
  23
  24 #include "glib.h"
  25
  26
  27 #define HASH_TABLE_MIN_SIZE 11
  28 #define HASH_TABLE_MAX_SIZE 13845163
  29
  30
  31 typedef struct _GHashNode      GHashNode;
  32
  33 struct _GHashNode
  34 {
  35   gpointer key;
  36   gpointer value;
  37   GHashNode *next;
  38 };
  39
  40 struct _GHashTable
  41 {
  42   gint size;
  43   gint nnodes;
  44   guint frozen;
  45   GHashNode **nodes;
  46   GHashFunc hash_func;
  47   GCompareFunc key_compare_func;
  48 };
  49
  50
  51 static void             g_hash_table_resize      (GHashTable    *hash_table);
  52 static GHashNode**      g_hash_table_lookup_node (GHashTable    *hash_table,
  53                                                   gconstpointer  key);
  54 static GHashNode*       g_hash_node_new          (gpointer       key,
  55                                                   gpointer       value);
  56 static void             g_hash_node_destroy      (GHashNode     *hash_node);
  57 static void             g_hash_nodes_destroy     (GHashNode     *hash_node);
  58
  59
  60 G_LOCK_DECLARE_STATIC (g_hash_global);
  61
  62 static GMemChunk *node_mem_chunk = NULL;
  63 static GHashNode *node_free_list = NULL;
  64
  65
  66 GHashTable*
  67 g_hash_table_new (GHashFunc    hash_func,
  68                   GCompareFunc key_compare_func)
  69 {
  70   GHashTable *hash_table;
  71   guint i;
  72
  73   hash_table = g_new (GHashTable, 1);
  74   hash_table->size = HASH_TABLE_MIN_SIZE;
  75   hash_table->nnodes = 0;
  76   hash_table->frozen = FALSE;
  77   hash_table->hash_func = hash_func ? hash_func : g_direct_hash;
  78   hash_table->key_compare_func = key_compare_func;
  79   hash_table->nodes = g_new (GHashNode*, hash_table->size);
  80
  81   for (i = 0; i < hash_table->size; i++)
  82     hash_table->nodes[i] = NULL;
  83
  84   return hash_table;
  85 }
  86
  87 void
  88 g_hash_table_destroy (GHashTable *hash_table)
  89 {
  90   guint i;
  91
  92   g_return_if_fail (hash_table != NULL);
  93
  94   for (i = 0; i < hash_table->size; i++)
  95     g_hash_nodes_destroy (hash_table->nodes[i]);
  96
  97   g_free (hash_table->nodes);
  98   g_free (hash_table);
  99 }
 100
 101 static inline GHashNode**
 102 g_hash_table_lookup_node (GHashTable    *hash_table,
 103                           gconstpointer  key)
 104 {
 105   GHashNode **node;
 106
 107   node = &hash_table->nodes
 108     [(* hash_table->hash_func) (key) % hash_table->size];
 109
 110   /* Hash table lookup needs to be fast.
 111    *  We therefore remove the extra conditional of testing
 112    *  whether to call the key_compare_func or not from
 113    *  the inner loop.
 114    */
 115   if (hash_table->key_compare_func)
 116     while (*node && !(*hash_table->key_compare_func) ((*node)->key, key))
 117       node = &(*node)->next;
 118   else
 119     while (*node && (*node)->key != key)
 120       node = &(*node)->next;
 121
 122   return node;
 123 }
 124
 125 gpointer
 126 g_hash_table_lookup (GHashTable   *hash_table,
 127                      gconstpointer key)
 128 {
 129   GHashNode *node;
 130
 131   g_return_val_if_fail (hash_table != NULL, NULL);
 132
 133   node = *g_hash_table_lookup_node (hash_table, key);
 134
 135   return node ? node->value : NULL;
 136 }
 137
 138 void
 139 g_hash_table_insert (GHashTable *hash_table,
 140                      gpointer    key,
 141                      gpointer    value)
 142 {
 143   GHashNode **node;
 144
 145   g_return_if_fail (hash_table != NULL);
 146
 147   node = g_hash_table_lookup_node (hash_table, key);
 148
 149   if (*node)
 150     {
 151       /* do not reset node->key in this place, keeping
 152        * the old key might be intended.
 153        * a g_hash_table_remove/g_hash_table_insert pair
 154        * can be used otherwise.
 155        *
 156        * node->key = key; */
 157       (*node)->value = value;
 158     }
 159   else
 160     {
 161       *node = g_hash_node_new (key, value);
 162       hash_table->nnodes++;
 163       if (!hash_table->frozen)
 164         g_hash_table_resize (hash_table);
 165     }
 166 }
 167
 168 void
 169 g_hash_table_remove (GHashTable      *hash_table,
 170                      gconstpointer    key)
 171 {
 172   GHashNode **node, *dest;
 173
 174   g_return_if_fail (hash_table != NULL);
 175
 176   node = g_hash_table_lookup_node (hash_table, key);
 177
 178   if (*node)
 179     {
 180       dest = *node;
 181       (*node) = dest->next;
 182       g_hash_node_destroy (dest);
 183       hash_table->nnodes--;
 184
 185       if (!hash_table->frozen)
 186         g_hash_table_resize (hash_table);
 187     }
 188 }
 189
 190 gboolean
 191 g_hash_table_lookup_extended (GHashTable        *hash_table,
 192                               gconstpointer      lookup_key,
 193                               gpointer          *orig_key,
 194                               gpointer          *value)
 195 {
 196   GHashNode *node;
 197
 198   g_return_val_if_fail (hash_table != NULL, FALSE);
 199
 200   node = *g_hash_table_lookup_node (hash_table, lookup_key);
 201
 202   if (node)
 203     {
 204       if (orig_key)
 205         *orig_key = node->key;
 206       if (value)
 207         *value = node->value;
 208       return TRUE;
 209     }
 210   else
 211     return FALSE;
 212 }
 213
 214 void
 215 g_hash_table_freeze (GHashTable *hash_table)
 216 {
 217   g_return_if_fail (hash_table != NULL);
 218
 219   hash_table->frozen++;
 220 }
 221
 222 void
 223 g_hash_table_thaw (GHashTable *hash_table)
 224 {
 225   g_return_if_fail (hash_table != NULL);
 226
 227   if (hash_table->frozen)
 228     if (!(--hash_table->frozen))
 229       g_hash_table_resize (hash_table);
 230 }
 231
 232 gint
 233 g_hash_table_foreach_remove (GHashTable *hash_table,
 234                              GHRFunc     func,
 235                              gpointer    user_data)
 236 {
 237   GHashNode *node, *prev;
 238   guint i;
 239   gint deleted = 0;
 240
 241   g_return_val_if_fail (hash_table != NULL, 0);
 242   g_return_val_if_fail (func != NULL, 0);
 243
 244   for (i = 0; i < hash_table->size; i++)
 245     {
 246     restart:
 247
 248       prev = NULL;
 249
 250       for (node = hash_table->nodes[i]; node; prev = node, node = node->next)
 251         {
 252           if ((* func) (node->key, node->value, user_data))
 253             {
 254               deleted += 1;
 255
 256               hash_table->nnodes -= 1;
 257
 258               if (prev)
 259                 {
 260                   prev->next = node->next;
 261                   g_hash_node_destroy (node);
 262                   node = prev;
 263                 }
 264               else
 265                 {
 266                   hash_table->nodes[i] = node->next;
 267                   g_hash_node_destroy (node);
 268                   goto restart;
 269                 }
 270             }
 271         }
 272     }
 273
 274   if (!hash_table->frozen)
 275     g_hash_table_resize (hash_table);
 276
 277   return deleted;
 278 }
 279
 280 void
 281 g_hash_table_foreach (GHashTable *hash_table,
 282                       GHFunc      func,
 283                       gpointer    user_data)
 284 {
 285   GHashNode *node;
 286   gint i;
 287
 288   g_return_if_fail (hash_table != NULL);
 289   g_return_if_fail (func != NULL);
 290
 291   for (i = 0; i < hash_table->size; i++)
 292     for (node = hash_table->nodes[i]; node; node = node->next)
 293       (* func) (node->key, node->value, user_data);
 294 }
 295
 296 /* Returns the number of elements contained in the hash table. */
 297 gint
 298 g_hash_table_size (GHashTable *hash_table)
 299 {
 300   g_return_val_if_fail (hash_table != NULL, 0);
 301
 302   return hash_table->nnodes;
 303 }
 304
 305 static void
 306 g_hash_table_resize (GHashTable *hash_table)
 307 {
 308   GHashNode **new_nodes;
 309   GHashNode *node;
 310   GHashNode *next;
 311   gfloat nodes_per_list;
 312   guint hash_val;
 313   gint new_size;
 314   gint i;
 315
 316   nodes_per_list = (gfloat) hash_table->nnodes / (gfloat) hash_table->size;
 317
 318   if ((nodes_per_list > 0.3 || hash_table->size <= HASH_TABLE_MIN_SIZE) &&
 319       (nodes_per_list < 3.0 || hash_table->size >= HASH_TABLE_MAX_SIZE))
 320     return;
 321
 322   new_size = CLAMP(g_spaced_primes_closest (hash_table->nnodes),
 323                    HASH_TABLE_MIN_SIZE,
 324                    HASH_TABLE_MAX_SIZE);
 325   new_nodes = g_new0 (GHashNode*, new_size);
 326
 327   for (i = 0; i < hash_table->size; i++)
 328     for (node = hash_table->nodes[i]; node; node = next)
 329       {
 330         next = node->next;
 331
 332         hash_val = (* hash_table->hash_func) (node->key) % new_size;
 333
 334         node->next = new_nodes[hash_val];
 335         new_nodes[hash_val] = node;
 336       }
 337
 338   g_free (hash_table->nodes);
 339   hash_table->nodes = new_nodes;
 340   hash_table->size = new_size;
 341 }
 342
 343 static GHashNode*
 344 g_hash_node_new (gpointer key,
 345                  gpointer value)
 346 {
 347   GHashNode *hash_node;
 348
 349   G_LOCK (g_hash_global);
 350   if (node_free_list)
 351     {
 352       hash_node = node_free_list;
 353       node_free_list = node_free_list->next;
 354     }
 355   else
 356     {
 357       if (!node_mem_chunk)
 358         node_mem_chunk = g_mem_chunk_new ("hash node mem chunk",
 359                                           sizeof (GHashNode),
 360                                           1024, G_ALLOC_ONLY);
 361
 362       hash_node = g_chunk_new (GHashNode, node_mem_chunk);
 363     }
 364   G_UNLOCK (g_hash_global);
 365
 366   hash_node->key = key;
 367   hash_node->value = value;
 368   hash_node->next = NULL;
 369
 370   return hash_node;
 371 }
 372
 373 static void
 374 g_hash_node_destroy (GHashNode *hash_node)
 375 {
 376   G_LOCK (g_hash_global);
 377   hash_node->next = node_free_list;
 378   node_free_list = hash_node;
 379   G_UNLOCK (g_hash_global);
 380 }
 381
 382 static void
 383 g_hash_nodes_destroy (GHashNode *hash_node)
 384 {
 385   if (hash_node)
 386     {
 387       GHashNode *node = hash_node;
 388
 389       while (node->next)
 390         node = node->next;
 391
 392       G_LOCK (g_hash_global);
 393       node->next = node_free_list;
 394       node_free_list = hash_node;
 395       G_UNLOCK (g_hash_global);
 396     }
 397 }