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   GNUNET_HashCode kc;
 198
 199   count = 0;
 200   GNUNET_assert(map!=NULL);
 201
 202   for (i = 0; i < map->map_length; i++)
 203     {
 204       n = map->map[i];
 205       while (NULL != (e = n))
 206         {
 207           n = e->next;
 208           if (NULL != it)
 209             {
 210               kc = e->key;
 211               if (GNUNET_OK != it (it_cls, &kc, e->value))
 212                 return GNUNET_SYSERR;
 213             }
 214           count++;
 215         }
 216     }
 217   return count;
 218 }
 219
 220
 221 /**
 222  * Remove the given key-value pair from the map.  Note that if the
 223  * key-value pair is in the map multiple times, only one of the pairs
 224  * will be removed.
 225  *
 226  * @param map the map
 227  * @param key key of the key-value pair
 228  * @param value value of the key-value pair
 229  * @return GNUNET_YES on success, GNUNET_NO if the key-value pair
 230  *  is not in the map
 231  */
 232 int
 233 GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap
 234                                       *map, const GNUNET_HashCode * key,
 235                                       void *value)
 236 {
 237   struct MapEntry *e;
 238   struct MapEntry *p;
 239   unsigned int i;
 240
 241   i = idx_of (map, key);
 242   p = NULL;
 243   e = map->map[i];
 244   while (e != NULL)
 245     {
 246       if ((0 == memcmp (key, &e->key, sizeof (GNUNET_HashCode))) &&
 247           (value == e->value))
 248         {
 249           if (p == NULL)
 250             map->map[i] = e->next;
 251           else
 252             p->next = e->next;
 253           GNUNET_free (e);
 254           map->size--;
 255           return GNUNET_YES;
 256         }
 257       p = e;
 258       e = e->next;
 259     }
 260   return GNUNET_NO;
 261 }
 262
 263
 264 /**
 265  * Remove all entries for the given key from the map.
 266  * Note that the values would not be "freed".
 267  *
 268  * @param map the map
 269  * @param key identifies values to be removed
 270  * @return number of values removed
 271  */
 272 int
 273 GNUNET_CONTAINER_multihashmap_remove_all (struct GNUNET_CONTAINER_MultiHashMap
 274                                           *map, const GNUNET_HashCode * key)
 275 {
 276   struct MapEntry *e;
 277   struct MapEntry *p;
 278   unsigned int i;
 279   int ret;
 280
 281   ret = 0;
 282   i = idx_of (map, key);
 283   p = NULL;
 284   e = map->map[i];
 285   while (e != NULL)
 286     {
 287       if (0 == memcmp (key, &e->key, sizeof (GNUNET_HashCode)))
 288         {
 289           if (p == NULL)
 290             map->map[i] = e->next;
 291           else
 292             p->next = e->next;
 293           GNUNET_free (e);
 294           map->size--;
 295           if (p == NULL)
 296             e = map->map[i];
 297           else
 298             e = p->next;
 299           ret++;
 300         }
 301       else
 302         {
 303           p = e;
 304           e = e->next;
 305         }
 306     }
 307   return ret;
 308 }
 309
 310
 311 /**
 312  * Check if the map contains any value under the given
 313  * key (including values that are NULL).
 314  *
 315  * @param map the map
 316  * @param key the key to test if a value exists for it
 317  * @return GNUNET_YES if such a value exists,
 318  *         GNUNET_NO if not
 319  */
 320 int
 321 GNUNET_CONTAINER_multihashmap_contains (const struct
 322                                         GNUNET_CONTAINER_MultiHashMap *map,
 323                                         const GNUNET_HashCode * key)
 324 {
 325   struct MapEntry *e;
 326
 327   e = map->map[idx_of (map, key)];
 328   while (e != NULL)
 329     {
 330       if (0 == memcmp (key, &e->key, sizeof (GNUNET_HashCode)))
 331         return GNUNET_YES;
 332       e = e->next;
 333     }
 334   return GNUNET_NO;
 335 }
 336
 337
 338 /**
 339  * Grow the given map to a more appropriate size.
 340  *
 341  * @param map the hash map to grow
 342  */
 343 static void
 344 grow (struct GNUNET_CONTAINER_MultiHashMap *map)
 345 {
 346   struct MapEntry **old_map;
 347   struct MapEntry **new_map;
 348   struct MapEntry *e;
 349   unsigned int old_len;
 350   unsigned int new_len;
 351   unsigned int idx;
 352   unsigned int i;
 353
 354   old_map = map->map;
 355   old_len = map->map_length;
 356   new_len = old_len * 2;
 357   new_map = GNUNET_malloc (sizeof (struct MapEntry *) * new_len);
 358   map->map_length = new_len;
 359   map->map = new_map;
 360   for (i = 0; i < old_len; i++)
 361     {
 362       while (NULL != (e = old_map[i]))
 363         {
 364           old_map[i] = e->next;
 365           idx = idx_of (map, &e->key);
 366           e->next = new_map[idx];
 367           new_map[idx] = e;
 368         }
 369     }
 370   GNUNET_free (old_map);
 371 }
 372
 373
 374 /**
 375  * Store a key-value pair in the map.
 376  *
 377  * @param map the map
 378  * @param key key to use
 379  * @param value value to use
 380  * @param opt options for put
 381  * @return GNUNET_OK on success,
 382  *         GNUNET_NO if a value was replaced (with REPLACE)
 383  *         GNUNET_SYSERR if UNIQUE_ONLY was the option and the
 384  *                       value already exists
 385  */
 386 int
 387 GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap *map,
 388                                    const GNUNET_HashCode * key,
 389                                    void *value,
 390                                    enum GNUNET_CONTAINER_MultiHashMapOption
 391                                    opt)
 392 {
 393   struct MapEntry *e;
 394   unsigned int i;
 395
 396   i = idx_of (map, key);
 397   if ((opt != GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE) &&
 398       (opt != GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
 399     {
 400       e = map->map[i];
 401       while (e != NULL)
 402         {
 403           if (0 == memcmp (key, &e->key, sizeof (GNUNET_HashCode)))
 404             {
 405               if (opt == GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY)
 406                 return GNUNET_SYSERR;
 407               e->value = value;
 408               return GNUNET_NO;
 409             }
 410           e = e->next;
 411         }
 412     }
 413   if (map->size / 3 >= map->map_length / 4)
 414     {
 415       grow (map);
 416       i = idx_of (map, key);
 417     }
 418   e = GNUNET_malloc (sizeof (struct MapEntry));
 419   e->key = *key;
 420   e->value = value;
 421   e->next = map->map[i];
 422   map->map[i] = e;
 423   map->size++;
 424   return GNUNET_OK;
 425 }
 426
 427
 428 /**
 429  * Iterate over all entries in the map that match a particular key.
 430  *
 431  * @param map the map
 432  * @param key key that the entries must correspond to
 433  * @param it function to call on each entry
 434  * @param it_cls extra argument to it
 435  * @return the number of key value pairs processed,
 436  *         GNUNET_SYSERR if it aborted iteration
 437  */
 438 int
 439 GNUNET_CONTAINER_multihashmap_get_multiple (const struct
 440                                             GNUNET_CONTAINER_MultiHashMap
 441                                             *map, const GNUNET_HashCode * key,
 442                                             GNUNET_CONTAINER_HashMapIterator
 443                                             it, void *it_cls)
 444 {
 445   int count;
 446   struct MapEntry *e;
 447   struct MapEntry *n;
 448
 449   count = 0;
 450   n = map->map[idx_of (map, key)];
 451   while (NULL != (e = n))
 452     {
 453       n = e->next;
 454       if (0 != memcmp (key, &e->key, sizeof (GNUNET_HashCode)))
 455         continue;
 456       if ((it != NULL) && (GNUNET_OK != it (it_cls, key, e->value)))
 457         return GNUNET_SYSERR;
 458       count++;
 459     }
 460   return count;
 461 }
 462
 463
 464 /* end of container_multihashmap.c */