src/util/container_multihashmap.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2008 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20 /**
  21  * @file util/container_multihashmap.c
  22  * @brief hash map where the same key may be present multiple times
  23  * @author Christian Grothoff
  24  */
  25
  26 #include "platform.h"
  27 #include "gnunet_common.h"
  28 #include "gnunet_container_lib.h"
  29 #include "gnunet_crypto_lib.h"
  30
  31 /**
  32  * An entry in the hash map.
  33  */
  34 struct MapEntry
  35 {
  36
  37   /**
  38    * Key for the entry.
  39    */
  40   GNUNET_HashCode key;
  41
  42   /**
  43    * Value of the entry.
  44    */
  45   void *value;
  46
  47   /**
  48    * If there is a hash collision, we create a linked list.
  49    */
  50   struct MapEntry *next;
  51
  52 };
  53
  54 /**
  55  * Internal representation of the hash map.
  56  */
  57 struct GNUNET_CONTAINER_MultiHashMap
  58 {
  59
  60   /**
  61    * All of our buckets.
  62    */
  63   struct MapEntry **map;
  64
  65   /**
  66    * Number of entries in the map.
  67    */
  68   unsigned int size;
  69
  70   /**
  71    * Length of the "map" array.
  72    */
  73   unsigned int map_length;
  74 };
  75
  76
  77 /**
  78  * Create a multi hash map.
  79  *
  80  * @param len initial size (map will grow as needed)
  81  * @return NULL on error
  82  */
  83 struct GNUNET_CONTAINER_MultiHashMap *
  84 GNUNET_CONTAINER_multihashmap_create (unsigned int len)
  85 {
  86   struct GNUNET_CONTAINER_MultiHashMap *ret;
  87
  88   GNUNET_assert (len > 0);
  89   ret = GNUNET_malloc (sizeof (struct GNUNET_CONTAINER_MultiHashMap));
  90   ret->map = GNUNET_malloc (len * sizeof (struct MapEntry *));
  91   ret->map_length = len;
  92   return ret;
  93 }
  94
  95
  96 /**
  97  * Destroy a hash map.  Will not free any values
  98  * stored in the hash map!
  99  *
 100  * @param map the map
 101  */
 102 void
 103 GNUNET_CONTAINER_multihashmap_destroy (struct GNUNET_CONTAINER_MultiHashMap
 104                                        *map)
 105 {
 106   unsigned int i;
 107   struct MapEntry *e;
 108
 109   for (i = 0; i < map->map_length; i++)
 110     {
 111       while (NULL != (e = map->map[i]))
 112         {
 113           map->map[i] = e->next;
 114           GNUNET_free (e);
 115         }
 116     }
 117   GNUNET_free (map->map);
 118   GNUNET_free (map);
 119 }
 120
 121
 122 /**
 123  * Compute the index of the bucket for the given key.
 124  *
 125  * @param m hash map for which to compute the index
 126  * @param key what key should the index be computed for
 127  * @return offset into the "map" array of "m"
 128  */
 129 static unsigned int
 130 idx_of (const struct GNUNET_CONTAINER_MultiHashMap *m,
 131         const GNUNET_HashCode * key)
 132 {
 133   return (*(unsigned int *) key) % m->map_length;
 134 }
 135
 136
 137 /**
 138  * Get the number of key-value pairs in the map.
 139  *
 140  * @param map the map
 141  * @return the number of key value pairs
 142  */
 143 unsigned int
 144 GNUNET_CONTAINER_multihashmap_size (const struct GNUNET_CONTAINER_MultiHashMap
 145                                     *map)
 146 {
 147   return map->size;
 148 }
 149
 150
 151 /**
 152  * Given a key find a value in the map matching the key.
 153  *
 154  * @param map the map
 155  * @param key what to look for
 156  * @return NULL if no value was found; note that
 157  *   this is indistinguishable from values that just
 158  *   happen to be NULL; use "contains" to test for
 159  *   key-value pairs with value NULL
 160  */
 161 void *
 162 GNUNET_CONTAINER_multihashmap_get (const struct GNUNET_CONTAINER_MultiHashMap
 163                                    *map, const GNUNET_HashCode * key)
 164 {
 165   struct MapEntry *e;
 166
 167   e = map->map[idx_of (map, key)];
 168   while (e != NULL)
 169     {
 170       if (0 == memcmp (key, &e->key, sizeof (GNUNET_HashCode)))
 171         return e->value;
 172       e = e->next;
 173     }
 174   return NULL;
 175 }
 176
 177
 178 /**
 179  * Iterate over all entries in the map.
 180  *
 181  * @param map the map
 182  * @param it function to call on each entry
 183  * @param it_cls extra argument to it
 184  * @return the number of key value pairs processed,
 185  *         GNUNET_SYSERR if it aborted iteration
 186  */
 187 int
 188 GNUNET_CONTAINER_multihashmap_iterate (const struct
 189                                        GNUNET_CONTAINER_MultiHashMap *map,
 190                                        GNUNET_CONTAINER_HashMapIterator it,
 191                                        void *it_cls)
 192 {
 193   int count;
 194   unsigned int i;
 195   struct MapEntry *e;
 196   struct MapEntry *n;
 197
 198   count = 0;
 199   for (i = 0; i < map->map_length; i++)
 200     {
 201       n = map->map[i];
 202       while (NULL != (e = n))
 203         {
 204           n = e->next;
 205           if ((NULL != it) && (GNUNET_OK != it (it_cls, &e->key, e->value)))
 206             return GNUNET_SYSERR;
 207           count++;
 208         }
 209     }
 210   return count;
 211 }
 212
 213
 214 /**
 215  * Remove the given key-value pair from the map.  Note that if the
 216  * key-value pair is in the map multiple times, only one of the pairs
 217  * will be removed.
 218  *
 219  * @param map the map
 220  * @param key key of the key-value pair
 221  * @param value value of the key-value pair
 222  * @return GNUNET_YES on success, GNUNET_NO if the key-value pair
 223  *  is not in the map
 224  */
 225 int
 226 GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap
 227                                       *map, const GNUNET_HashCode * key,
 228                                       void *value)
 229 {
 230   struct MapEntry *e;
 231   struct MapEntry *p;
 232   unsigned int i;
 233
 234   i = idx_of (map, key);
 235   p = NULL;
 236   e = map->map[i];
 237   while (e != NULL)
 238     {
 239       if ((0 == memcmp (key, &e->key, sizeof (GNUNET_HashCode))) &&
 240           (value == e->value))
 241         {
 242           if (p == NULL)
 243             map->map[i] = e->next;
 244           else
 245             p->next = e->next;
 246           GNUNET_free (e);
 247           map->size--;
 248           return GNUNET_YES;
 249         }
 250       p = e;
 251       e = e->next;
 252     }
 253   return GNUNET_NO;
 254 }
 255
 256
 257 /**
 258  * Remove all entries for the given key from the map.
 259  * Note that the values would not be "freed".
 260  *
 261  * @param map the map
 262  * @param key identifies values to be removed
 263  * @return number of values removed
 264  */
 265 int
 266 GNUNET_CONTAINER_multihashmap_remove_all (struct GNUNET_CONTAINER_MultiHashMap
 267                                           *map, const GNUNET_HashCode * key)
 268 {
 269   struct MapEntry *e;
 270   struct MapEntry *p;
 271   unsigned int i;
 272   int ret;
 273
 274   ret = 0;
 275   i = idx_of (map, key);
 276   p = NULL;
 277   e = map->map[i];
 278   while (e != NULL)
 279     {
 280       if (0 == memcmp (key, &e->key, sizeof (GNUNET_HashCode)))
 281         {
 282           if (p == NULL)
 283             map->map[i] = e->next;
 284           else
 285             p->next = e->next;
 286           GNUNET_free (e);
 287           map->size--;
 288           if (p == NULL)
 289             e = map->map[i];
 290           else
 291             e = p->next;
 292           ret++;
 293         }
 294       else
 295         {
 296           p = e;
 297           e = e->next;
 298         }
 299     }
 300   return ret;
 301 }
 302
 303
 304 /**
 305  * Check if the map contains any value under the given
 306  * key (including values that are NULL).
 307  *
 308  * @param map the map
 309  * @param key the key to test if a value exists for it
 310  * @return GNUNET_YES if such a value exists,
 311  *         GNUNET_NO if not
 312  */
 313 int
 314 GNUNET_CONTAINER_multihashmap_contains (const struct
 315                                         GNUNET_CONTAINER_MultiHashMap *map,
 316                                         const GNUNET_HashCode * key)
 317 {
 318   struct MapEntry *e;
 319
 320   e = map->map[idx_of (map, key)];
 321   while (e != NULL)
 322     {
 323       if (0 == memcmp (key, &e->key, sizeof (GNUNET_HashCode)))
 324         return GNUNET_YES;
 325       e = e->next;
 326     }
 327   return GNUNET_NO;
 328 }
 329
 330
 331 /**
 332  * Grow the given map to a more appropriate size.
 333  *
 334  * @param map the hash map to grow
 335  */
 336 static void
 337 grow (struct GNUNET_CONTAINER_MultiHashMap *map)
 338 {
 339   struct MapEntry **old_map;
 340   struct MapEntry **new_map;
 341   struct MapEntry *e;
 342   unsigned int old_len;
 343   unsigned int new_len;
 344   unsigned int idx;
 345   unsigned int i;
 346
 347   old_map = map->map;
 348   old_len = map->map_length;
 349   new_len = old_len * 2;
 350   new_map = GNUNET_malloc (sizeof (struct MapEntry *) * new_len);
 351   map->map_length = new_len;
 352   map->map = new_map;
 353   for (i = 0; i < old_len; i++)
 354     {
 355       while (NULL != (e = old_map[i]))
 356         {
 357           old_map[i] = e->next;
 358           idx = idx_of (map, &e->key);
 359           e->next = new_map[idx];
 360           new_map[idx] = e;
 361         }
 362     }
 363   GNUNET_free (old_map);
 364 }
 365
 366
 367 /**
 368  * Store a key-value pair in the map.
 369  *
 370  * @param map the map
 371  * @param key key to use
 372  * @param value value to use
 373  * @param opt options for put
 374  * @return GNUNET_OK on success,
 375  *         GNUNET_NO if a value was replaced (with REPLACE)
 376  *         GNUNET_SYSERR if UNIQUE_ONLY was the option and the
 377  *                       value already exists
 378  */
 379 int
 380 GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap *map,
 381                                    const GNUNET_HashCode * key,
 382                                    void *value,
 383                                    enum GNUNET_CONTAINER_MultiHashMapOption
 384                                    opt)
 385 {
 386   struct MapEntry *e;
 387   unsigned int i;
 388
 389   i = idx_of (map, key);
 390   if ((opt != GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE) &&
 391       (opt != GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
 392     {
 393       e = map->map[i];
 394       while (e != NULL)
 395         {
 396           if (0 == memcmp (key, &e->key, sizeof (GNUNET_HashCode)))
 397             {
 398               if (opt == GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY)
 399                 return GNUNET_SYSERR;
 400               e->value = value;
 401               return GNUNET_NO;
 402             }
 403           e = e->next;
 404         }
 405     }
 406   if (map->size / 3 >= map->map_length / 4)
 407     {
 408       grow (map);
 409       i = idx_of (map, key);
 410     }
 411   e = GNUNET_malloc (sizeof (struct MapEntry));
 412   e->key = *key;
 413   e->value = value;
 414   e->next = map->map[i];
 415   map->map[i] = e;
 416   map->size++;
 417   return GNUNET_OK;
 418 }
 419
 420
 421 /**
 422  * Iterate over all entries in the map that match a particular key.
 423  *
 424  * @param map the map
 425  * @param key key that the entries must correspond to
 426  * @param it function to call on each entry
 427  * @param it_cls extra argument to it
 428  * @return the number of key value pairs processed,
 429  *         GNUNET_SYSERR if it aborted iteration
 430  */
 431 int
 432 GNUNET_CONTAINER_multihashmap_get_multiple (const struct
 433                                             GNUNET_CONTAINER_MultiHashMap
 434                                             *map, const GNUNET_HashCode * key,
 435                                             GNUNET_CONTAINER_HashMapIterator
 436                                             it, void *it_cls)
 437 {
 438   int count;
 439   struct MapEntry *e;
 440   struct MapEntry *n;
 441
 442   count = 0;
 443   n = map->map[idx_of (map, key)];
 444   while (NULL != (e = n))
 445     {
 446       n = e->next;
 447       if (0 != memcmp (key, &e->key, sizeof (GNUNET_HashCode)))
 448         continue;
 449       if ((it != NULL) && (GNUNET_OK != it (it_cls, &e->key, e->value)))
 450         return GNUNET_SYSERR;
 451       count++;
 452     }
 453   return count;
 454 }
 455
 456
 457 /* end of container_multihashmap.c */