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
  42 /* Returns true if 'node' has been set to null by hmap_node_nullify() and has
  43  * not been un-nullified by being inserted into an hmap. */
  44 static inline bool
  45 hmap_node_is_null(const struct hmap_node *node)
  46 {
  47     return node->next == HMAP_NODE_NULL;
  48 }
  49
  50 /* Marks 'node' with a distinctive value that can be tested with
  51  * hmap_node_is_null().  */
  52 static inline void
  53 hmap_node_nullify(struct hmap_node *node)
  54 {
  55     node->next = HMAP_NODE_NULL;
  56 }
  57
  58 /* A hash map. */
  59 struct hmap {
  60     struct hmap_node **buckets; /* Must point to 'one' iff 'mask' == 0. */
  61     struct hmap_node *one;
  62     size_t mask;
  63     size_t n;
  64 };
  65
  66 /* Initializer for an empty hash map. */
  67 #define HMAP_INITIALIZER(HMAP) { &(HMAP)->one, NULL, 0, 0 }
  68
  69 /* Initialization. */
  70 void hmap_init(struct hmap *);
  71 void hmap_destroy(struct hmap *);
  72 void hmap_clear(struct hmap *);
  73 void hmap_swap(struct hmap *a, struct hmap *b);
  74 void hmap_moved(struct hmap *hmap);
  75 static inline size_t hmap_count(const struct hmap *);
  76 static inline bool hmap_is_empty(const struct hmap *);
  77
  78 /* Adjusting capacity. */
  79 void hmap_expand(struct hmap *);
  80 void hmap_shrink(struct hmap *);
  81 void hmap_reserve(struct hmap *, size_t capacity);
  82
  83 /* Insertion and deletion. */
  84 static inline void hmap_insert_fast(struct hmap *,
  85                                     struct hmap_node *, size_t hash);
  86 static inline void hmap_insert(struct hmap *, struct hmap_node *, size_t hash);
  87 static inline void hmap_remove(struct hmap *, struct hmap_node *);
  88
  89 void hmap_node_moved(struct hmap *, struct hmap_node *, struct hmap_node *);
  90 static inline void hmap_replace(struct hmap *, const struct hmap_node *old,
  91                                 struct hmap_node *new);
  92
  93 struct hmap_node *hmap_random_node(const struct hmap *);
  94
  95 /* Search.
  96  *
  97  * HMAP_FOR_EACH_WITH_HASH iterates NODE over all of the nodes in HMAP that
  98  * have hash value equal to HASH.  HMAP_FOR_EACH_IN_BUCKET iterates NODE over
  99  * all of the nodes in HMAP that would fall in the same bucket as HASH.  STRUCT
 100  * and MEMBER must be the name of the struct that contains the 'struct
 101  * hmap_node' and the name of the 'struct hmap_node' member, respectively.
 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, STRUCT, MEMBER, HASH, HMAP)       \
 117     for ((NODE) = CONTAINER_OF(hmap_first_with_hash(HMAP, HASH),        \
 118                                STRUCT, MEMBER);                         \
 119          &(NODE)->MEMBER != NULL;                                       \
 120          (NODE) = CONTAINER_OF(hmap_next_with_hash(&(NODE)->MEMBER),    \
 121                                STRUCT, MEMBER))
 122 #define HMAP_FOR_EACH_IN_BUCKET(NODE, STRUCT, MEMBER, HASH, HMAP)       \
 123     for ((NODE) = CONTAINER_OF(hmap_first_in_bucket(HMAP, HASH),        \
 124                                STRUCT, MEMBER);                         \
 125          &(NODE)->MEMBER != NULL;                                       \
 126          (NODE) = CONTAINER_OF(hmap_next_in_bucket(&(NODE)->MEMBER),    \
 127                                STRUCT, 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  * The _SAFE version is needed when NODE may be freed.  It is not needed when
 139  * NODE may be removed from the hash map but its members remain accessible and
 140  * intact. */
 141 #define HMAP_FOR_EACH(NODE, STRUCT, MEMBER, HMAP)                   \
 142     for ((NODE) = CONTAINER_OF(hmap_first(HMAP), STRUCT, MEMBER);   \
 143          &(NODE)->MEMBER != NULL;                                   \
 144          (NODE) = CONTAINER_OF(hmap_next(HMAP, &(NODE)->MEMBER),    \
 145                                STRUCT, MEMBER))
 146
 147 #define HMAP_FOR_EACH_SAFE(NODE, NEXT, STRUCT, MEMBER, HMAP)        \
 148     for ((NODE) = CONTAINER_OF(hmap_first(HMAP), STRUCT, MEMBER);   \
 149          (&(NODE)->MEMBER != NULL                                   \
 150           ? (NEXT) = CONTAINER_OF(hmap_next(HMAP, &(NODE)->MEMBER), \
 151                                   STRUCT, MEMBER), 1                \
 152           : 0);                                                     \
 153          (NODE) = (NEXT))
 154
 155 static inline struct hmap_node *hmap_first(const struct hmap *);
 156 static inline struct hmap_node *hmap_next(const struct hmap *,
 157                                           const struct hmap_node *);
 158
 159 /* Returns the number of nodes currently in 'hmap'. */
 160 static inline size_t
 161 hmap_count(const struct hmap *hmap)
 162 {
 163     return hmap->n;
 164 }
 165
 166 /* Returns the maximum number of nodes that 'hmap' may hold before it should be
 167  * rehashed. */
 168 static inline size_t
 169 hmap_capacity(const struct hmap *hmap)
 170 {
 171     return hmap->mask * 2 + 1;
 172 }
 173
 174 /* Returns true if 'hmap' currently contains no nodes,
 175  * false otherwise. */
 176 static inline bool
 177 hmap_is_empty(const struct hmap *hmap)
 178 {
 179     return hmap->n == 0;
 180 }
 181
 182 /* Inserts 'node', with the given 'hash', into 'hmap'.  'hmap' is never
 183  * expanded automatically. */
 184 static inline void
 185 hmap_insert_fast(struct hmap *hmap, struct hmap_node *node, size_t hash)
 186 {
 187     struct hmap_node **bucket = &hmap->buckets[hash & hmap->mask];
 188     node->hash = hash;
 189     node->next = *bucket;
 190     *bucket = node;
 191     hmap->n++;
 192 }
 193
 194 /* Inserts 'node', with the given 'hash', into 'hmap', and expands 'hmap' if
 195  * necessary to optimize search performance. */
 196 static inline void
 197 hmap_insert(struct hmap *hmap, struct hmap_node *node, size_t hash)
 198 {
 199     hmap_insert_fast(hmap, node, hash);
 200     if (hmap->n / 2 > hmap->mask) {
 201         hmap_expand(hmap);
 202     }
 203 }
 204
 205 /* Removes 'node' from 'hmap'.  Does not shrink the hash table; call
 206  * hmap_shrink() directly if desired. */
 207 static inline void
 208 hmap_remove(struct hmap *hmap, struct hmap_node *node)
 209 {
 210     struct hmap_node **bucket = &hmap->buckets[node->hash & hmap->mask];
 211     while (*bucket != node) {
 212         bucket = &(*bucket)->next;
 213     }
 214     *bucket = node->next;
 215     hmap->n--;
 216 }
 217
 218 /* Puts 'new_node' in the position in 'hmap' currently occupied by 'old_node'.
 219  * The 'new_node' must hash to the same value as 'old_node'.  The client is
 220  * responsible for ensuring that the replacement does not violate any
 221  * client-imposed invariants (e.g. uniqueness of keys within a map).
 222  *
 223  * Afterward, 'old_node' is not part of 'hmap', and the client is responsible
 224  * for freeing it (if this is desirable). */
 225 static inline void
 226 hmap_replace(struct hmap *hmap,
 227              const struct hmap_node *old_node, struct hmap_node *new_node)
 228 {
 229     struct hmap_node **bucket = &hmap->buckets[old_node->hash & hmap->mask];
 230     while (*bucket != old_node) {
 231         bucket = &(*bucket)->next;
 232     }
 233     *bucket = new_node;
 234     new_node->hash = old_node->hash;
 235     new_node->next = old_node->next;
 236 }
 237
 238 static inline struct hmap_node *
 239 hmap_next_with_hash__(const struct hmap_node *node, size_t hash)
 240 {
 241     while (node != NULL && node->hash != hash) {
 242         node = node->next;
 243     }
 244     return (struct hmap_node *) node;
 245 }
 246
 247 /* Returns the first node in 'hmap' with the given 'hash', or a null pointer if
 248  * no nodes have that hash value. */
 249 static inline struct hmap_node *
 250 hmap_first_with_hash(const struct hmap *hmap, size_t hash)
 251 {
 252     return hmap_next_with_hash__(hmap->buckets[hash & hmap->mask], hash);
 253 }
 254
 255 /* Returns the first node in 'hmap' in the bucket in which the given 'hash'
 256  * would land, or a null pointer if that bucket is empty. */
 257 static inline struct hmap_node *
 258 hmap_first_in_bucket(const struct hmap *hmap, size_t hash)
 259 {
 260     return hmap->buckets[hash & hmap->mask];
 261 }
 262
 263 /* Returns the next node in the same bucket as 'node', or a null pointer if
 264  * there are no more nodes in that bucket.
 265  *
 266  * If the hash map has been reallocated since 'node' was visited, some nodes
 267  * may be skipped; if new nodes with the same hash value have been added, they
 268  * will be skipped.  (Removing 'node' from the hash map does not prevent
 269  * calling this function, since node->next is preserved, although freeing
 270  * 'node' of course does.) */
 271 static inline struct hmap_node *
 272 hmap_next_in_bucket(const struct hmap_node *node)
 273 {
 274     return node->next;
 275 }
 276
 277 /* Returns the next node in the same hash map as 'node' with the same hash
 278  * value, or a null pointer if no more nodes have that hash value.
 279  *
 280  * If the hash map has been reallocated since 'node' was visited, some nodes
 281  * may be skipped; if new nodes with the same hash value have been added, they
 282  * will be skipped.  (Removing 'node' from the hash map does not prevent
 283  * calling this function, since node->next is preserved, although freeing
 284  * 'node' of course does.) */
 285 static inline struct hmap_node *
 286 hmap_next_with_hash(const struct hmap_node *node)
 287 {
 288     return hmap_next_with_hash__(node->next, node->hash);
 289 }
 290
 291 static inline struct hmap_node *
 292 hmap_next__(const struct hmap *hmap, size_t start)
 293 {
 294     size_t i;
 295     for (i = start; i <= hmap->mask; i++) {
 296         struct hmap_node *node = hmap->buckets[i];
 297         if (node) {
 298             return node;
 299         }
 300     }
 301     return NULL;
 302 }
 303
 304 /* Returns the first node in 'hmap', in arbitrary order, or a null pointer if
 305  * 'hmap' is empty. */
 306 static inline struct hmap_node *
 307 hmap_first(const struct hmap *hmap)
 308 {
 309     return hmap_next__(hmap, 0);
 310 }
 311
 312 /* Returns the next node in 'hmap' following 'node', in arbitrary order, or a
 313  * null pointer if 'node' is the last node in 'hmap'.
 314  *
 315  * If the hash map has been reallocated since 'node' was visited, some nodes
 316  * may be skipped or visited twice.  (Removing 'node' from the hash map does
 317  * not prevent calling this function, since node->next is preserved, although
 318  * freeing 'node' of course does.) */
 319 static inline struct hmap_node *
 320 hmap_next(const struct hmap *hmap, const struct hmap_node *node)
 321 {
 322     return (node->next
 323             ? node->next
 324             : hmap_next__(hmap, (node->hash & hmap->mask) + 1));
 325 }
 326
 327 #ifdef  __cplusplus
 328 }
 329 #endif
 330
 331 #endif /* hmap.h */