lib/hmap.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef HMAP_H
  18 #define HMAP_H 1
  19
  20 #include <stdbool.h>
  21 #include <stdlib.h>
  22 #include "util.h"
  23
  24 #ifdef  __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /* A hash map node, to be embedded inside the data structure being mapped. */
  29 struct hmap_node {
  30     size_t hash;                /* Hash value. */
  31     struct hmap_node *next;     /* Next in linked list. */
  32 };
  33
  34 /* Returns the hash value embedded in 'node'. */
  35 static inline size_t hmap_node_hash(const struct hmap_node *node)
  36 {
  37     return node->hash;
  38 }
  39
  40 #define HMAP_NODE_NULL ((struct hmap_node *) 1)
  41 #define HMAP_NODE_NULL_INITIALIZER { 0, HMAP_NODE_NULL }
  42
  43 /* Returns true if 'node' has been set to null by hmap_node_nullify() and has
  44  * not been un-nullified by being inserted into an hmap. */
  45 static inline bool
  46 hmap_node_is_null(const struct hmap_node *node)
  47 {
  48     return node->next == HMAP_NODE_NULL;
  49 }
  50
  51 /* Marks 'node' with a distinctive value that can be tested with
  52  * hmap_node_is_null().  */
  53 static inline void
  54 hmap_node_nullify(struct hmap_node *node)
  55 {
  56     node->next = HMAP_NODE_NULL;
  57 }
  58
  59 /* A hash map. */
  60 struct hmap {
  61     struct hmap_node **buckets; /* Must point to 'one' iff 'mask' == 0. */
  62     struct hmap_node *one;
  63     size_t mask;
  64     size_t n;
  65 };
  66
  67 /* Initializer for an empty hash map. */
  68 #define HMAP_INITIALIZER(HMAP) { &(HMAP)->one, NULL, 0, 0 }
  69
  70 /* Initialization. */
  71 void hmap_init(struct hmap *);
  72 void hmap_destroy(struct hmap *);
  73 void hmap_clear(struct hmap *);
  74 void hmap_swap(struct hmap *a, struct hmap *b);
  75 void hmap_moved(struct hmap *hmap);
  76 static inline size_t hmap_count(const struct hmap *);
  77 static inline bool hmap_is_empty(const struct hmap *);
  78
  79 /* Adjusting capacity. */
  80 void hmap_expand(struct hmap *);
  81 void hmap_shrink(struct hmap *);
  82 void hmap_reserve(struct hmap *, size_t capacity);
  83
  84 /* Insertion and deletion. */
  85 static inline void hmap_insert_fast(struct hmap *,
  86                                     struct hmap_node *, size_t hash);
  87 static inline void hmap_insert(struct hmap *, struct hmap_node *, size_t hash);
  88 static inline void hmap_remove(struct hmap *, struct hmap_node *);
  89
  90 void hmap_node_moved(struct hmap *, struct hmap_node *, struct hmap_node *);
  91 static inline void hmap_replace(struct hmap *, const struct hmap_node *old,
  92                                 struct hmap_node *new);
  93
  94 struct hmap_node *hmap_random_node(const struct hmap *);
  95
  96 /* Search.
  97  *
  98  * HMAP_FOR_EACH_WITH_HASH iterates NODE over all of the nodes in HMAP that
  99  * have hash value equal to HASH.  HMAP_FOR_EACH_IN_BUCKET iterates NODE over
 100  * all of the nodes in HMAP that would fall in the same bucket as HASH.  MEMBER
 101  * must be the name of the 'struct hmap_node' member within NODE.
 102  *
 103  * These macros may be used interchangeably to search for a particular value in
 104  * an hmap, see, e.g. shash_find() for an example.  Usually, using
 105  * HMAP_FOR_EACH_WITH_HASH provides an optimization, because comparing a hash
 106  * value is usually cheaper than comparing an entire hash map key.  But for
 107  * simple hash map keys, it makes sense to use HMAP_FOR_EACH_IN_BUCKET because
 108  * it avoids doing two comparisons when a single simple comparison suffices.
 109  *
 110  * The loop should not change NODE to point to a different node or insert or
 111  * delete nodes in HMAP (unless it "break"s out of the loop to terminate
 112  * iteration).
 113  *
 114  * HASH is only evaluated once.
 115  */
 116 #define HMAP_FOR_EACH_WITH_HASH(NODE, MEMBER, HASH, HMAP)               \
 117     for (ASSIGN_CONTAINER(NODE, hmap_first_with_hash(HMAP, HASH), MEMBER); \
 118          &(NODE)->MEMBER != NULL;                                       \
 119          ASSIGN_CONTAINER(NODE, hmap_next_with_hash(&(NODE)->MEMBER),   \
 120                           MEMBER))
 121 #define HMAP_FOR_EACH_IN_BUCKET(NODE, MEMBER, HASH, HMAP)               \
 122     for (ASSIGN_CONTAINER(NODE, hmap_first_in_bucket(HMAP, HASH), MEMBER); \
 123          &(NODE)->MEMBER != NULL;                                       \
 124          ASSIGN_CONTAINER(NODE, hmap_next_in_bucket(&(NODE)->MEMBER), MEMBER))
 125
 126 static inline struct hmap_node *hmap_first_with_hash(const struct hmap *,
 127                                                      size_t hash);
 128 static inline struct hmap_node *hmap_next_with_hash(const struct hmap_node *);
 129 static inline struct hmap_node *hmap_first_in_bucket(const struct hmap *,
 130                                                      size_t hash);
 131 static inline struct hmap_node *hmap_next_in_bucket(const struct hmap_node *);
 132
 133 /* Iteration. */
 134
 135 /* Iterates through every node in HMAP. */
 136 #define HMAP_FOR_EACH(NODE, MEMBER, HMAP)                               \
 137     for (ASSIGN_CONTAINER(NODE, hmap_first(HMAP), MEMBER);              \
 138          &(NODE)->MEMBER != NULL;                                       \
 139          ASSIGN_CONTAINER(NODE, hmap_next(HMAP, &(NODE)->MEMBER), MEMBER))
 140
 141 /* Safe when NODE may be freed (not needed when NODE may be removed from the
 142  * hash map but its members remain accessible and intact). */
 143 #define HMAP_FOR_EACH_SAFE(NODE, NEXT, MEMBER, HMAP)                    \
 144     for (ASSIGN_CONTAINER(NODE, hmap_first(HMAP), MEMBER);              \
 145          (&(NODE)->MEMBER != NULL                                       \
 146           ? ASSIGN_CONTAINER(NEXT, hmap_next(HMAP, &(NODE)->MEMBER), MEMBER) \
 147           : 0);                                                         \
 148          (NODE) = (NEXT))
 149
 150 /* Continues an iteration from just after NODE. */
 151 #define HMAP_FOR_EACH_CONTINUE(NODE, MEMBER, HMAP)                      \
 152     for (ASSIGN_CONTAINER(NODE, hmap_next(HMAP, &(NODE)->MEMBER), MEMBER); \
 153          &(NODE)->MEMBER != NULL;                                       \
 154          ASSIGN_CONTAINER(NODE, hmap_next(HMAP, &(NODE)->MEMBER), MEMBER))
 155
 156 static inline struct hmap_node *hmap_first(const struct hmap *);
 157 static inline struct hmap_node *hmap_next(const struct hmap *,
 158                                           const struct hmap_node *);
 159
 160 /* Returns the number of nodes currently in 'hmap'. */
 161 static inline size_t
 162 hmap_count(const struct hmap *hmap)
 163 {
 164     return hmap->n;
 165 }
 166
 167 /* Returns the maximum number of nodes that 'hmap' may hold before it should be
 168  * rehashed. */
 169 static inline size_t
 170 hmap_capacity(const struct hmap *hmap)
 171 {
 172     return hmap->mask * 2 + 1;
 173 }
 174
 175 /* Returns true if 'hmap' currently contains no nodes,
 176  * false otherwise. */
 177 static inline bool
 178 hmap_is_empty(const struct hmap *hmap)
 179 {
 180     return hmap->n == 0;
 181 }
 182
 183 /* Inserts 'node', with the given 'hash', into 'hmap'.  'hmap' is never
 184  * expanded automatically. */
 185 static inline void
 186 hmap_insert_fast(struct hmap *hmap, struct hmap_node *node, size_t hash)
 187 {
 188     struct hmap_node **bucket = &hmap->buckets[hash & hmap->mask];
 189     node->hash = hash;
 190     node->next = *bucket;
 191     *bucket = node;
 192     hmap->n++;
 193 }
 194
 195 /* Inserts 'node', with the given 'hash', into 'hmap', and expands 'hmap' if
 196  * necessary to optimize search performance. */
 197 static inline void
 198 hmap_insert(struct hmap *hmap, struct hmap_node *node, size_t hash)
 199 {
 200     hmap_insert_fast(hmap, node, hash);
 201     if (hmap->n / 2 > hmap->mask) {
 202         hmap_expand(hmap);
 203     }
 204 }
 205
 206 /* Removes 'node' from 'hmap'.  Does not shrink the hash table; call
 207  * hmap_shrink() directly if desired. */
 208 static inline void
 209 hmap_remove(struct hmap *hmap, struct hmap_node *node)
 210 {
 211     struct hmap_node **bucket = &hmap->buckets[node->hash & hmap->mask];
 212     while (*bucket != node) {
 213         bucket = &(*bucket)->next;
 214     }
 215     *bucket = node->next;
 216     hmap->n--;
 217 }
 218
 219 /* Puts 'new_node' in the position in 'hmap' currently occupied by 'old_node'.
 220  * The 'new_node' must hash to the same value as 'old_node'.  The client is
 221  * responsible for ensuring that the replacement does not violate any
 222  * client-imposed invariants (e.g. uniqueness of keys within a map).
 223  *
 224  * Afterward, 'old_node' is not part of 'hmap', and the client is responsible
 225  * for freeing it (if this is desirable). */
 226 static inline void
 227 hmap_replace(struct hmap *hmap,
 228              const struct hmap_node *old_node, struct hmap_node *new_node)
 229 {
 230     struct hmap_node **bucket = &hmap->buckets[old_node->hash & hmap->mask];
 231     while (*bucket != old_node) {
 232         bucket = &(*bucket)->next;
 233     }
 234     *bucket = new_node;
 235     new_node->hash = old_node->hash;
 236     new_node->next = old_node->next;
 237 }
 238
 239 static inline struct hmap_node *
 240 hmap_next_with_hash__(const struct hmap_node *node, size_t hash)
 241 {
 242     while (node != NULL && node->hash != hash) {
 243         node = node->next;
 244     }
 245     return (struct hmap_node *) node;
 246 }
 247
 248 /* Returns the first node in 'hmap' with the given 'hash', or a null pointer if
 249  * no nodes have that hash value. */
 250 static inline struct hmap_node *
 251 hmap_first_with_hash(const struct hmap *hmap, size_t hash)
 252 {
 253     return hmap_next_with_hash__(hmap->buckets[hash & hmap->mask], hash);
 254 }
 255
 256 /* Returns the first node in 'hmap' in the bucket in which the given 'hash'
 257  * would land, or a null pointer if that bucket is empty. */
 258 static inline struct hmap_node *
 259 hmap_first_in_bucket(const struct hmap *hmap, size_t hash)
 260 {
 261     return hmap->buckets[hash & hmap->mask];
 262 }
 263
 264 /* Returns the next node in the same bucket as 'node', or a null pointer if
 265  * there are no more nodes in that bucket.
 266  *
 267  * If the hash map has been reallocated since 'node' was visited, some nodes
 268  * may be skipped; if new nodes with the same hash value have been added, they
 269  * will be skipped.  (Removing 'node' from the hash map does not prevent
 270  * calling this function, since node->next is preserved, although freeing
 271  * 'node' of course does.) */
 272 static inline struct hmap_node *
 273 hmap_next_in_bucket(const struct hmap_node *node)
 274 {
 275     return node->next;
 276 }
 277
 278 /* Returns the next node in the same hash map as 'node' with the same hash
 279  * value, or a null pointer if no more nodes have that hash value.
 280  *
 281  * If the hash map has been reallocated since 'node' was visited, some nodes
 282  * may be skipped; if new nodes with the same hash value have been added, they
 283  * will be skipped.  (Removing 'node' from the hash map does not prevent
 284  * calling this function, since node->next is preserved, although freeing
 285  * 'node' of course does.) */
 286 static inline struct hmap_node *
 287 hmap_next_with_hash(const struct hmap_node *node)
 288 {
 289     return hmap_next_with_hash__(node->next, node->hash);
 290 }
 291
 292 static inline struct hmap_node *
 293 hmap_next__(const struct hmap *hmap, size_t start)
 294 {
 295     size_t i;
 296     for (i = start; i <= hmap->mask; i++) {
 297         struct hmap_node *node = hmap->buckets[i];
 298         if (node) {
 299             return node;
 300         }
 301     }
 302     return NULL;
 303 }
 304
 305 /* Returns the first node in 'hmap', in arbitrary order, or a null pointer if
 306  * 'hmap' is empty. */
 307 static inline struct hmap_node *
 308 hmap_first(const struct hmap *hmap)
 309 {
 310     return hmap_next__(hmap, 0);
 311 }
 312
 313 /* Returns the next node in 'hmap' following 'node', in arbitrary order, or a
 314  * null pointer if 'node' is the last node in 'hmap'.
 315  *
 316  * If the hash map has been reallocated since 'node' was visited, some nodes
 317  * may be skipped or visited twice.  (Removing 'node' from the hash map does
 318  * not prevent calling this function, since node->next is preserved, although
 319  * freeing 'node' of course does.) */
 320 static inline struct hmap_node *
 321 hmap_next(const struct hmap *hmap, const struct hmap_node *node)
 322 {
 323     return (node->next
 324             ? node->next
 325             : hmap_next__(hmap, (node->hash & hmap->mask) + 1));
 326 }
 327
 328 #ifdef  __cplusplus
 329 }
 330 #endif
 331
 332 #endif /* hmap.h */