get rid of SOCKTYPE and FDTYPE
[oweals/gnunet.git] / src / util / container_multihashmap32.c
index 66cc0019b6008da5578c586f1a21366f65f7adc4..f349a5f801a88d0b29477c247ef43cad5299e271 100644 (file)
@@ -1,22 +1,22 @@
 /*
      This file is part of GNUnet.
-     Copyright (C) 2008 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2008 GNUnet e.V.
 
-     GNUnet is free software; you can redistribute it and/or modify
-     it under the terms of the GNU General Public License as published
-     by the Free Software Foundation; either version 3, or (at your
-     option) any later version.
+     GNUnet is free software: you can redistribute it and/or modify it
+     under the terms of the GNU Affero General Public License as published
+     by the Free Software Foundation, either version 3 of the License,
+     or (at your option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-     General Public License for more details.
+     Affero General Public License for more details.
 
-     You should have received a copy of the GNU General Public License
-     along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-     Boston, MA 02110-1301, USA.
-*/
+     You should have received a copy of the GNU Affero General Public License
+     along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+     SPDX-License-Identifier: AGPL3.0-or-later
+ */
 /**
  * @file util/container_multihashmap32.c
  * @brief a version of hash map implemented in container_multihashmap.c but with
 #include "platform.h"
 #include "gnunet_container_lib.h"
 
-#define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
+#define LOG(kind, ...) \
+  GNUNET_log_from (kind, "util-container-multihashmap32", __VA_ARGS__)
+
+
+/**
+ * Maximum recursion depth for callbacks of
+ * #GNUNET_CONTAINER_multihashmap_get_multiple() themselves
+ * again calling #GNUNET_CONTAINER_multihashmap_get_multiple().
+ * Should be totally excessive, but if violated we die.
+ */
+#define NEXT_CACHE_SIZE 16
 
 /**
  * An entry in the hash map.
  */
 struct MapEntry
 {
-
   /**
    * Key for the entry.
    */
@@ -50,7 +59,6 @@ struct MapEntry
    * If there is a hash collision, we create a linked list.
    */
   struct MapEntry *next;
-
 };
 
 /**
@@ -58,7 +66,6 @@ struct MapEntry
  */
 struct GNUNET_CONTAINER_MultiHashMap32
 {
-
   /**
    * All of our buckets.
    */
@@ -70,7 +77,7 @@ struct GNUNET_CONTAINER_MultiHashMap32
   unsigned int size;
 
   /**
-   * Length of the "map" array.
+   * Length of the @e map array.
    */
   unsigned int map_length;
 
@@ -79,6 +86,19 @@ struct GNUNET_CONTAINER_MultiHashMap32
    * to the map, so that iterators can check if they are still valid.
    */
   unsigned int modification_counter;
+
+  /**
+   * Map entries indicating iteration positions currently
+   * in use by #GNUNET_CONTAINER_multihashmap_get_multiple().
+   * Only used up to @e next_cache_off.
+   */
+  struct MapEntry *next_cache[NEXT_CACHE_SIZE];
+
+  /**
+   * Offset of @e next_cache entries in use, must be smaller
+   * than #NEXT_CACHE_SIZE.
+   */
+  unsigned int next_cache_off;
 };
 
 
@@ -89,7 +109,7 @@ struct GNUNET_CONTAINER_MultiHashMap32
 struct GNUNET_CONTAINER_MultiHashMap32Iterator
 {
   /**
-   * Position in the bucket 'idx'
+   * Position in the bucket @e idx
    */
   struct MapEntry *me;
 
@@ -124,7 +144,12 @@ GNUNET_CONTAINER_multihashmap32_create (unsigned int len)
 
   GNUNET_assert (len > 0);
   ret = GNUNET_new (struct GNUNET_CONTAINER_MultiHashMap32);
-  ret->map = GNUNET_malloc (len * sizeof (struct MapEntry *));
+  ret->map = GNUNET_malloc_large (len * sizeof(struct MapEntry *));
+  if (NULL == ret->map)
+  {
+    GNUNET_free (ret);
+    return NULL;
+  }
   ret->map_length = len;
   return ret;
 }
@@ -137,13 +162,12 @@ GNUNET_CONTAINER_multihashmap32_create (unsigned int len)
  * @param map the map
  */
 void
-GNUNET_CONTAINER_multihashmap32_destroy (struct GNUNET_CONTAINER_MultiHashMap32
-                                         *map)
+GNUNET_CONTAINER_multihashmap32_destroy (
+  struct GNUNET_CONTAINER_MultiHashMap32 *map)
 {
-  unsigned int i;
   struct MapEntry *e;
 
-  for (i = 0; i < map->map_length; i++)
+  for (unsigned int i = 0; i < map->map_length; i++)
   {
     while (NULL != (e = map->map[i]))
     {
@@ -164,10 +188,9 @@ GNUNET_CONTAINER_multihashmap32_destroy (struct GNUNET_CONTAINER_MultiHashMap32
  * @return offset into the "map" array of "m"
  */
 static unsigned int
-idx_of (const struct GNUNET_CONTAINER_MultiHashMap32 *m,
-        const uint32_t key)
+idx_of (const struct GNUNET_CONTAINER_MultiHashMap32 *m, const uint32_t key)
 {
-  GNUNET_assert (m != NULL);
+  GNUNET_assert (NULL != m);
   return ((unsigned int) key) % m->map_length;
 }
 
@@ -179,8 +202,8 @@ idx_of (const struct GNUNET_CONTAINER_MultiHashMap32 *m,
  * @return the number of key value pairs
  */
 unsigned int
-GNUNET_CONTAINER_multihashmap32_size (const struct
-                                      GNUNET_CONTAINER_MultiHashMap32 *map)
+GNUNET_CONTAINER_multihashmap32_size (
+  const struct GNUNET_CONTAINER_MultiHashMap32 *map)
 {
   return map->size;
 }
@@ -197,14 +220,14 @@ GNUNET_CONTAINER_multihashmap32_size (const struct
  *   key-value pairs with value NULL
  */
 void *
-GNUNET_CONTAINER_multihashmap32_get (const struct
-                                     GNUNET_CONTAINER_MultiHashMap32 *map,
-                                     uint32_t key)
+GNUNET_CONTAINER_multihashmap32_get (
+  const struct GNUNET_CONTAINER_MultiHashMap32 *map,
+  uint32_t key)
 {
   struct MapEntry *e;
 
   e = map->map[idx_of (map, key)];
-  while (e != NULL)
+  while (NULL != e)
   {
     if (key == e->key)
       return e->value;
@@ -224,36 +247,59 @@ GNUNET_CONTAINER_multihashmap32_get (const struct
  *         #GNUNET_SYSERR if it aborted iteration
  */
 int
-GNUNET_CONTAINER_multihashmap32_iterate (const struct
-                                         GNUNET_CONTAINER_MultiHashMap32 *map,
-                                         GNUNET_CONTAINER_HashMapIterator32 it,
-                                         void *it_cls)
+GNUNET_CONTAINER_multihashmap32_iterate (
+  struct GNUNET_CONTAINER_MultiHashMap32 *map,
+  GNUNET_CONTAINER_MulitHashMapIterator32Callback it,
+  void *it_cls)
 {
   int count;
-  unsigned int i;
-  struct MapEntry *e;
-  struct MapEntry *n;
+  struct MapEntry **ce;
 
   count = 0;
   GNUNET_assert (NULL != map);
-  for (i = 0; i < map->map_length; i++)
+  ce = &map->next_cache[map->next_cache_off];
+  GNUNET_assert (++map->next_cache_off < NEXT_CACHE_SIZE);
+  for (unsigned int i = 0; i < map->map_length; i++)
   {
-    n = map->map[i];
-    while (NULL != (e = n))
+    struct MapEntry *e;
+
+    *ce = map->map[i];
+    while (NULL != (e = *ce))
     {
-      n = e->next;
+      *ce = e->next;
       if (NULL != it)
       {
         if (GNUNET_OK != it (it_cls, e->key, e->value))
+        {
+          GNUNET_assert (--map->next_cache_off < NEXT_CACHE_SIZE);
           return GNUNET_SYSERR;
+        }
       }
       count++;
     }
   }
+  GNUNET_assert (--map->next_cache_off < NEXT_CACHE_SIZE);
   return count;
 }
 
 
+/**
+ * We are about to free() the @a bme, make sure it is not in
+ * the list of next values for any iterator in the @a map's next_cache.
+ *
+ * @param map the map to check
+ * @param bme the entry that is about to be free'd
+ */
+static void
+update_next_cache (struct GNUNET_CONTAINER_MultiHashMap32 *map,
+                   const struct MapEntry *me)
+{
+  for (unsigned int i = 0; i < map->next_cache_off; i++)
+    if (map->next_cache[i] == me)
+      map->next_cache[i] = me->next;
+}
+
+
 /**
  * Remove the given key-value pair from the map.  Note that if the
  * key-value pair is in the map multiple times, only one of the pairs
@@ -262,13 +308,14 @@ GNUNET_CONTAINER_multihashmap32_iterate (const struct
  * @param map the map
  * @param key key of the key-value pair
  * @param value value of the key-value pair
- * @return GNUNET_YES on success, GNUNET_NO if the key-value pair
+ * @return #GNUNET_YES on success, #GNUNET_NO if the key-value pair
  *  is not in the map
  */
 int
-GNUNET_CONTAINER_multihashmap32_remove (struct GNUNET_CONTAINER_MultiHashMap32
-                                        *map,
-                                        uint32_t key, const void *value)
+GNUNET_CONTAINER_multihashmap32_remove (
+  struct GNUNET_CONTAINER_MultiHashMap32 *map,
+  uint32_t key,
+  const void *value)
 {
   struct MapEntry *e;
   struct MapEntry *p;
@@ -281,12 +328,13 @@ GNUNET_CONTAINER_multihashmap32_remove (struct GNUNET_CONTAINER_MultiHashMap32
   e = map->map[i];
   while (e != NULL)
   {
-    if ( (key == e->key) && (value == e->value) )
+    if ((key == e->key) && (value == e->value))
     {
       if (p == NULL)
         map->map[i] = e->next;
       else
         p->next = e->next;
+      update_next_cache (map, e);
       GNUNET_free (e);
       map->size--;
       return GNUNET_YES;
@@ -307,10 +355,9 @@ GNUNET_CONTAINER_multihashmap32_remove (struct GNUNET_CONTAINER_MultiHashMap32
  * @return number of values removed
  */
 int
-GNUNET_CONTAINER_multihashmap32_remove_all (struct
-                                            GNUNET_CONTAINER_MultiHashMap32
-                                            *map,
-                                            uint32_t key)
+GNUNET_CONTAINER_multihashmap32_remove_all (
+  struct GNUNET_CONTAINER_MultiHashMap32 *map,
+  uint32_t key)
 {
   struct MapEntry *e;
   struct MapEntry *p;
@@ -331,6 +378,7 @@ GNUNET_CONTAINER_multihashmap32_remove_all (struct
         map->map[i] = e->next;
       else
         p->next = e->next;
+      update_next_cache (map, e);
       GNUNET_free (e);
       map->size--;
       if (p == NULL)
@@ -355,13 +403,13 @@ GNUNET_CONTAINER_multihashmap32_remove_all (struct
  *
  * @param map the map
  * @param key the key to test if a value exists for it
- * @return GNUNET_YES if such a value exists,
- *         GNUNET_NO if not
+ * @return #GNUNET_YES if such a value exists,
+ *         #GNUNET_NO if not
  */
 int
-GNUNET_CONTAINER_multihashmap32_contains (const struct
-                                          GNUNET_CONTAINER_MultiHashMap32 *map,
-                                          uint32_t key)
+GNUNET_CONTAINER_multihashmap32_contains (
+  const struct GNUNET_CONTAINER_MultiHashMap32 *map,
+  uint32_t key)
 {
   struct MapEntry *e;
 
@@ -383,22 +431,21 @@ GNUNET_CONTAINER_multihashmap32_contains (const struct
  * @param map the map
  * @param key the key to test if a value exists for it
  * @param value value to test for
- * @return GNUNET_YES if such a value exists,
- *         GNUNET_NO if not
+ * @return #GNUNET_YES if such a value exists,
+ *         #GNUNET_NO if not
  */
 int
-GNUNET_CONTAINER_multihashmap32_contains_value (const struct
-                                                GNUNET_CONTAINER_MultiHashMap32
-                                                *map,
-                                                uint32_t key,
-                                                const void *value)
+GNUNET_CONTAINER_multihashmap32_contains_value (
+  const struct GNUNET_CONTAINER_MultiHashMap32 *map,
+  uint32_t key,
+  const void *value)
 {
   struct MapEntry *e;
 
   e = map->map[idx_of (map, key)];
   while (e != NULL)
   {
-    if ( (key == e->key) && (e->value == value) )
+    if ((key == e->key) && (e->value == value))
       return GNUNET_YES;
     e = e->next;
   }
@@ -420,17 +467,21 @@ grow (struct GNUNET_CONTAINER_MultiHashMap32 *map)
   unsigned int old_len;
   unsigned int new_len;
   unsigned int idx;
-  unsigned int i;
-
-  map->modification_counter++;
 
   old_map = map->map;
   old_len = map->map_length;
   new_len = old_len * 2;
-  new_map = GNUNET_malloc (sizeof (struct MapEntry *) * new_len);
+  if (0 == new_len) /* 2^31 * 2 == 0 */
+    new_len = old_len; /* never use 0 */
+  if (new_len == old_len)
+    return; /* nothing changed */
+  new_map = GNUNET_malloc_large (new_len * sizeof(struct MapEntry *));
+  if (NULL == new_map)
+    return; /* grow not possible */
+  map->modification_counter++;
   map->map_length = new_len;
   map->map = new_map;
-  for (i = 0; i < old_len; i++)
+  for (unsigned int i = 0; i < old_len; i++)
   {
     while (NULL != (e = old_map[i]))
     {
@@ -451,16 +502,17 @@ grow (struct GNUNET_CONTAINER_MultiHashMap32 *map)
  * @param key key to use
  * @param value value to use
  * @param opt options for put
- * @return GNUNET_OK on success,
- *         GNUNET_NO if a value was replaced (with REPLACE)
- *         GNUNET_SYSERR if UNIQUE_ONLY was the option and the
+ * @return #GNUNET_OK on success,
+ *         #GNUNET_NO if a value was replaced (with REPLACE)
+ *         #GNUNET_SYSERR if UNIQUE_ONLY was the option and the
  *                       value already exists
  */
 int
-GNUNET_CONTAINER_multihashmap32_put (struct GNUNET_CONTAINER_MultiHashMap32
-                                     *map, uint32_t key, void *value,
-                                     enum GNUNET_CONTAINER_MultiHashMapOption
-                                     opt)
+GNUNET_CONTAINER_multihashmap32_put (
+  struct GNUNET_CONTAINER_MultiHashMap32 *map,
+  uint32_t key,
+  void *value,
+  enum GNUNET_CONTAINER_MultiHashMapOption opt)
 {
   struct MapEntry *e;
   unsigned int i;
@@ -503,32 +555,39 @@ GNUNET_CONTAINER_multihashmap32_put (struct GNUNET_CONTAINER_MultiHashMap32
  * @param map the map
  * @param key key that the entries must correspond to
  * @param it function to call on each entry
- * @param it_cls extra argument to it
+ * @param it_cls extra argument to @a it
  * @return the number of key value pairs processed,
  *         GNUNET_SYSERR if it aborted iteration
  */
 int
-GNUNET_CONTAINER_multihashmap32_get_multiple (const struct
-                                              GNUNET_CONTAINER_MultiHashMap32
-                                              *map, uint32_t key,
-                                              GNUNET_CONTAINER_HashMapIterator32
-                                              it, void *it_cls)
+GNUNET_CONTAINER_multihashmap32_get_multiple (
+  struct GNUNET_CONTAINER_MultiHashMap32 *map,
+  uint32_t key,
+  GNUNET_CONTAINER_MulitHashMapIterator32Callback it,
+  void *it_cls)
 {
   int count;
   struct MapEntry *e;
-  struct MapEntry *n;
+  struct MapEntry **ce;
 
   count = 0;
-  n = map->map[idx_of (map, key)];
-  while (NULL != (e = n))
+  ce = &map->next_cache[map->next_cache_off];
+  GNUNET_assert (++map->next_cache_off < NEXT_CACHE_SIZE);
+
+  *ce = map->map[idx_of (map, key)];
+  while (NULL != (e = *ce))
   {
-    n = e->next;
+    *ce = e->next;
     if (key != e->key)
       continue;
-    if ((it != NULL) && (GNUNET_OK != it (it_cls, key, e->value)))
+    if ((NULL != it) && (GNUNET_OK != it (it_cls, key, e->value)))
+    {
+      GNUNET_assert (--map->next_cache_off < NEXT_CACHE_SIZE);
       return GNUNET_SYSERR;
+    }
     count++;
   }
+  GNUNET_assert (--map->next_cache_off < NEXT_CACHE_SIZE);
   return count;
 }
 
@@ -543,10 +602,11 @@ GNUNET_CONTAINER_multihashmap32_get_multiple (const struct
  * result in skipped or repeated elements.
  *
  * @param map the map to create an iterator for
- * @return an iterator over the given multihashmap 'map'
+ * @return an iterator over the given multihashmap @a map
  */
 struct GNUNET_CONTAINER_MultiHashMap32Iterator *
-GNUNET_CONTAINER_multihashmap32_iterator_create (const struct GNUNET_CONTAINER_MultiHashMap32 *map)
+GNUNET_CONTAINER_multihashmap32_iterator_create (
+  const struct GNUNET_CONTAINER_MultiHashMap32 *map)
 {
   struct GNUNET_CONTAINER_MultiHashMap32Iterator *iter;
 
@@ -573,9 +633,10 @@ GNUNET_CONTAINER_multihashmap32_iterator_create (const struct GNUNET_CONTAINER_M
  *         #GNUNET_NO if we are out of elements
  */
 int
-GNUNET_CONTAINER_multihashmap32_iterator_next (struct GNUNET_CONTAINER_MultiHashMap32Iterator *iter,
-                                               uint32_t *key,
-                                               const void **value)
+GNUNET_CONTAINER_multihashmap32_iterator_next (
+  struct GNUNET_CONTAINER_MultiHashMap32Iterator *iter,
+  uint32_t *key,
+  const void **value)
 {
   /* make sure the map has not been modified */
   GNUNET_assert (iter->modification_counter == iter->map->modification_counter);
@@ -607,7 +668,8 @@ GNUNET_CONTAINER_multihashmap32_iterator_next (struct GNUNET_CONTAINER_MultiHash
  * @param iter the iterator to destroy
  */
 void
-GNUNET_CONTAINER_multihashmap32_iterator_destroy (struct GNUNET_CONTAINER_MultiHashMapIterator *iter)
+GNUNET_CONTAINER_multihashmap32_iterator_destroy (
+  struct GNUNET_CONTAINER_MultiHashMapIterator *iter)
 {
   GNUNET_free (iter);
 }