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 #include "glib.h"
  20
  21
  22 #define HASH_TABLE_MIN_SIZE 11
  23 #define HASH_TABLE_MAX_SIZE 13845163
  24
  25
  26 typedef struct _GHashNode      GHashNode;
  27
  28 struct _GHashNode
  29 {
  30   gpointer key;
  31   gpointer value;
  32   GHashNode *next;
  33 };
  34
  35 struct _GHashTable
  36 {
  37   gint size;
  38   gint nnodes;
  39   gint frozen;
  40   GHashNode **nodes;
  41   GHashFunc hash_func;
  42   GCompareFunc key_compare_func;
  43 };
  44
  45
  46 static void             g_hash_table_resize     (GHashTable     *hash_table);
  47 static GHashNode**      g_hash_table_lookup_node(GHashTable     *hash_table,
  48                                                  gconstpointer   key);
  49 static gint             g_hash_closest_prime    (gint            num);
  50 static GHashNode*       g_hash_node_new         (gpointer        key,
  51                                                  gpointer        value);
  52 static void             g_hash_node_destroy     (GHashNode      *hash_node);
  53 static void             g_hash_nodes_destroy    (GHashNode      *hash_node);
  54
  55
  56 static GMemChunk *node_mem_chunk = NULL;
  57 static GHashNode *node_free_list = NULL;
  58
  59
  60 GHashTable*
  61 g_hash_table_new (GHashFunc    hash_func,
  62                   GCompareFunc key_compare_func)
  63 {
  64   GHashTable *hash_table;
  65   gint i;
  66
  67   hash_table = g_new (GHashTable, 1);
  68   hash_table->size = HASH_TABLE_MIN_SIZE;
  69   hash_table->nnodes = 0;
  70   hash_table->frozen = FALSE;
  71   hash_table->hash_func = hash_func ? hash_func : g_direct_hash;
  72   hash_table->key_compare_func = key_compare_func;
  73   hash_table->nodes = g_new (GHashNode*, hash_table->size);
  74
  75   for (i = 0; i < hash_table->size; i++)
  76     hash_table->nodes[i] = NULL;
  77
  78   return hash_table;
  79 }
  80
  81 void
  82 g_hash_table_destroy (GHashTable *hash_table)
  83 {
  84   gint i;
  85
  86   g_return_if_fail (hash_table);
  87
  88   for (i = 0; i < hash_table->size; i++)
  89     g_hash_nodes_destroy (hash_table->nodes[i]);
  90
  91   g_free (hash_table->nodes);
  92   g_free (hash_table);
  93 }
  94
  95 void
  96 g_hash_table_insert (GHashTable *hash_table,
  97                      gpointer    key,
  98                      gpointer    value)
  99 {
 100   GHashNode **node;
 101
 102   g_return_if_fail (hash_table);
 103
 104   node = g_hash_table_lookup_node (hash_table, key);
 105
 106   if (*node)
 107     {
 108       /* do not reset node->key in this place, keeping
 109        * the old key might be intended.
 110        * a g_hash_table_remove/g_hash_table_insert pair
 111        * can be used otherwise.
 112        *
 113        * node->key = key; */
 114       (*node)->value = value;
 115     }
 116   else
 117     {
 118       *node = g_hash_node_new (key, value);
 119       hash_table->nnodes++;
 120       if (!hash_table->frozen)
 121         g_hash_table_resize (hash_table);
 122     }
 123 }
 124
 125 void
 126 g_hash_table_remove (GHashTable      *hash_table,
 127                      gconstpointer    key)
 128 {
 129   GHashNode **node, *dest;
 130
 131   g_return_if_fail (hash_table);
 132
 133   while (*(node = g_hash_table_lookup_node (hash_table, key)))
 134     {
 135       dest = *node;
 136       (*node) = dest->next;
 137       g_hash_node_destroy (dest);
 138       hash_table->nnodes--;
 139     }
 140   if (!hash_table->frozen)
 141     g_hash_table_resize (hash_table);
 142 }
 143
 144 gpointer
 145 g_hash_table_lookup (GHashTable   *hash_table,
 146                      gconstpointer key)
 147 {
 148   GHashNode *node;
 149
 150   g_return_val_if_fail (hash_table, NULL);
 151
 152   node = *g_hash_table_lookup_node (hash_table, key);
 153   return node ? node->value : NULL;
 154 }
 155
 156 gboolean
 157 g_hash_table_lookup_extended (GHashTable        *hash_table,
 158                               gconstpointer      lookup_key,
 159                               gpointer          *orig_key,
 160                               gpointer          *value)
 161 {
 162   GHashNode *node;
 163
 164   g_return_val_if_fail (hash_table, FALSE);
 165
 166   node = *g_hash_table_lookup_node (hash_table, lookup_key);
 167
 168   if (node)
 169     {
 170       if (orig_key)
 171         *orig_key = node->key;
 172       if (value)
 173         *value = node->value;
 174       return TRUE;
 175     }
 176   else
 177     return FALSE;
 178 }
 179
 180 void
 181 g_hash_table_freeze (GHashTable *hash_table)
 182 {
 183   g_return_if_fail (hash_table);
 184
 185   hash_table->frozen = TRUE;
 186 }
 187
 188 void
 189 g_hash_table_thaw (GHashTable *hash_table)
 190 {
 191   g_return_if_fail (hash_table);
 192
 193   hash_table->frozen = FALSE;
 194
 195   g_hash_table_resize (hash_table);
 196 }
 197
 198 void
 199 g_hash_table_foreach (GHashTable *hash_table,
 200                       GHFunc      func,
 201                       gpointer    user_data)
 202 {
 203   GHashNode *node;
 204   gint i;
 205
 206   g_return_if_fail (hash_table);
 207
 208   for (i = 0; i < hash_table->size; i++)
 209     for (node = hash_table->nodes[i]; node; node = node->next)
 210       (* func) (node->key, node->value, user_data);
 211 }
 212
 213 /* Returns the number of elements contained in the hash table. */
 214 gint g_hash_table_size (GHashTable *hash_table)
 215 {
 216   g_return_val_if_fail (hash_table, 0);
 217
 218   return hash_table->nnodes;
 219 }
 220
 221 static void
 222 g_hash_table_resize (GHashTable *hash_table)
 223 {
 224   GHashNode **new_nodes;
 225   GHashNode *node;
 226   GHashNode *next;
 227   gfloat nodes_per_list;
 228   guint hash_val;
 229   gint new_size;
 230   gint i;
 231
 232   g_return_if_fail (hash_table);
 233
 234   nodes_per_list = (gfloat) hash_table->nnodes / (gfloat) hash_table->size;
 235
 236   if ((nodes_per_list > 0.3 || hash_table->size <= HASH_TABLE_MIN_SIZE) &&
 237       (nodes_per_list < 3.0 || hash_table->size >= HASH_TABLE_MAX_SIZE))
 238     return;
 239
 240   new_size = CLAMP(g_hash_closest_prime (hash_table->nnodes),
 241                    HASH_TABLE_MIN_SIZE,
 242                    HASH_TABLE_MAX_SIZE);
 243   new_nodes = g_new (GHashNode*, new_size);
 244
 245   for (i = 0; i < new_size; i++)
 246     new_nodes[i] = NULL;
 247
 248   for (i = 0; i < hash_table->size; i++)
 249     for (node = hash_table->nodes[i]; node; node = next)
 250       {
 251         next = node->next;
 252         hash_val = (* hash_table->hash_func) (node->key) % new_size;
 253         node->next = new_nodes[hash_val];
 254         new_nodes[hash_val] = node;
 255       }
 256
 257   g_free (hash_table->nodes);
 258   hash_table->nodes = new_nodes;
 259   hash_table->size = new_size;
 260 }
 261
 262 static GHashNode **
 263 g_hash_table_lookup_node (GHashTable    *hash_table,
 264                           gconstpointer  key)
 265 {
 266   GHashNode **node;
 267
 268   g_return_val_if_fail (hash_table, NULL);
 269
 270   node = &hash_table->nodes
 271     [(* hash_table->hash_func) (key) % hash_table->size];
 272
 273   /* Hash table lookup needs to be fast.
 274    *  We therefore remove the extra conditional of testing
 275    *  whether to call the key_compare_func or not from
 276    *  the inner loop.
 277    */
 278   if (hash_table->key_compare_func)
 279     while (*node && !(*hash_table->key_compare_func) ((*node)->key, key))
 280       node = &(*node)->next;
 281   else
 282     while (*node && (*node)->key != key)
 283       node = &(*node)->next;
 284
 285   return node;
 286 }
 287
 288 static gint
 289 g_hash_closest_prime (gint num)
 290 {
 291   extern gint g_primes[];
 292   extern gint g_nprimes;
 293   gint i;
 294
 295   for (i = 0; i < g_nprimes; i++)
 296     if ((g_primes[i] - num) > 0)
 297       return g_primes[i];
 298
 299   return g_primes[g_nprimes - 1];
 300 }
 301
 302 static GHashNode*
 303 g_hash_node_new (gpointer key,
 304                  gpointer value)
 305 {
 306   GHashNode *hash_node;
 307
 308   if (node_free_list)
 309     {
 310       hash_node = node_free_list;
 311       node_free_list = node_free_list->next;
 312     }
 313   else
 314     {
 315       if (!node_mem_chunk)
 316         node_mem_chunk = g_mem_chunk_new ("hash node mem chunk",
 317                                           sizeof (GHashNode),
 318                                           1024, G_ALLOC_ONLY);
 319
 320       hash_node = g_chunk_new (GHashNode, node_mem_chunk);
 321     }
 322
 323   hash_node->key = key;
 324   hash_node->value = value;
 325   hash_node->next = NULL;
 326
 327   return hash_node;
 328 }
 329
 330 static void
 331 g_hash_node_destroy (GHashNode *hash_node)
 332 {
 333   g_return_if_fail (hash_node);
 334
 335   hash_node->next = node_free_list;
 336   node_free_list = hash_node;
 337 }
 338
 339 static void
 340 g_hash_nodes_destroy (GHashNode *hash_node)
 341 {
 342   GHashNode *node;
 343
 344   if (!hash_node)
 345     return;
 346
 347   node = hash_node;
 348
 349   while (node->next)
 350     node = node->next;
 351
 352   node->next = node_free_list;
 353   node_free_list = hash_node;
 354 }