2 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
24 /* A hash map node, to be embedded inside the data structure being mapped. */
26 size_t hash; /* Hash value. */
27 struct hmap_node *next; /* Next in linked list. */
30 /* Returns the hash value embedded in 'node'. */
31 static inline size_t hmap_node_hash(const struct hmap_node *node)
36 #define HMAP_NODE_NULL ((struct hmap_node *) 1)
38 /* Returns true if 'node' has been set to null by hmap_node_nullify() and has
39 * not been un-nullified by being inserted into an hmap. */
41 hmap_node_is_null(const struct hmap_node *node)
43 return node->next == HMAP_NODE_NULL;
46 /* Marks 'node' with a distinctive value that can be tested with
47 * hmap_node_is_null(). */
49 hmap_node_nullify(struct hmap_node *node)
51 node->next = HMAP_NODE_NULL;
56 struct hmap_node **buckets;
57 struct hmap_node *one;
62 /* Initializer for an empty hash map. */
63 #define HMAP_INITIALIZER(HMAP) { &(HMAP)->one, NULL, 0, 0 }
66 void hmap_init(struct hmap *);
67 void hmap_destroy(struct hmap *);
68 void hmap_swap(struct hmap *a, struct hmap *b);
69 static inline size_t hmap_count(const struct hmap *);
70 static inline bool hmap_is_empty(const struct hmap *);
72 /* Adjusting capacity. */
73 void hmap_expand(struct hmap *);
74 void hmap_shrink(struct hmap *);
75 void hmap_reserve(struct hmap *, size_t capacity);
77 /* Insertion and deletion. */
78 static inline void hmap_insert_fast(struct hmap *,
79 struct hmap_node *, size_t hash);
80 static inline void hmap_insert(struct hmap *, struct hmap_node *, size_t hash);
81 static inline void hmap_remove(struct hmap *, struct hmap_node *);
82 void hmap_node_moved(struct hmap *, struct hmap_node *, struct hmap_node *);
83 static inline void hmap_replace(struct hmap *, const struct hmap_node *old,
84 struct hmap_node *new);
88 * HMAP_FOR_EACH_WITH_HASH iterates NODE over all of the nodes in HMAP that
89 * have hash value equal to HASH. HMAP_FOR_EACH_IN_BUCKET iterates NODE over
90 * all of the nodes in HMAP that would fall in the same bucket as HASH. STRUCT
91 * and MEMBER must be the name of the struct that contains the 'struct
92 * hmap_node' and the name of the 'struct hmap_node' member, respectively.
94 * These macros may be used interchangeably to search for a particular value in
95 * an hmap, see, e.g. shash_find() for an example. Usually, using
96 * HMAP_FOR_EACH_WITH_HASH provides an optimization, because comparing a hash
97 * value is usually cheaper than comparing an entire hash map key. But for
98 * simple hash map keys, it makes sense to use HMAP_FOR_EACH_IN_BUCKET because
99 * it avoids doing two comparisons when a single simple comparison suffices.
101 * The loop should not change NODE to point to a different node or insert or
102 * delete nodes in HMAP (unless it "break"s out of the loop to terminate
105 * HASH is only evaluated once.
107 #define HMAP_FOR_EACH_WITH_HASH(NODE, STRUCT, MEMBER, HASH, HMAP) \
108 for ((NODE) = CONTAINER_OF(hmap_first_with_hash(HMAP, HASH), \
110 &(NODE)->MEMBER != NULL; \
111 (NODE) = CONTAINER_OF(hmap_next_with_hash(&(NODE)->MEMBER), \
113 #define HMAP_FOR_EACH_IN_BUCKET(NODE, STRUCT, MEMBER, HASH, HMAP) \
114 for ((NODE) = CONTAINER_OF(hmap_first_in_bucket(HMAP, HASH), \
116 &(NODE)->MEMBER != NULL; \
117 (NODE) = CONTAINER_OF(hmap_next_in_bucket(&(NODE)->MEMBER), \
120 static inline struct hmap_node *hmap_first_with_hash(const struct hmap *,
122 static inline struct hmap_node *hmap_next_with_hash(const struct hmap_node *);
123 static inline struct hmap_node *hmap_first_in_bucket(const struct hmap *,
125 static inline struct hmap_node *hmap_next_in_bucket(const struct hmap_node *);
129 * The _SAFE version is needed when NODE may be freed. It is not needed when
130 * NODE may be removed from the hash map but its members remain accessible and
132 #define HMAP_FOR_EACH(NODE, STRUCT, MEMBER, HMAP) \
133 for ((NODE) = CONTAINER_OF(hmap_first(HMAP), STRUCT, MEMBER); \
134 &(NODE)->MEMBER != NULL; \
135 (NODE) = CONTAINER_OF(hmap_next(HMAP, &(NODE)->MEMBER), \
138 #define HMAP_FOR_EACH_SAFE(NODE, NEXT, STRUCT, MEMBER, HMAP) \
139 for ((NODE) = CONTAINER_OF(hmap_first(HMAP), STRUCT, MEMBER); \
140 (&(NODE)->MEMBER != NULL \
141 ? (NEXT) = CONTAINER_OF(hmap_next(HMAP, &(NODE)->MEMBER), \
146 static inline struct hmap_node *hmap_first(const struct hmap *);
147 static inline struct hmap_node *hmap_next(const struct hmap *,
148 const struct hmap_node *);
150 /* Returns the number of nodes currently in 'hmap'. */
152 hmap_count(const struct hmap *hmap)
157 /* Returns the maximum number of nodes that 'hmap' may hold before it should be
160 hmap_capacity(const struct hmap *hmap)
162 return hmap->mask * 2 + 1;
165 /* Returns true if 'hmap' currently contains no nodes,
166 * false otherwise. */
168 hmap_is_empty(const struct hmap *hmap)
173 /* Inserts 'node', with the given 'hash', into 'hmap'. 'hmap' is never
174 * expanded automatically. */
176 hmap_insert_fast(struct hmap *hmap, struct hmap_node *node, size_t hash)
178 struct hmap_node **bucket = &hmap->buckets[hash & hmap->mask];
180 node->next = *bucket;
185 /* Inserts 'node', with the given 'hash', into 'hmap', and expands 'hmap' if
186 * necessary to optimize search performance. */
188 hmap_insert(struct hmap *hmap, struct hmap_node *node, size_t hash)
190 hmap_insert_fast(hmap, node, hash);
191 if (hmap->n / 2 > hmap->mask) {
196 /* Removes 'node' from 'hmap'. Does not shrink the hash table; call
197 * hmap_shrink() directly if desired. */
199 hmap_remove(struct hmap *hmap, struct hmap_node *node)
201 struct hmap_node **bucket = &hmap->buckets[node->hash & hmap->mask];
202 while (*bucket != node) {
203 bucket = &(*bucket)->next;
205 *bucket = node->next;
209 /* Puts 'new' in the position in 'hmap' currently occupied by 'old'. The 'new'
210 * node must hash to the same value as 'old'. The client is responsible for
211 * ensuring that the replacement does not violate any client-imposed
212 * invariants (e.g. uniqueness of keys within a map).
214 * Afterward, 'old' is not part of 'hmap', and the client is responsible for
215 * freeing it (if this is desirable). */
217 hmap_replace(struct hmap *hmap,
218 const struct hmap_node *old, struct hmap_node *new)
220 struct hmap_node **bucket = &hmap->buckets[old->hash & hmap->mask];
221 while (*bucket != old) {
222 bucket = &(*bucket)->next;
225 new->hash = old->hash;
226 new->next = old->next;
229 static inline struct hmap_node *
230 hmap_next_with_hash__(const struct hmap_node *node, size_t hash)
232 while (node != NULL && node->hash != hash) {
235 return (struct hmap_node *) node;
238 /* Returns the first node in 'hmap' with the given 'hash', or a null pointer if
239 * no nodes have that hash value. */
240 static inline struct hmap_node *
241 hmap_first_with_hash(const struct hmap *hmap, size_t hash)
243 return hmap_next_with_hash__(hmap->buckets[hash & hmap->mask], hash);
246 /* Returns the first node in 'hmap' in the bucket in which the given 'hash'
247 * would land, or a null pointer if that bucket is empty. */
248 static inline struct hmap_node *
249 hmap_first_in_bucket(const struct hmap *hmap, size_t hash)
251 return hmap->buckets[hash & hmap->mask];
254 /* Returns the next node in the same bucket as 'node', or a null pointer if
255 * there are no more nodes in that bucket.
257 * If the hash map has been reallocated since 'node' was visited, some nodes
258 * may be skipped; if new nodes with the same hash value have been added, they
259 * will be skipped. (Removing 'node' from the hash map does not prevent
260 * calling this function, since node->next is preserved, although freeing
261 * 'node' of course does.) */
262 static inline struct hmap_node *
263 hmap_next_in_bucket(const struct hmap_node *node)
268 /* Returns the next node in the same hash map as 'node' with the same hash
269 * value, or a null pointer if no more nodes have that hash value.
271 * If the hash map has been reallocated since 'node' was visited, some nodes
272 * may be skipped; if new nodes with the same hash value have been added, they
273 * will be skipped. (Removing 'node' from the hash map does not prevent
274 * calling this function, since node->next is preserved, although freeing
275 * 'node' of course does.) */
276 static inline struct hmap_node *
277 hmap_next_with_hash(const struct hmap_node *node)
279 return hmap_next_with_hash__(node->next, node->hash);
282 static inline struct hmap_node *
283 hmap_next__(const struct hmap *hmap, size_t start)
286 for (i = start; i <= hmap->mask; i++) {
287 struct hmap_node *node = hmap->buckets[i];
295 /* Returns the first node in 'hmap', in arbitrary order, or a null pointer if
296 * 'hmap' is empty. */
297 static inline struct hmap_node *
298 hmap_first(const struct hmap *hmap)
300 return hmap_next__(hmap, 0);
303 /* Returns the next node in 'hmap' following 'node', in arbitrary order, or a
304 * null pointer if 'node' is the last node in 'hmap'.
306 * If the hash map has been reallocated since 'node' was visited, some nodes
307 * may be skipped or visited twice. (Removing 'node' from the hash map does
308 * not prevent calling this function, since node->next is preserved, although
309 * freeing 'node' of course does.) */
310 static inline struct hmap_node *
311 hmap_next(const struct hmap *hmap, const struct hmap_node *node)
315 : hmap_next__(hmap, (node->hash & hmap->mask) + 1));