rculfhash: support use with multiple flavors per compile unit
[urcu.git] / include / urcu / rculfhash.h
CommitLineData
a42cc659
MD
1#ifndef _URCU_RCULFHASH_H
2#define _URCU_RCULFHASH_H
ab7d5fc6 3
f0c29ed7
MD
4/*
5 * urcu/rculfhash.h
6 *
7 * Userspace RCU library - Lock-Free RCU Hash Table
8 *
9 * Copyright 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
0dcf4847 10 * Copyright 2011 - Lai Jiangshan <laijs@cn.fujitsu.com>
f0c29ed7
MD
11 *
12 * This library is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Lesser General Public
14 * License as published by the Free Software Foundation; either
15 * version 2.1 of the License, or (at your option) any later version.
16 *
17 * This library is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * Lesser General Public License for more details.
21 *
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with this library; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
cf77d1fa 25 *
938465b4
MD
26 * For use with URCU_API_MAP (API mapping of liburcu), include this file
27 * _after_ including your URCU flavor.
f0c29ed7
MD
28 */
29
674f7a69 30#include <stdint.h>
6bcce235 31#include <pthread.h>
6d320126 32#include <urcu/compiler.h>
abc490a1 33
01389791
MD
34#ifdef __cplusplus
35extern "C" {
36#endif
37
7f52427b 38/*
04db56f8 39 * cds_lfht_node: Contains the next pointers and reverse-hash
7f52427b 40 * value required for lookup and traversal of the hash table.
04db56f8 41 *
db00ccc3 42 * struct cds_lfht_node should be aligned on 8-bytes boundaries because
13f656f9
MD
43 * the three lower bits are used as flags. It is worth noting that the
44 * information contained within these three bits could be represented on
45 * two bits by re-using the same bit for REMOVAL_OWNER_FLAG and
46 * BUCKET_FLAG. This can be done if we ensure that no iterator nor
47 * updater check the BUCKET_FLAG after it detects that the REMOVED_FLAG
48 * is set. Given the minimum size of struct cds_lfht_node is 8 bytes on
49 * 32-bit architectures, we choose to go for simplicity and reserve
50 * three bits.
7f52427b 51 *
ae62aa6a
MD
52 * struct cds_lfht_node can be embedded into a structure (as a field).
53 * caa_container_of() can be used to get the structure from the struct
54 * cds_lfht_node after a lookup.
04db56f8
LJ
55 *
56 * The structure which embeds it typically holds the key (or key-value
57 * pair) of the object. The caller code is responsible for calculation
58 * of the hash value for cds_lfht APIs.
ae62aa6a 59 */
14044b37 60struct cds_lfht_node {
3f2f3714 61 struct cds_lfht_node *next; /* ptr | REMOVAL_OWNER_FLAG | BUCKET_FLAG | REMOVED_FLAG */
04db56f8 62 unsigned long reverse_hash;
db00ccc3 63} __attribute__((aligned(8)));
abc490a1 64
7f52427b 65/* cds_lfht_iter: Used to track state while traversing a hash chain. */
adc0de68
MD
66struct cds_lfht_iter {
67 struct cds_lfht_node *node, *next;
68};
69
70static inline
71struct cds_lfht_node *cds_lfht_iter_get_node(struct cds_lfht_iter *iter)
72{
73 return iter->node;
74}
75
14044b37 76struct cds_lfht;
938465b4 77struct rcu_flavor_struct;
ab7d5fc6 78
5e28c532
MD
79/*
80 * Caution !
abc490a1 81 * Ensure reader and writer threads are registered as urcu readers.
5e28c532
MD
82 */
83
996ff57c 84typedef int (*cds_lfht_match_fct)(struct cds_lfht_node *node, const void *key);
abc490a1 85
f0c29ed7 86/*
14044b37 87 * cds_lfht_node_init - initialize a hash table node
0422d92c 88 * @node: the node to initialize.
04db56f8
LJ
89 *
90 * This function is kept to be eventually used for debugging purposes
91 * (detection of memory corruption).
f0c29ed7 92 */
abc490a1 93static inline
04db56f8 94void cds_lfht_node_init(struct cds_lfht_node *node)
abc490a1 95{
abc490a1 96}
674f7a69 97
b8af5011
MD
98/*
99 * Hash table creation flags.
100 */
101enum {
102 CDS_LFHT_AUTO_RESIZE = (1U << 0),
5afadd12 103 CDS_LFHT_ACCOUNTING = (1U << 1),
b8af5011
MD
104};
105
0b6aa001
LJ
106struct cds_lfht_mm_type {
107 struct cds_lfht *(*alloc_cds_lfht)(unsigned long min_nr_alloc_buckets,
108 unsigned long max_nr_buckets);
109 void (*alloc_bucket_table)(struct cds_lfht *ht, unsigned long order);
110 void (*free_bucket_table)(struct cds_lfht *ht, unsigned long order);
111 struct cds_lfht_node *(*bucket_at)(struct cds_lfht *ht,
112 unsigned long index);
113};
114
115extern const struct cds_lfht_mm_type cds_lfht_mm_order;
308d1cb3 116extern const struct cds_lfht_mm_type cds_lfht_mm_chunk;
b0b55251 117extern const struct cds_lfht_mm_type cds_lfht_mm_mmap;
0b6aa001 118
674f7a69 119/*
7a9dcf9b 120 * _cds_lfht_new - API used by cds_lfht_new wrapper. Do not use directly.
674f7a69 121 */
b9c27904 122extern
0422d92c 123struct cds_lfht *_cds_lfht_new(unsigned long init_size,
0722081a 124 unsigned long min_nr_alloc_buckets,
747d725c 125 unsigned long max_nr_buckets,
b8af5011 126 int flags,
0b6aa001 127 const struct cds_lfht_mm_type *mm,
7b17c13e 128 const struct rcu_flavor_struct *flavor,
b7d619b0 129 pthread_attr_t *attr);
ab7d5fc6 130
938465b4
MD
131/*
132 * cds_lfht_new_flavor - allocate a hash table tied to a RCU flavor.
133 * @init_size: number of buckets to allocate initially. Must be power of two.
134 * @min_nr_alloc_buckets: the minimum number of allocated buckets.
135 * (must be power of two)
136 * @max_nr_buckets: the maximum number of hash table buckets allowed.
137 * (must be power of two, 0 is accepted, means
138 * "infinite")
139 * @flavor: flavor of liburcu to use to synchronize the hash table
140 * @flags: hash table creation flags (can be combined with bitwise or: '|').
141 * 0: no flags.
142 * CDS_LFHT_AUTO_RESIZE: automatically resize hash table.
143 * CDS_LFHT_ACCOUNTING: count the number of node addition
144 * and removal in the table
145 * @attr: optional resize worker thread attributes. NULL for default.
146 *
147 * Return NULL on error.
148 * Note: the RCU flavor must be already included before the hash table header.
149 *
150 * The programmer is responsible for ensuring that resize operation has a
151 * priority equal to hash table updater threads. It should be performed by
152 * specifying the appropriate priority in the pthread "attr" argument, and,
153 * for CDS_LFHT_AUTO_RESIZE, by ensuring that call_rcu worker threads also have
154 * this priority level. Having lower priority for call_rcu and resize threads
155 * does not pose any correctness issue, but the resize operations could be
156 * starved by updates, thus leading to long hash table bucket chains.
157 * Threads calling cds_lfht_new are NOT required to be registered RCU
158 * read-side threads. It can be called very early. (e.g. before RCU is
159 * initialized)
160 */
161static inline
162struct cds_lfht *cds_lfht_new_flavor(unsigned long init_size,
163 unsigned long min_nr_alloc_buckets,
164 unsigned long max_nr_buckets,
165 int flags,
166 const struct rcu_flavor_struct *flavor,
167 pthread_attr_t *attr)
168{
169 return _cds_lfht_new(init_size, min_nr_alloc_buckets, max_nr_buckets,
170 flags, NULL, flavor, attr);
171}
172
173
174#ifdef URCU_API_MAP
7a9dcf9b
MD
175/*
176 * cds_lfht_new - allocate a hash table.
747d725c
LJ
177 * @init_size: number of buckets to allocate initially. Must be power of two.
178 * @min_nr_alloc_buckets: the minimum number of allocated buckets.
179 * (must be power of two)
180 * @max_nr_buckets: the maximum number of hash table buckets allowed.
28d5c1b5
MD
181 * (must be power of two, 0 is accepted, means
182 * "infinite")
f22dd01d
MD
183 * @flags: hash table creation flags (can be combined with bitwise or: '|').
184 * 0: no flags.
185 * CDS_LFHT_AUTO_RESIZE: automatically resize hash table.
44bbe7fa
LJ
186 * CDS_LFHT_ACCOUNTING: count the number of node addition
187 * and removal in the table
b7d619b0 188 * @attr: optional resize worker thread attributes. NULL for default.
7a9dcf9b 189 *
7a9dcf9b
MD
190 * Return NULL on error.
191 * Note: the RCU flavor must be already included before the hash table header.
b7d619b0
MD
192 *
193 * The programmer is responsible for ensuring that resize operation has a
194 * priority equal to hash table updater threads. It should be performed by
195 * specifying the appropriate priority in the pthread "attr" argument, and,
196 * for CDS_LFHT_AUTO_RESIZE, by ensuring that call_rcu worker threads also have
197 * this priority level. Having lower priority for call_rcu and resize threads
198 * does not pose any correctness issue, but the resize operations could be
199 * starved by updates, thus leading to long hash table bucket chains.
3a9c66db
MD
200 * Threads calling cds_lfht_new are NOT required to be registered RCU
201 * read-side threads. It can be called very early. (e.g. before RCU is
202 * initialized)
7a9dcf9b
MD
203 */
204static inline
0422d92c 205struct cds_lfht *cds_lfht_new(unsigned long init_size,
0722081a 206 unsigned long min_nr_alloc_buckets,
747d725c 207 unsigned long max_nr_buckets,
b7d619b0
MD
208 int flags,
209 pthread_attr_t *attr)
7a9dcf9b 210{
7b17c13e 211 return _cds_lfht_new(init_size, min_nr_alloc_buckets, max_nr_buckets,
c1888f3a 212 flags, NULL, &rcu_flavor, attr);
7a9dcf9b 213}
938465b4 214#endif /* URCU_API_MAP */
7a9dcf9b 215
f0c29ed7 216/*
14044b37 217 * cds_lfht_destroy - destroy a hash table.
b7d619b0
MD
218 * @ht: the hash table to destroy.
219 * @attr: (output) resize worker thread attributes, as received by cds_lfht_new.
220 * The caller will typically want to free this pointer if dynamically
7f52427b
MD
221 * allocated. The attr point can be NULL if the caller does not
222 * need to be informed of the value passed to cds_lfht_new().
6878c72b
MD
223 *
224 * Return 0 on success, negative error value on error.
d0ec0ed2
MD
225
226 * Prior to liburcu 0.10:
227 * - Threads calling this API need to be registered RCU read-side
228 * threads.
229 * - cds_lfht_destroy should *not* be called from a RCU read-side
230 * critical section. It should *not* be called from a call_rcu thread
231 * context neither.
232 *
233 * Starting from liburcu 0.10, rculfhash implements its own worker
234 * thread to handle resize operations, which removes RCU requirements on
235 * cds_lfht_destroy.
f0c29ed7 236 */
b9c27904 237extern
b7d619b0 238int cds_lfht_destroy(struct cds_lfht *ht, pthread_attr_t **attr);
f0c29ed7
MD
239
240/*
14044b37 241 * cds_lfht_count_nodes - count the number of nodes in the hash table.
7f52427b 242 * @ht: the hash table.
3a9c66db
MD
243 * @split_count_before: sample the node count split-counter before traversal.
244 * @count: traverse the hash table, count the number of nodes observed.
245 * @split_count_after: sample the node count split-counter after traversal.
0422d92c 246 *
f0c29ed7 247 * Call with rcu_read_lock held.
3df0c49c 248 * Threads calling this API need to be registered RCU read-side threads.
f0c29ed7 249 */
b9c27904 250extern
14044b37 251void cds_lfht_count_nodes(struct cds_lfht *ht,
7f52427b 252 long *split_count_before,
adc0de68 253 unsigned long *count,
7f52427b 254 long *split_count_after);
ab7d5fc6 255
f0c29ed7 256/*
14044b37 257 * cds_lfht_lookup - lookup a node by key.
0422d92c 258 * @ht: the hash table.
0422d92c 259 * @hash: the key hash.
6f554439
LJ
260 * @match: the key match function.
261 * @key: the current node key.
3a9c66db 262 * @iter: node, if found (output). *iter->node set to NULL if not found.
f0c29ed7 263 *
f0c29ed7 264 * Call with rcu_read_lock held.
3df0c49c 265 * Threads calling this API need to be registered RCU read-side threads.
7b783f81 266 * This function acts as a rcu_dereference() to read the node pointer.
f0c29ed7 267 */
b9c27904 268extern
6f554439 269void cds_lfht_lookup(struct cds_lfht *ht, unsigned long hash,
996ff57c 270 cds_lfht_match_fct match, const void *key,
6f554439 271 struct cds_lfht_iter *iter);
ab7d5fc6 272
f0c29ed7 273/*
3a9c66db 274 * cds_lfht_next_duplicate - get the next item with same key, after iterator.
0422d92c
MD
275 * @ht: the hash table.
276 * @match: the key match function.
04db56f8 277 * @key: the current node key.
3a9c66db
MD
278 * @iter: input: current iterator.
279 * output: node, if found. *iter->node set to NULL if not found.
f0c29ed7 280 *
3a9c66db
MD
281 * Uses an iterator initialized by a lookup or traversal. Important: the
282 * iterator _needs_ to be initialized before calling
283 * cds_lfht_next_duplicate.
adc0de68
MD
284 * Sets *iter-node to the following node with same key.
285 * Sets *iter->node to NULL if no following node exists with same key.
286 * RCU read-side lock must be held across cds_lfht_lookup and
287 * cds_lfht_next calls, and also between cds_lfht_next calls using the
288 * node returned by a previous cds_lfht_next.
289 * Call with rcu_read_lock held.
3df0c49c 290 * Threads calling this API need to be registered RCU read-side threads.
7b783f81 291 * This function acts as a rcu_dereference() to read the node pointer.
f0c29ed7 292 */
b9c27904 293extern
0422d92c 294void cds_lfht_next_duplicate(struct cds_lfht *ht,
996ff57c 295 cds_lfht_match_fct match, const void *key,
04db56f8 296 struct cds_lfht_iter *iter);
4e9b9fbf
MD
297
298/*
299 * cds_lfht_first - get the first node in the table.
0422d92c
MD
300 * @ht: the hash table.
301 * @iter: First node, if exists (output). *iter->node set to NULL if not found.
4e9b9fbf
MD
302 *
303 * Output in "*iter". *iter->node set to NULL if table is empty.
304 * Call with rcu_read_lock held.
3df0c49c 305 * Threads calling this API need to be registered RCU read-side threads.
7b783f81 306 * This function acts as a rcu_dereference() to read the node pointer.
4e9b9fbf 307 */
b9c27904 308extern
4e9b9fbf
MD
309void cds_lfht_first(struct cds_lfht *ht, struct cds_lfht_iter *iter);
310
311/*
312 * cds_lfht_next - get the next node in the table.
0422d92c 313 * @ht: the hash table.
3a9c66db
MD
314 * @iter: input: current iterator.
315 * output: next node, if exists. *iter->node set to NULL if not found.
4e9b9fbf
MD
316 *
317 * Input/Output in "*iter". *iter->node set to NULL if *iter was
318 * pointing to the last table node.
319 * Call with rcu_read_lock held.
3df0c49c 320 * Threads calling this API need to be registered RCU read-side threads.
7b783f81 321 * This function acts as a rcu_dereference() to read the node pointer.
4e9b9fbf 322 */
b9c27904 323extern
4e9b9fbf 324void cds_lfht_next(struct cds_lfht *ht, struct cds_lfht_iter *iter);
ab7d5fc6 325
18117871 326/*
14044b37 327 * cds_lfht_add - add a node to the hash table.
0422d92c
MD
328 * @ht: the hash table.
329 * @hash: the key hash.
330 * @node: the node to add.
f0c29ed7 331 *
48ed1c18 332 * This function supports adding redundant keys into the table.
3df0c49c
MD
333 * Call with rcu_read_lock held.
334 * Threads calling this API need to be registered RCU read-side threads.
7b783f81
MD
335 * This function issues a full memory barrier before and after its
336 * atomic commit.
f0c29ed7 337 */
b9c27904 338extern
0422d92c
MD
339void cds_lfht_add(struct cds_lfht *ht, unsigned long hash,
340 struct cds_lfht_node *node);
f0c29ed7
MD
341
342/*
14044b37 343 * cds_lfht_add_unique - add a node to hash table, if key is not present.
0422d92c 344 * @ht: the hash table.
6f554439 345 * @hash: the node's hash.
0422d92c 346 * @match: the key match function.
04db56f8 347 * @key: the node's key.
0422d92c 348 * @node: the node to try adding.
f0c29ed7 349 *
6878c72b 350 * Return the node added upon success.
860d07e8
MD
351 * Return the unique node already present upon failure. If
352 * cds_lfht_add_unique fails, the node passed as parameter should be
3a9c66db 353 * freed by the caller. In this case, the caller does NOT need to wait
50024344 354 * for a grace period before freeing or re-using the node.
f0c29ed7 355 * Call with rcu_read_lock held.
3df0c49c 356 * Threads calling this API need to be registered RCU read-side threads.
48ed1c18
MD
357 *
358 * The semantic of this function is that if only this function is used
359 * to add keys into the table, no duplicated keys should ever be
360 * observable in the table. The same guarantee apply for combination of
9357c415 361 * add_unique and add_replace (see below).
7b783f81
MD
362 *
363 * Upon success, this function issues a full memory barrier before and
364 * after its atomic commit. Upon failure, this function acts like a
365 * simple lookup operation: it acts as a rcu_dereference() to read the
366 * node pointer. The failure case does not guarantee any other memory
367 * barrier.
18117871 368 */
b9c27904 369extern
adc0de68 370struct cds_lfht_node *cds_lfht_add_unique(struct cds_lfht *ht,
6f554439 371 unsigned long hash,
0422d92c 372 cds_lfht_match_fct match,
996ff57c 373 const void *key,
adc0de68 374 struct cds_lfht_node *node);
3eca1b8c 375
48ed1c18 376/*
9357c415 377 * cds_lfht_add_replace - replace or add a node within hash table.
0422d92c 378 * @ht: the hash table.
6f554439 379 * @hash: the node's hash.
0422d92c 380 * @match: the key match function.
04db56f8 381 * @key: the node's key.
0422d92c 382 * @node: the node to add.
48ed1c18
MD
383 *
384 * Return the node replaced upon success. If no node matching the key
385 * was present, return NULL, which also means the operation succeeded.
386 * This replacement operation should never fail.
387 * Call with rcu_read_lock held.
3df0c49c 388 * Threads calling this API need to be registered RCU read-side threads.
48ed1c18 389 * After successful replacement, a grace period must be waited for before
50024344 390 * freeing or re-using the memory reserved for the returned node.
48ed1c18 391 *
3a9c66db
MD
392 * The semantic of replacement vs lookups and traversals is the
393 * following: if lookups and traversals are performed between a key
394 * unique insertion and its removal, we guarantee that the lookups and
395 * traversals will always find exactly one instance of the key if it is
396 * replaced concurrently with the lookups.
48ed1c18
MD
397 *
398 * Providing this semantic allows us to ensure that replacement-only
399 * schemes will never generate duplicated keys. It also allows us to
9357c415 400 * guarantee that a combination of add_replace and add_unique updates
48ed1c18 401 * will never generate duplicated keys.
7b783f81
MD
402 *
403 * This function issues a full memory barrier before and after its
404 * atomic commit.
48ed1c18 405 */
b9c27904 406extern
9357c415 407struct cds_lfht_node *cds_lfht_add_replace(struct cds_lfht *ht,
6f554439 408 unsigned long hash,
0422d92c 409 cds_lfht_match_fct match,
996ff57c 410 const void *key,
adc0de68 411 struct cds_lfht_node *node);
48ed1c18 412
f0c29ed7 413/*
929ad508 414 * cds_lfht_replace - replace a node pointed to by iter within hash table.
0422d92c
MD
415 * @ht: the hash table.
416 * @old_iter: the iterator position of the node to replace.
2e79c445
MD
417 * @hash: the node's hash.
418 * @match: the key match function.
419 * @key: the node's key.
420 * @new_node: the new node to use as replacement.
f0c29ed7 421 *
9357c415 422 * Return 0 if replacement is successful, negative value otherwise.
2e79c445
MD
423 * Replacing a NULL old node or an already removed node will fail with
424 * -ENOENT.
425 * If the hash or value of the node to replace and the new node differ,
426 * this function returns -EINVAL without proceeding to the replacement.
9357c415
MD
427 * Old node can be looked up with cds_lfht_lookup and cds_lfht_next.
428 * RCU read-side lock must be held between lookup and replacement.
429 * Call with rcu_read_lock held.
3df0c49c 430 * Threads calling this API need to be registered RCU read-side threads.
9357c415 431 * After successful replacement, a grace period must be waited for before
50024344
MD
432 * freeing or re-using the memory reserved for the old node (which can
433 * be accessed with cds_lfht_iter_get_node).
9357c415 434 *
3a9c66db
MD
435 * The semantic of replacement vs lookups is the same as
436 * cds_lfht_add_replace().
7b783f81
MD
437 *
438 * Upon success, this function issues a full memory barrier before and
439 * after its atomic commit. Upon failure, this function does not issue
440 * any memory barrier.
9357c415 441 */
b9c27904 442extern
2e79c445
MD
443int cds_lfht_replace(struct cds_lfht *ht,
444 struct cds_lfht_iter *old_iter,
445 unsigned long hash,
446 cds_lfht_match_fct match,
447 const void *key,
9357c415
MD
448 struct cds_lfht_node *new_node);
449
450/*
451 * cds_lfht_del - remove node pointed to by iterator from hash table.
0422d92c 452 * @ht: the hash table.
bc8c3c74 453 * @node: the node to delete.
9357c415
MD
454 *
455 * Return 0 if the node is successfully removed, negative value
456 * otherwise.
bc8c3c74 457 * Deleting a NULL node or an already removed node will fail with a
9357c415 458 * negative value.
bc8c3c74
MD
459 * Node can be looked up with cds_lfht_lookup and cds_lfht_next,
460 * followed by use of cds_lfht_iter_get_node.
9357c415 461 * RCU read-side lock must be held between lookup and removal.
f0c29ed7 462 * Call with rcu_read_lock held.
3df0c49c 463 * Threads calling this API need to be registered RCU read-side threads.
48ed1c18 464 * After successful removal, a grace period must be waited for before
50024344
MD
465 * freeing or re-using the memory reserved for old node (which can be
466 * accessed with cds_lfht_iter_get_node).
7b783f81
MD
467 * Upon success, this function issues a full memory barrier before and
468 * after its atomic commit. Upon failure, this function does not issue
469 * any memory barrier.
f0c29ed7 470 */
b9c27904 471extern
bc8c3c74 472int cds_lfht_del(struct cds_lfht *ht, struct cds_lfht_node *node);
ab7d5fc6 473
df55172a 474/*
3a9c66db 475 * cds_lfht_is_node_deleted - query whether a node is removed from hash table.
df55172a
MD
476 *
477 * Return non-zero if the node is deleted from the hash table, 0
478 * otherwise.
479 * Node can be looked up with cds_lfht_lookup and cds_lfht_next,
480 * followed by use of cds_lfht_iter_get_node.
481 * RCU read-side lock must be held between lookup and call to this
482 * function.
483 * Call with rcu_read_lock held.
484 * Threads calling this API need to be registered RCU read-side threads.
7b783f81 485 * This function does not issue any memory barrier.
df55172a 486 */
b9c27904 487extern
df55172a
MD
488int cds_lfht_is_node_deleted(struct cds_lfht_node *node);
489
f0c29ed7 490/*
14044b37 491 * cds_lfht_resize - Force a hash table resize
0422d92c 492 * @ht: the hash table.
1475579c 493 * @new_size: update to this hash table size.
3df0c49c
MD
494 *
495 * Threads calling this API need to be registered RCU read-side threads.
7b783f81 496 * This function does not (necessarily) issue memory barriers.
43387742
MD
497 * cds_lfht_resize should *not* be called from a RCU read-side critical
498 * section.
f0c29ed7 499 */
b9c27904 500extern
1475579c 501void cds_lfht_resize(struct cds_lfht *ht, unsigned long new_size);
464a1ec9 502
6d320126 503/*
3a9c66db
MD
504 * Note: it is safe to perform element removal (del), replacement, or
505 * any hash table update operation during any of the following hash
506 * table traversals.
7b783f81 507 * These functions act as rcu_dereference() to read the node pointers.
6d320126
MD
508 */
509#define cds_lfht_for_each(ht, iter, node) \
510 for (cds_lfht_first(ht, iter), \
511 node = cds_lfht_iter_get_node(iter); \
512 node != NULL; \
513 cds_lfht_next(ht, iter), \
514 node = cds_lfht_iter_get_node(iter))
515
6f554439
LJ
516#define cds_lfht_for_each_duplicate(ht, hash, match, key, iter, node) \
517 for (cds_lfht_lookup(ht, hash, match, key, iter), \
6d320126
MD
518 node = cds_lfht_iter_get_node(iter); \
519 node != NULL; \
520 cds_lfht_next_duplicate(ht, match, key, iter), \
521 node = cds_lfht_iter_get_node(iter))
522
523#define cds_lfht_for_each_entry(ht, iter, pos, member) \
524 for (cds_lfht_first(ht, iter), \
525 pos = caa_container_of(cds_lfht_iter_get_node(iter), \
bdffa73a 526 __typeof__(*(pos)), member); \
92af1a30 527 cds_lfht_iter_get_node(iter) != NULL; \
6d320126
MD
528 cds_lfht_next(ht, iter), \
529 pos = caa_container_of(cds_lfht_iter_get_node(iter), \
bdffa73a 530 __typeof__(*(pos)), member))
6d320126 531
6f554439 532#define cds_lfht_for_each_entry_duplicate(ht, hash, match, key, \
6d320126 533 iter, pos, member) \
6f554439 534 for (cds_lfht_lookup(ht, hash, match, key, iter), \
6d320126 535 pos = caa_container_of(cds_lfht_iter_get_node(iter), \
bdffa73a 536 __typeof__(*(pos)), member); \
92af1a30 537 cds_lfht_iter_get_node(iter) != NULL; \
6d320126
MD
538 cds_lfht_next_duplicate(ht, match, key, iter), \
539 pos = caa_container_of(cds_lfht_iter_get_node(iter), \
bdffa73a 540 __typeof__(*(pos)), member))
6d320126 541
01389791
MD
542#ifdef __cplusplus
543}
544#endif
545
a42cc659 546#endif /* _URCU_RCULFHASH_H */
This page took 0.099145 seconds and 4 git commands to generate.