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 ((NODE) = OBJECT_CONTAINING(hmap_first_with_hash(HMAP, HASH),   \
 118                                   NODE, MEMBER);                        \
 119          &(NODE)->MEMBER != NULL;                                       \
 120          (NODE) = OBJECT_CONTAINING(hmap_next_with_hash(&(NODE)->MEMBER), \
 121                                   NODE, MEMBER))
 122 #define HMAP_FOR_EACH_IN_BUCKET(NODE, MEMBER, HASH, HMAP)               \
 123     for ((NODE) = OBJECT_CONTAINING(hmap_first_in_bucket(HMAP, HASH),   \
 124                                   NODE, MEMBER);                        \
 125          &(NODE)->MEMBER != NULL;                                       \
 126          (NODE) = OBJECT_CONTAINING(hmap_next_in_bucket(&(NODE)->MEMBER), \
 127                                NODE, MEMBER))
 128
 129 static inline struct hmap_node *hmap_first_with_hash(const struct hmap *,
 130                                                      size_t hash);
 131 static inline struct hmap_node *hmap_next_with_hash(const struct hmap_node *);
 132 static inline struct hmap_node *hmap_first_in_bucket(const struct hmap *,
 133                                                      size_t hash);
 134 static inline struct hmap_node *hmap_next_in_bucket(const struct hmap_node *);
 135
 136 /* Iteration. */
 137
 138 /* Iterates through every node in HMAP. */
 139 #define HMAP_FOR_EACH(NODE, MEMBER, HMAP)                               \
 140     for ((NODE) = OBJECT_CONTAINING(hmap_first(HMAP), NODE, MEMBER);    \
 141          &(NODE)->MEMBER != NULL;                                       \
 142          (NODE) = OBJECT_CONTAINING(hmap_next(HMAP, &(NODE)->MEMBER),   \
 143                                     NODE, MEMBER))
 144
 145 /* Safe when NODE may be freed (not needed when NODE may be removed from the
 146  * hash map but its members remain accessible and intact). */
 147 #define HMAP_FOR_EACH_SAFE(NODE, NEXT, MEMBER, HMAP)                    \
 148     for ((NODE) = OBJECT_CONTAINING(hmap_first(HMAP), NODE, MEMBER);    \
 149          (&(NODE)->MEMBER != NULL                                       \
 150           ? (NEXT) = OBJECT_CONTAINING(hmap_next(HMAP, &(NODE)->MEMBER), \
 151                                        NODE, MEMBER), 1                 \
 152           : 0);                                                         \
 153          (NODE) = (NEXT))
 154
 155 /* Continues an iteration from just after NODE. */
 156 #define HMAP_FOR_EACH_CONTINUE(NODE, MEMBER, HMAP)                      \
 157     for ((NODE) = OBJECT_CONTAINING(hmap_next(HMAP, &(NODE)->MEMBER),   \
 158                                     NODE, MEMBER);                      \
 159          &(NODE)->MEMBER != NULL;                                       \
 160          (NODE) = OBJECT_CONTAINING(hmap_next(HMAP, &(NODE)->MEMBER),   \
 161                                     NODE, MEMBER))
 162
 163 static inline struct hmap_node *hmap_first(const struct hmap *);
 164 static inline struct hmap_node *hmap_next(const struct hmap *,
 165                                           const struct hmap_node *);
 166
 167 /* Returns the number of nodes currently in 'hmap'. */
 168 static inline size_t
 169 hmap_count(const struct hmap *hmap)
 170 {
 171     return hmap->n;
 172 }
 173
 174 /* Returns the maximum number of nodes that 'hmap' may hold before it should be
 175  * rehashed. */
 176 static inline size_t
 177 hmap_capacity(const struct hmap *hmap)
 178 {
 179     return hmap->mask * 2 + 1;
 180 }
 181
 182 /* Returns true if 'hmap' currently contains no nodes,
 183  * false otherwise. */
 184 static inline bool
 185 hmap_is_empty(const struct hmap *hmap)
 186 {
 187     return hmap->n == 0;
 188 }
 189
 190 /* Inserts 'node', with the given 'hash', into 'hmap'.  'hmap' is never
 191  * expanded automatically. */
 192 static inline void
 193 hmap_insert_fast(struct hmap *hmap, struct hmap_node *node, size_t hash)
 194 {
 195     struct hmap_node **bucket = &hmap->buckets[hash & hmap->mask];
 196     node->hash = hash;
 197     node->next = *bucket;
 198     *bucket = node;
 199     hmap->n++;
 200 }
 201
 202 /* Inserts 'node', with the given 'hash', into 'hmap', and expands 'hmap' if
 203  * necessary to optimize search performance. */
 204 static inline void
 205 hmap_insert(struct hmap *hmap, struct hmap_node *node, size_t hash)
 206 {
 207     hmap_insert_fast(hmap, node, hash);
 208     if (hmap->n / 2 > hmap->mask) {
 209         hmap_expand(hmap);
 210     }
 211 }
 212
 213 /* Removes 'node' from 'hmap'.  Does not shrink the hash table; call
 214  * hmap_shrink() directly if desired. */
 215 static inline void
 216 hmap_remove(struct hmap *hmap, struct hmap_node *node)
 217 {
 218     struct hmap_node **bucket = &hmap->buckets[node->hash & hmap->mask];
 219     while (*bucket != node) {
 220         bucket = &(*bucket)->next;
 221     }
 222     *bucket = node->next;
 223     hmap->n--;
 224 }
 225
 226 /* Puts 'new_node' in the position in 'hmap' currently occupied by 'old_node'.
 227  * The 'new_node' must hash to the same value as 'old_node'.  The client is
 228  * responsible for ensuring that the replacement does not violate any
 229  * client-imposed invariants (e.g. uniqueness of keys within a map).
 230  *
 231  * Afterward, 'old_node' is not part of 'hmap', and the client is responsible
 232  * for freeing it (if this is desirable). */
 233 static inline void
 234 hmap_replace(struct hmap *hmap,
 235              const struct hmap_node *old_node, struct hmap_node *new_node)
 236 {
 237     struct hmap_node **bucket = &hmap->buckets[old_node->hash & hmap->mask];
 238     while (*bucket != old_node) {
 239         bucket = &(*bucket)->next;
 240     }
 241     *bucket = new_node;
 242     new_node->hash = old_node->hash;
 243     new_node->next = old_node->next;
 244 }
 245
 246 static inline struct hmap_node *
 247 hmap_next_with_hash__(const struct hmap_node *node, size_t hash)
 248 {
 249     while (node != NULL && node->hash != hash) {
 250         node = node->next;
 251     }
 252     return (struct hmap_node *) node;
 253 }
 254
 255 /* Returns the first node in 'hmap' with the given 'hash', or a null pointer if
 256  * no nodes have that hash value. */
 257 static inline struct hmap_node *
 258 hmap_first_with_hash(const struct hmap *hmap, size_t hash)
 259 {
 260     return hmap_next_with_hash__(hmap->buckets[hash & hmap->mask], hash);
 261 }
 262
 263 /* Returns the first node in 'hmap' in the bucket in which the given 'hash'
 264  * would land, or a null pointer if that bucket is empty. */
 265 static inline struct hmap_node *
 266 hmap_first_in_bucket(const struct hmap *hmap, size_t hash)
 267 {
 268     return hmap->buckets[hash & hmap->mask];
 269 }
 270
 271 /* Returns the next node in the same bucket as 'node', or a null pointer if
 272  * there are no more nodes in that bucket.
 273  *
 274  * If the hash map has been reallocated since 'node' was visited, some nodes
 275  * may be skipped; if new nodes with the same hash value have been added, they
 276  * will be skipped.  (Removing 'node' from the hash map does not prevent
 277  * calling this function, since node->next is preserved, although freeing
 278  * 'node' of course does.) */
 279 static inline struct hmap_node *
 280 hmap_next_in_bucket(const struct hmap_node *node)
 281 {
 282     return node->next;
 283 }
 284
 285 /* Returns the next node in the same hash map as 'node' with the same hash
 286  * value, or a null pointer if no more nodes have that hash value.
 287  *
 288  * If the hash map has been reallocated since 'node' was visited, some nodes
 289  * may be skipped; if new nodes with the same hash value have been added, they
 290  * will be skipped.  (Removing 'node' from the hash map does not prevent
 291  * calling this function, since node->next is preserved, although freeing
 292  * 'node' of course does.) */
 293 static inline struct hmap_node *
 294 hmap_next_with_hash(const struct hmap_node *node)
 295 {
 296     return hmap_next_with_hash__(node->next, node->hash);
 297 }
 298
 299 static inline struct hmap_node *
 300 hmap_next__(const struct hmap *hmap, size_t start)
 301 {
 302     size_t i;
 303     for (i = start; i <= hmap->mask; i++) {
 304         struct hmap_node *node = hmap->buckets[i];
 305         if (node) {
 306             return node;
 307         }
 308     }
 309     return NULL;
 310 }
 311
 312 /* Returns the first node in 'hmap', in arbitrary order, or a null pointer if
 313  * 'hmap' is empty. */
 314 static inline struct hmap_node *
 315 hmap_first(const struct hmap *hmap)
 316 {
 317     return hmap_next__(hmap, 0);
 318 }
 319
 320 /* Returns the next node in 'hmap' following 'node', in arbitrary order, or a
 321  * null pointer if 'node' is the last node in 'hmap'.
 322  *
 323  * If the hash map has been reallocated since 'node' was visited, some nodes
 324  * may be skipped or visited twice.  (Removing 'node' from the hash map does
 325  * not prevent calling this function, since node->next is preserved, although
 326  * freeing 'node' of course does.) */
 327 static inline struct hmap_node *
 328 hmap_next(const struct hmap *hmap, const struct hmap_node *node)
 329 {
 330     return (node->next
 331             ? node->next
 332             : hmap_next__(hmap, (node->hash & hmap->mask) + 1));
 333 }
 334
 335 #ifdef  __cplusplus
 336 }
 337 #endif
 338
 339 #endif /* hmap.h */