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_swap(struct hmap *a, struct hmap *b);
  73 void hmap_moved(struct hmap *hmap);
  74 static inline size_t hmap_count(const struct hmap *);
  75 static inline bool hmap_is_empty(const struct hmap *);
  76
  77 /* Adjusting capacity. */
  78 void hmap_expand(struct hmap *);
  79 void hmap_shrink(struct hmap *);
  80 void hmap_reserve(struct hmap *, size_t capacity);
  81
  82 /* Insertion and deletion. */
  83 static inline void hmap_insert_fast(struct hmap *,
  84                                     struct hmap_node *, size_t hash);
  85 static inline void hmap_insert(struct hmap *, struct hmap_node *, size_t hash);
  86 static inline void hmap_remove(struct hmap *, struct hmap_node *);
  87
  88 void hmap_node_moved(struct hmap *, struct hmap_node *, struct hmap_node *);
  89 static inline void hmap_replace(struct hmap *, const struct hmap_node *old,
  90                                 struct hmap_node *new);
  91
  92 /* Search.
  93  *
  94  * HMAP_FOR_EACH_WITH_HASH iterates NODE over all of the nodes in HMAP that
  95  * have hash value equal to HASH.  HMAP_FOR_EACH_IN_BUCKET iterates NODE over
  96  * all of the nodes in HMAP that would fall in the same bucket as HASH.  STRUCT
  97  * and MEMBER must be the name of the struct that contains the 'struct
  98  * hmap_node' and the name of the 'struct hmap_node' member, respectively.
  99  *
 100  * These macros may be used interchangeably to search for a particular value in
 101  * an hmap, see, e.g. shash_find() for an example.  Usually, using
 102  * HMAP_FOR_EACH_WITH_HASH provides an optimization, because comparing a hash
 103  * value is usually cheaper than comparing an entire hash map key.  But for
 104  * simple hash map keys, it makes sense to use HMAP_FOR_EACH_IN_BUCKET because
 105  * it avoids doing two comparisons when a single simple comparison suffices.
 106  *
 107  * The loop should not change NODE to point to a different node or insert or
 108  * delete nodes in HMAP (unless it "break"s out of the loop to terminate
 109  * iteration).
 110  *
 111  * HASH is only evaluated once.
 112  */
 113 #define HMAP_FOR_EACH_WITH_HASH(NODE, STRUCT, MEMBER, HASH, HMAP)       \
 114     for ((NODE) = CONTAINER_OF(hmap_first_with_hash(HMAP, HASH),        \
 115                                STRUCT, MEMBER);                         \
 116          &(NODE)->MEMBER != NULL;                                       \
 117          (NODE) = CONTAINER_OF(hmap_next_with_hash(&(NODE)->MEMBER),    \
 118                                STRUCT, MEMBER))
 119 #define HMAP_FOR_EACH_IN_BUCKET(NODE, STRUCT, MEMBER, HASH, HMAP)       \
 120     for ((NODE) = CONTAINER_OF(hmap_first_in_bucket(HMAP, HASH),        \
 121                                STRUCT, MEMBER);                         \
 122          &(NODE)->MEMBER != NULL;                                       \
 123          (NODE) = CONTAINER_OF(hmap_next_in_bucket(&(NODE)->MEMBER),    \
 124                                STRUCT, 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  * The _SAFE version is needed when NODE may be freed.  It is not needed when
 136  * NODE may be removed from the hash map but its members remain accessible and
 137  * intact. */
 138 #define HMAP_FOR_EACH(NODE, STRUCT, MEMBER, HMAP)                   \
 139     for ((NODE) = CONTAINER_OF(hmap_first(HMAP), STRUCT, MEMBER);   \
 140          &(NODE)->MEMBER != NULL;                                   \
 141          (NODE) = CONTAINER_OF(hmap_next(HMAP, &(NODE)->MEMBER),    \
 142                                STRUCT, MEMBER))
 143
 144 #define HMAP_FOR_EACH_SAFE(NODE, NEXT, STRUCT, MEMBER, HMAP)        \
 145     for ((NODE) = CONTAINER_OF(hmap_first(HMAP), STRUCT, MEMBER);   \
 146          (&(NODE)->MEMBER != NULL                                   \
 147           ? (NEXT) = CONTAINER_OF(hmap_next(HMAP, &(NODE)->MEMBER), \
 148                                   STRUCT, MEMBER), 1                \
 149           : 0);                                                     \
 150          (NODE) = (NEXT))
 151
 152 static inline struct hmap_node *hmap_first(const struct hmap *);
 153 static inline struct hmap_node *hmap_next(const struct hmap *,
 154                                           const struct hmap_node *);
 155
 156 /* Returns the number of nodes currently in 'hmap'. */
 157 static inline size_t
 158 hmap_count(const struct hmap *hmap)
 159 {
 160     return hmap->n;
 161 }
 162
 163 /* Returns the maximum number of nodes that 'hmap' may hold before it should be
 164  * rehashed. */
 165 static inline size_t
 166 hmap_capacity(const struct hmap *hmap)
 167 {
 168     return hmap->mask * 2 + 1;
 169 }
 170
 171 /* Returns true if 'hmap' currently contains no nodes,
 172  * false otherwise. */
 173 static inline bool
 174 hmap_is_empty(const struct hmap *hmap)
 175 {
 176     return hmap->n == 0;
 177 }
 178
 179 /* Inserts 'node', with the given 'hash', into 'hmap'.  'hmap' is never
 180  * expanded automatically. */
 181 static inline void
 182 hmap_insert_fast(struct hmap *hmap, struct hmap_node *node, size_t hash)
 183 {
 184     struct hmap_node **bucket = &hmap->buckets[hash & hmap->mask];
 185     node->hash = hash;
 186     node->next = *bucket;
 187     *bucket = node;
 188     hmap->n++;
 189 }
 190
 191 /* Inserts 'node', with the given 'hash', into 'hmap', and expands 'hmap' if
 192  * necessary to optimize search performance. */
 193 static inline void
 194 hmap_insert(struct hmap *hmap, struct hmap_node *node, size_t hash)
 195 {
 196     hmap_insert_fast(hmap, node, hash);
 197     if (hmap->n / 2 > hmap->mask) {
 198         hmap_expand(hmap);
 199     }
 200 }
 201
 202 /* Removes 'node' from 'hmap'.  Does not shrink the hash table; call
 203  * hmap_shrink() directly if desired. */
 204 static inline void
 205 hmap_remove(struct hmap *hmap, struct hmap_node *node)
 206 {
 207     struct hmap_node **bucket = &hmap->buckets[node->hash & hmap->mask];
 208     while (*bucket != node) {
 209         bucket = &(*bucket)->next;
 210     }
 211     *bucket = node->next;
 212     hmap->n--;
 213 }
 214
 215 /* Puts 'new_node' in the position in 'hmap' currently occupied by 'old_node'.
 216  * The 'new_node' must hash to the same value as 'old_node'.  The client is
 217  * responsible for ensuring that the replacement does not violate any
 218  * client-imposed invariants (e.g. uniqueness of keys within a map).
 219  *
 220  * Afterward, 'old_node' is not part of 'hmap', and the client is responsible
 221  * for freeing it (if this is desirable). */
 222 static inline void
 223 hmap_replace(struct hmap *hmap,
 224              const struct hmap_node *old_node, struct hmap_node *new_node)
 225 {
 226     struct hmap_node **bucket = &hmap->buckets[old_node->hash & hmap->mask];
 227     while (*bucket != old_node) {
 228         bucket = &(*bucket)->next;
 229     }
 230     *bucket = new_node;
 231     new_node->hash = old_node->hash;
 232     new_node->next = old_node->next;
 233 }
 234
 235 static inline struct hmap_node *
 236 hmap_next_with_hash__(const struct hmap_node *node, size_t hash)
 237 {
 238     while (node != NULL && node->hash != hash) {
 239         node = node->next;
 240     }
 241     return (struct hmap_node *) node;
 242 }
 243
 244 /* Returns the first node in 'hmap' with the given 'hash', or a null pointer if
 245  * no nodes have that hash value. */
 246 static inline struct hmap_node *
 247 hmap_first_with_hash(const struct hmap *hmap, size_t hash)
 248 {
 249     return hmap_next_with_hash__(hmap->buckets[hash & hmap->mask], hash);
 250 }
 251
 252 /* Returns the first node in 'hmap' in the bucket in which the given 'hash'
 253  * would land, or a null pointer if that bucket is empty. */
 254 static inline struct hmap_node *
 255 hmap_first_in_bucket(const struct hmap *hmap, size_t hash)
 256 {
 257     return hmap->buckets[hash & hmap->mask];
 258 }
 259
 260 /* Returns the next node in the same bucket as 'node', or a null pointer if
 261  * there are no more nodes in that bucket.
 262  *
 263  * If the hash map has been reallocated since 'node' was visited, some nodes
 264  * may be skipped; if new nodes with the same hash value have been added, they
 265  * will be skipped.  (Removing 'node' from the hash map does not prevent
 266  * calling this function, since node->next is preserved, although freeing
 267  * 'node' of course does.) */
 268 static inline struct hmap_node *
 269 hmap_next_in_bucket(const struct hmap_node *node)
 270 {
 271     return node->next;
 272 }
 273
 274 /* Returns the next node in the same hash map as 'node' with the same hash
 275  * value, or a null pointer if no more nodes have that hash value.
 276  *
 277  * If the hash map has been reallocated since 'node' was visited, some nodes
 278  * may be skipped; if new nodes with the same hash value have been added, they
 279  * will be skipped.  (Removing 'node' from the hash map does not prevent
 280  * calling this function, since node->next is preserved, although freeing
 281  * 'node' of course does.) */
 282 static inline struct hmap_node *
 283 hmap_next_with_hash(const struct hmap_node *node)
 284 {
 285     return hmap_next_with_hash__(node->next, node->hash);
 286 }
 287
 288 static inline struct hmap_node *
 289 hmap_next__(const struct hmap *hmap, size_t start)
 290 {
 291     size_t i;
 292     for (i = start; i <= hmap->mask; i++) {
 293         struct hmap_node *node = hmap->buckets[i];
 294         if (node) {
 295             return node;
 296         }
 297     }
 298     return NULL;
 299 }
 300
 301 /* Returns the first node in 'hmap', in arbitrary order, or a null pointer if
 302  * 'hmap' is empty. */
 303 static inline struct hmap_node *
 304 hmap_first(const struct hmap *hmap)
 305 {
 306     return hmap_next__(hmap, 0);
 307 }
 308
 309 /* Returns the next node in 'hmap' following 'node', in arbitrary order, or a
 310  * null pointer if 'node' is the last node in 'hmap'.
 311  *
 312  * If the hash map has been reallocated since 'node' was visited, some nodes
 313  * may be skipped or visited twice.  (Removing 'node' from the hash map does
 314  * not prevent calling this function, since node->next is preserved, although
 315  * freeing 'node' of course does.) */
 316 static inline struct hmap_node *
 317 hmap_next(const struct hmap *hmap, const struct hmap_node *node)
 318 {
 319     return (node->next
 320             ? node->next
 321             : hmap_next__(hmap, (node->hash & hmap->mask) + 1));
 322 }
 323
 324 #ifdef  __cplusplus
 325 }
 326 #endif
 327
 328 #endif /* hmap.h */