GNUnet  0.10.x
Data Structures | Macros | Functions
container_multishortmap.c File Reference

hash map where the same key may be present multiple times More...

#include "platform.h"
#include "gnunet_util_lib.h"
Include dependency graph for container_multishortmap.c:

Go to the source code of this file.

Data Structures

struct  BigMapEntry
 An entry in the hash map with the full key. More...
 
struct  SmallMapEntry
 An entry in the hash map with just a pointer to the key. More...
 
union  MapEntry
 Entry in the map. More...
 
struct  GNUNET_CONTAINER_MultiShortmap
 Internal representation of the hash map. More...
 
struct  GNUNET_CONTAINER_MultiShortmapIterator
 Cursor into a multishortmap. More...
 

Macros

#define LOG(kind, ...)   GNUNET_log_from(kind, "util-container-multishortmap", __VA_ARGS__)
 
#define NEXT_CACHE_SIZE   16
 Maximum recursion depth for callbacks of GNUNET_CONTAINER_multihashmap_get_multiple() themselve s again calling GNUNET_CONTAINER_multihashmap_get_multiple(). More...
 

Functions

struct GNUNET_CONTAINER_MultiShortmapGNUNET_CONTAINER_multishortmap_create (unsigned int len, int do_not_copy_keys)
 Create a multi hash map. More...
 
void GNUNET_CONTAINER_multishortmap_destroy (struct GNUNET_CONTAINER_MultiShortmap *map)
 Destroy a hash map. More...
 
static unsigned int idx_of (const struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key)
 Compute the index of the bucket for the given key. More...
 
unsigned int GNUNET_CONTAINER_multishortmap_size (const struct GNUNET_CONTAINER_MultiShortmap *map)
 Get the number of key-value pairs in the map. More...
 
void * GNUNET_CONTAINER_multishortmap_get (const struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key)
 Given a key find a value in the map matching the key. More...
 
int GNUNET_CONTAINER_multishortmap_iterate (struct GNUNET_CONTAINER_MultiShortmap *map, GNUNET_CONTAINER_ShortmapIterator it, void *it_cls)
 Iterate over all entries in the map. More...
 
static void update_next_cache_bme (struct GNUNET_CONTAINER_MultiShortmap *map, const struct BigMapEntry *bme)
 We are about to free() the bme, make sure it is not in the list of next values for any iterator in the map's next_cache. More...
 
static void update_next_cache_sme (struct GNUNET_CONTAINER_MultiShortmap *map, const struct SmallMapEntry *sme)
 We are about to free() the sme, make sure it is not in the list of next values for any iterator in the map's next_cache. More...
 
int GNUNET_CONTAINER_multishortmap_remove (struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key, const void *value)
 Remove the given key-value pair from the map. More...
 
int GNUNET_CONTAINER_multishortmap_remove_all (struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key)
 Remove all entries for the given key from the map. More...
 
int GNUNET_CONTAINER_multishortmap_contains (const struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key)
 Check if the map contains any value under the given key (including values that are NULL). More...
 
int GNUNET_CONTAINER_multishortmap_contains_value (const struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key, const void *value)
 Check if the map contains the given value under the given key. More...
 
static void grow (struct GNUNET_CONTAINER_MultiShortmap *map)
 Grow the given map to a more appropriate size. More...
 
int GNUNET_CONTAINER_multishortmap_put (struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
 Store a key-value pair in the map. More...
 
int GNUNET_CONTAINER_multishortmap_get_multiple (struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key, GNUNET_CONTAINER_ShortmapIterator it, void *it_cls)
 Iterate over all entries in the map that match a particular key. More...
 
unsigned int GNUNET_CONTAINER_multishortmap_get_random (const struct GNUNET_CONTAINER_MultiShortmap *map, GNUNET_CONTAINER_ShortmapIterator it, void *it_cls)
 Call it on a random value from the map, or not at all if the map is empty. More...
 
struct GNUNET_CONTAINER_MultiShortmapIteratorGNUNET_CONTAINER_multishortmap_iterator_create (const struct GNUNET_CONTAINER_MultiShortmap *map)
 Create an iterator for a multishortmap. More...
 
int GNUNET_CONTAINER_multishortmap_iterator_next (struct GNUNET_CONTAINER_MultiShortmapIterator *iter, struct GNUNET_ShortHashCode *key, const void **value)
 Retrieve the next element from the hash map at the iterator's position. More...
 
void GNUNET_CONTAINER_multishortmap_iterator_destroy (struct GNUNET_CONTAINER_MultiShortmapIterator *iter)
 Destroy a multishortmap iterator. More...
 

Detailed Description

hash map where the same key may be present multiple times

Author
Christian Grothoff

Definition in file container_multishortmap.c.

Macro Definition Documentation

◆ LOG

#define LOG (   kind,
  ... 
)    GNUNET_log_from(kind, "util-container-multishortmap", __VA_ARGS__)

Definition at line 29 of file container_multishortmap.c.

◆ NEXT_CACHE_SIZE

#define NEXT_CACHE_SIZE   16

Maximum recursion depth for callbacks of GNUNET_CONTAINER_multihashmap_get_multiple() themselve s again calling GNUNET_CONTAINER_multihashmap_get_multiple().

Should be totally excessive, but if violated we die.

Definition at line 38 of file container_multishortmap.c.

Referenced by GNUNET_CONTAINER_multishortmap_get_multiple(), and GNUNET_CONTAINER_multishortmap_iterate().

Function Documentation

◆ idx_of()

static unsigned int idx_of ( const struct GNUNET_CONTAINER_MultiShortmap map,
const struct GNUNET_ShortHashCode key 
)
static

Compute the index of the bucket for the given key.

Parameters
maphash map for which to compute the index
keywhat key should the index be computed for
Returns
offset into the "map" array of "map"

Definition at line 263 of file container_multishortmap.c.

References GNUNET_assert, GNUNET_memcpy, and GNUNET_CONTAINER_MultiShortmap::map_length.

Referenced by GNUNET_CONTAINER_multishortmap_contains(), GNUNET_CONTAINER_multishortmap_contains_value(), GNUNET_CONTAINER_multishortmap_get(), GNUNET_CONTAINER_multishortmap_get_multiple(), GNUNET_CONTAINER_multishortmap_put(), GNUNET_CONTAINER_multishortmap_remove(), GNUNET_CONTAINER_multishortmap_remove_all(), and grow().

265 {
266  unsigned int kx;
267 
268  GNUNET_assert(NULL != map);
269  GNUNET_memcpy(&kx, key, sizeof(kx));
270  return kx % map->map_length;
271 }
unsigned int map_length
Length of the "map" array.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
Here is the caller graph for this function:

◆ update_next_cache_bme()

static void update_next_cache_bme ( struct GNUNET_CONTAINER_MultiShortmap map,
const struct BigMapEntry bme 
)
static

We are about to free() the bme, make sure it is not in the list of next values for any iterator in the map's next_cache.

Parameters
mapthe map to check
bmethe entry that is about to be free'd

Definition at line 399 of file container_multishortmap.c.

References MapEntry::bme, BigMapEntry::next, GNUNET_CONTAINER_MultiShortmap::next_cache, and GNUNET_CONTAINER_MultiShortmap::next_cache_off.

Referenced by GNUNET_CONTAINER_multishortmap_remove(), and GNUNET_CONTAINER_multishortmap_remove_all().

401 {
402  for (unsigned int i = 0; i < map->next_cache_off; i++)
403  if (map->next_cache[i].bme == bme)
404  map->next_cache[i].bme = bme->next;
405 }
struct BigMapEntry * next
If there is a hash collision, we create a linked list.
unsigned int next_cache_off
Offset of next_cache entries in use, must be smaller than NEXT_CACHE_SIZE.
union MapEntry next_cache[16]
Map entries indicating iteration positions currently in use by GNUNET_CONTAINER_multihashmap_get_mult...
struct BigMapEntry * bme
Variant used if map entries contain the full key.
Here is the caller graph for this function:

◆ update_next_cache_sme()

static void update_next_cache_sme ( struct GNUNET_CONTAINER_MultiShortmap map,
const struct SmallMapEntry sme 
)
static

We are about to free() the sme, make sure it is not in the list of next values for any iterator in the map's next_cache.

Parameters
mapthe map to check
smethe entry that is about to be free'd

Definition at line 416 of file container_multishortmap.c.

References SmallMapEntry::next, GNUNET_CONTAINER_MultiShortmap::next_cache, GNUNET_CONTAINER_MultiShortmap::next_cache_off, and MapEntry::sme.

Referenced by GNUNET_CONTAINER_multishortmap_remove(), and GNUNET_CONTAINER_multishortmap_remove_all().

418 {
419  for (unsigned int i = 0; i < map->next_cache_off; i++)
420  if (map->next_cache[i].sme == sme)
421  map->next_cache[i].sme = sme->next;
422 }
struct SmallMapEntry * next
If there is a hash collision, we create a linked list.
struct SmallMapEntry * sme
Variant used if map entries only contain a pointer to the key.
unsigned int next_cache_off
Offset of next_cache entries in use, must be smaller than NEXT_CACHE_SIZE.
union MapEntry next_cache[16]
Map entries indicating iteration positions currently in use by GNUNET_CONTAINER_multihashmap_get_mult...
Here is the caller graph for this function:

◆ grow()

static void grow ( struct GNUNET_CONTAINER_MultiShortmap map)
static

Grow the given map to a more appropriate size.

Parameters
mapthe hash map to grow

Definition at line 654 of file container_multishortmap.c.

References MapEntry::bme, GNUNET_free, GNUNET_malloc_large, idx_of(), GNUNET_CONTAINER_MultiShortmap::map, GNUNET_CONTAINER_MultiShortmap::map_length, GNUNET_CONTAINER_MultiShortmap::modification_counter, BigMapEntry::next, SmallMapEntry::next, MapEntry::sme, and GNUNET_CONTAINER_MultiShortmap::use_small_entries.

Referenced by GNUNET_CONTAINER_multishortmap_put().

655 {
656  union MapEntry *old_map;
657  union MapEntry *new_map;
658  unsigned int old_len;
659  unsigned int new_len;
660  unsigned int idx;
661 
662  old_map = map->map;
663  old_len = map->map_length;
664  new_len = old_len * 2;
665  if (0 == new_len) /* 2^31 * 2 == 0 */
666  new_len = old_len; /* never use 0 */
667  if (new_len == old_len)
668  return; /* nothing changed */
669  new_map = GNUNET_malloc_large(new_len * sizeof(union MapEntry));
670  if (NULL == new_map)
671  return; /* grow not possible */
672  map->modification_counter++;
673  map->map_length = new_len;
674  map->map = new_map;
675  for (unsigned int i = 0; i < old_len; i++)
676  {
677  if (map->use_small_entries)
678  {
679  struct SmallMapEntry *sme;
680 
681  while (NULL != (sme = old_map[i].sme))
682  {
683  old_map[i].sme = sme->next;
684  idx = idx_of(map, sme->key);
685  sme->next = new_map[idx].sme;
686  new_map[idx].sme = sme;
687  }
688  }
689  else
690  {
691  struct BigMapEntry *bme;
692 
693  while (NULL != (bme = old_map[i].bme))
694  {
695  old_map[i].bme = bme->next;
696  idx = idx_of(map, &bme->key);
697  bme->next = new_map[idx].bme;
698  new_map[idx].bme = bme;
699  }
700  }
701  }
702  GNUNET_free(old_map);
703 }
struct SmallMapEntry * next
If there is a hash collision, we create a linked list.
unsigned int map_length
Length of the "map" array.
struct SmallMapEntry * sme
Variant used if map entries only contain a pointer to the key.
#define GNUNET_malloc_large(size)
Wrapper around malloc.
struct BigMapEntry * next
If there is a hash collision, we create a linked list.
static unsigned int idx_of(const struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key)
Compute the index of the bucket for the given key.
Entry in the map.
int use_small_entries
GNUNET_NO if the map entries are of type &#39;struct BigMapEntry&#39;, GNUNET_YES if the map entries are of t...
unsigned int modification_counter
Counts the destructive modifications (grow, remove) to the map, so that iterators can check if they a...
An entry in the hash map with just a pointer to the key.
An entry in the hash map with the full key.
struct BigMapEntry * bme
Variant used if map entries contain the full key.
#define GNUNET_free(ptr)
Wrapper around free.
union MapEntry * map
All of our buckets.
Here is the call graph for this function:
Here is the caller graph for this function: