Commit | Line | Data |
---|---|---|
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 MD |
25 | * |
26 | * Include this file _after_ including your URCU flavor. | |
f0c29ed7 MD |
27 | */ |
28 | ||
674f7a69 | 29 | #include <stdint.h> |
6d320126 | 30 | #include <urcu/compiler.h> |
abc490a1 | 31 | #include <urcu-call-rcu.h> |
7b17c13e | 32 | #include <urcu-flavor.h> |
abc490a1 | 33 | |
01389791 MD |
34 | #ifdef __cplusplus |
35 | extern "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 | 60 | struct 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 |
66 | struct cds_lfht_iter { |
67 | struct cds_lfht_node *node, *next; | |
68 | }; | |
69 | ||
70 | static inline | |
71 | struct cds_lfht_node *cds_lfht_iter_get_node(struct cds_lfht_iter *iter) | |
72 | { | |
73 | return iter->node; | |
74 | } | |
75 | ||
14044b37 | 76 | struct cds_lfht; |
ab7d5fc6 | 77 | |
5e28c532 MD |
78 | /* |
79 | * Caution ! | |
abc490a1 | 80 | * Ensure reader and writer threads are registered as urcu readers. |
5e28c532 MD |
81 | */ |
82 | ||
996ff57c | 83 | typedef int (*cds_lfht_match_fct)(struct cds_lfht_node *node, const void *key); |
abc490a1 | 84 | |
f0c29ed7 | 85 | /* |
14044b37 | 86 | * cds_lfht_node_init - initialize a hash table node |
0422d92c | 87 | * @node: the node to initialize. |
04db56f8 LJ |
88 | * |
89 | * This function is kept to be eventually used for debugging purposes | |
90 | * (detection of memory corruption). | |
f0c29ed7 | 91 | */ |
abc490a1 | 92 | static inline |
04db56f8 | 93 | void cds_lfht_node_init(struct cds_lfht_node *node) |
abc490a1 | 94 | { |
abc490a1 | 95 | } |
674f7a69 | 96 | |
b8af5011 MD |
97 | /* |
98 | * Hash table creation flags. | |
99 | */ | |
100 | enum { | |
101 | CDS_LFHT_AUTO_RESIZE = (1U << 0), | |
5afadd12 | 102 | CDS_LFHT_ACCOUNTING = (1U << 1), |
b8af5011 MD |
103 | }; |
104 | ||
0b6aa001 LJ |
105 | struct cds_lfht_mm_type { |
106 | struct cds_lfht *(*alloc_cds_lfht)(unsigned long min_nr_alloc_buckets, | |
107 | unsigned long max_nr_buckets); | |
108 | void (*alloc_bucket_table)(struct cds_lfht *ht, unsigned long order); | |
109 | void (*free_bucket_table)(struct cds_lfht *ht, unsigned long order); | |
110 | struct cds_lfht_node *(*bucket_at)(struct cds_lfht *ht, | |
111 | unsigned long index); | |
112 | }; | |
113 | ||
114 | extern const struct cds_lfht_mm_type cds_lfht_mm_order; | |
308d1cb3 | 115 | extern const struct cds_lfht_mm_type cds_lfht_mm_chunk; |
b0b55251 | 116 | extern const struct cds_lfht_mm_type cds_lfht_mm_mmap; |
0b6aa001 | 117 | |
674f7a69 | 118 | /* |
7a9dcf9b | 119 | * _cds_lfht_new - API used by cds_lfht_new wrapper. Do not use directly. |
674f7a69 | 120 | */ |
b9c27904 | 121 | extern |
0422d92c | 122 | struct cds_lfht *_cds_lfht_new(unsigned long init_size, |
0722081a | 123 | unsigned long min_nr_alloc_buckets, |
747d725c | 124 | unsigned long max_nr_buckets, |
b8af5011 | 125 | int flags, |
0b6aa001 | 126 | const struct cds_lfht_mm_type *mm, |
7b17c13e | 127 | const struct rcu_flavor_struct *flavor, |
b7d619b0 | 128 | pthread_attr_t *attr); |
ab7d5fc6 | 129 | |
7a9dcf9b MD |
130 | /* |
131 | * cds_lfht_new - allocate a hash table. | |
747d725c LJ |
132 | * @init_size: number of buckets to allocate initially. Must be power of two. |
133 | * @min_nr_alloc_buckets: the minimum number of allocated buckets. | |
134 | * (must be power of two) | |
135 | * @max_nr_buckets: the maximum number of hash table buckets allowed. | |
136 | * (must be power of two) | |
f22dd01d MD |
137 | * @flags: hash table creation flags (can be combined with bitwise or: '|'). |
138 | * 0: no flags. | |
139 | * CDS_LFHT_AUTO_RESIZE: automatically resize hash table. | |
44bbe7fa LJ |
140 | * CDS_LFHT_ACCOUNTING: count the number of node addition |
141 | * and removal in the table | |
b7d619b0 | 142 | * @attr: optional resize worker thread attributes. NULL for default. |
7a9dcf9b | 143 | * |
7a9dcf9b MD |
144 | * Return NULL on error. |
145 | * Note: the RCU flavor must be already included before the hash table header. | |
b7d619b0 MD |
146 | * |
147 | * The programmer is responsible for ensuring that resize operation has a | |
148 | * priority equal to hash table updater threads. It should be performed by | |
149 | * specifying the appropriate priority in the pthread "attr" argument, and, | |
150 | * for CDS_LFHT_AUTO_RESIZE, by ensuring that call_rcu worker threads also have | |
151 | * this priority level. Having lower priority for call_rcu and resize threads | |
152 | * does not pose any correctness issue, but the resize operations could be | |
153 | * starved by updates, thus leading to long hash table bucket chains. | |
3a9c66db MD |
154 | * Threads calling cds_lfht_new are NOT required to be registered RCU |
155 | * read-side threads. It can be called very early. (e.g. before RCU is | |
156 | * initialized) | |
7a9dcf9b MD |
157 | */ |
158 | static inline | |
0422d92c | 159 | struct cds_lfht *cds_lfht_new(unsigned long init_size, |
0722081a | 160 | unsigned long min_nr_alloc_buckets, |
747d725c | 161 | unsigned long max_nr_buckets, |
b7d619b0 MD |
162 | int flags, |
163 | pthread_attr_t *attr) | |
7a9dcf9b | 164 | { |
7b17c13e | 165 | return _cds_lfht_new(init_size, min_nr_alloc_buckets, max_nr_buckets, |
c1888f3a | 166 | flags, NULL, &rcu_flavor, attr); |
7a9dcf9b MD |
167 | } |
168 | ||
f0c29ed7 | 169 | /* |
14044b37 | 170 | * cds_lfht_destroy - destroy a hash table. |
b7d619b0 MD |
171 | * @ht: the hash table to destroy. |
172 | * @attr: (output) resize worker thread attributes, as received by cds_lfht_new. | |
173 | * The caller will typically want to free this pointer if dynamically | |
7f52427b MD |
174 | * allocated. The attr point can be NULL if the caller does not |
175 | * need to be informed of the value passed to cds_lfht_new(). | |
6878c72b MD |
176 | * |
177 | * Return 0 on success, negative error value on error. | |
3df0c49c | 178 | * Threads calling this API need to be registered RCU read-side threads. |
96914388 | 179 | * cds_lfht_destroy should *not* be called from a RCU read-side critical |
a22bf98b MD |
180 | * section. It should *not* be called from a call_rcu thread context |
181 | * neither. | |
f0c29ed7 | 182 | */ |
b9c27904 | 183 | extern |
b7d619b0 | 184 | int cds_lfht_destroy(struct cds_lfht *ht, pthread_attr_t **attr); |
f0c29ed7 MD |
185 | |
186 | /* | |
14044b37 | 187 | * cds_lfht_count_nodes - count the number of nodes in the hash table. |
7f52427b | 188 | * @ht: the hash table. |
3a9c66db MD |
189 | * @split_count_before: sample the node count split-counter before traversal. |
190 | * @count: traverse the hash table, count the number of nodes observed. | |
191 | * @split_count_after: sample the node count split-counter after traversal. | |
0422d92c | 192 | * |
f0c29ed7 | 193 | * Call with rcu_read_lock held. |
3df0c49c | 194 | * Threads calling this API need to be registered RCU read-side threads. |
f0c29ed7 | 195 | */ |
b9c27904 | 196 | extern |
14044b37 | 197 | void cds_lfht_count_nodes(struct cds_lfht *ht, |
7f52427b | 198 | long *split_count_before, |
adc0de68 | 199 | unsigned long *count, |
7f52427b | 200 | long *split_count_after); |
ab7d5fc6 | 201 | |
f0c29ed7 | 202 | /* |
14044b37 | 203 | * cds_lfht_lookup - lookup a node by key. |
0422d92c | 204 | * @ht: the hash table. |
0422d92c | 205 | * @hash: the key hash. |
6f554439 LJ |
206 | * @match: the key match function. |
207 | * @key: the current node key. | |
3a9c66db | 208 | * @iter: node, if found (output). *iter->node set to NULL if not found. |
f0c29ed7 | 209 | * |
f0c29ed7 | 210 | * Call with rcu_read_lock held. |
3df0c49c | 211 | * Threads calling this API need to be registered RCU read-side threads. |
7b783f81 | 212 | * This function acts as a rcu_dereference() to read the node pointer. |
f0c29ed7 | 213 | */ |
b9c27904 | 214 | extern |
6f554439 | 215 | void cds_lfht_lookup(struct cds_lfht *ht, unsigned long hash, |
996ff57c | 216 | cds_lfht_match_fct match, const void *key, |
6f554439 | 217 | struct cds_lfht_iter *iter); |
ab7d5fc6 | 218 | |
f0c29ed7 | 219 | /* |
3a9c66db | 220 | * cds_lfht_next_duplicate - get the next item with same key, after iterator. |
0422d92c MD |
221 | * @ht: the hash table. |
222 | * @match: the key match function. | |
04db56f8 | 223 | * @key: the current node key. |
3a9c66db MD |
224 | * @iter: input: current iterator. |
225 | * output: node, if found. *iter->node set to NULL if not found. | |
f0c29ed7 | 226 | * |
3a9c66db MD |
227 | * Uses an iterator initialized by a lookup or traversal. Important: the |
228 | * iterator _needs_ to be initialized before calling | |
229 | * cds_lfht_next_duplicate. | |
adc0de68 MD |
230 | * Sets *iter-node to the following node with same key. |
231 | * Sets *iter->node to NULL if no following node exists with same key. | |
232 | * RCU read-side lock must be held across cds_lfht_lookup and | |
233 | * cds_lfht_next calls, and also between cds_lfht_next calls using the | |
234 | * node returned by a previous cds_lfht_next. | |
235 | * Call with rcu_read_lock held. | |
3df0c49c | 236 | * Threads calling this API need to be registered RCU read-side threads. |
7b783f81 | 237 | * This function acts as a rcu_dereference() to read the node pointer. |
f0c29ed7 | 238 | */ |
b9c27904 | 239 | extern |
0422d92c | 240 | void cds_lfht_next_duplicate(struct cds_lfht *ht, |
996ff57c | 241 | cds_lfht_match_fct match, const void *key, |
04db56f8 | 242 | struct cds_lfht_iter *iter); |
4e9b9fbf MD |
243 | |
244 | /* | |
245 | * cds_lfht_first - get the first node in the table. | |
0422d92c MD |
246 | * @ht: the hash table. |
247 | * @iter: First node, if exists (output). *iter->node set to NULL if not found. | |
4e9b9fbf MD |
248 | * |
249 | * Output in "*iter". *iter->node set to NULL if table is empty. | |
250 | * Call with rcu_read_lock held. | |
3df0c49c | 251 | * Threads calling this API need to be registered RCU read-side threads. |
7b783f81 | 252 | * This function acts as a rcu_dereference() to read the node pointer. |
4e9b9fbf | 253 | */ |
b9c27904 | 254 | extern |
4e9b9fbf MD |
255 | void cds_lfht_first(struct cds_lfht *ht, struct cds_lfht_iter *iter); |
256 | ||
257 | /* | |
258 | * cds_lfht_next - get the next node in the table. | |
0422d92c | 259 | * @ht: the hash table. |
3a9c66db MD |
260 | * @iter: input: current iterator. |
261 | * output: next node, if exists. *iter->node set to NULL if not found. | |
4e9b9fbf MD |
262 | * |
263 | * Input/Output in "*iter". *iter->node set to NULL if *iter was | |
264 | * pointing to the last table node. | |
265 | * Call with rcu_read_lock held. | |
3df0c49c | 266 | * Threads calling this API need to be registered RCU read-side threads. |
7b783f81 | 267 | * This function acts as a rcu_dereference() to read the node pointer. |
4e9b9fbf | 268 | */ |
b9c27904 | 269 | extern |
4e9b9fbf | 270 | void cds_lfht_next(struct cds_lfht *ht, struct cds_lfht_iter *iter); |
ab7d5fc6 | 271 | |
18117871 | 272 | /* |
14044b37 | 273 | * cds_lfht_add - add a node to the hash table. |
0422d92c MD |
274 | * @ht: the hash table. |
275 | * @hash: the key hash. | |
276 | * @node: the node to add. | |
f0c29ed7 | 277 | * |
48ed1c18 | 278 | * This function supports adding redundant keys into the table. |
3df0c49c MD |
279 | * Call with rcu_read_lock held. |
280 | * Threads calling this API need to be registered RCU read-side threads. | |
7b783f81 MD |
281 | * This function issues a full memory barrier before and after its |
282 | * atomic commit. | |
f0c29ed7 | 283 | */ |
b9c27904 | 284 | extern |
0422d92c MD |
285 | void cds_lfht_add(struct cds_lfht *ht, unsigned long hash, |
286 | struct cds_lfht_node *node); | |
f0c29ed7 MD |
287 | |
288 | /* | |
14044b37 | 289 | * cds_lfht_add_unique - add a node to hash table, if key is not present. |
0422d92c | 290 | * @ht: the hash table. |
6f554439 | 291 | * @hash: the node's hash. |
0422d92c | 292 | * @match: the key match function. |
04db56f8 | 293 | * @key: the node's key. |
0422d92c | 294 | * @node: the node to try adding. |
f0c29ed7 | 295 | * |
6878c72b | 296 | * Return the node added upon success. |
860d07e8 MD |
297 | * Return the unique node already present upon failure. If |
298 | * cds_lfht_add_unique fails, the node passed as parameter should be | |
3a9c66db MD |
299 | * freed by the caller. In this case, the caller does NOT need to wait |
300 | * for a grace period before freeing the node. | |
f0c29ed7 | 301 | * Call with rcu_read_lock held. |
3df0c49c | 302 | * Threads calling this API need to be registered RCU read-side threads. |
48ed1c18 MD |
303 | * |
304 | * The semantic of this function is that if only this function is used | |
305 | * to add keys into the table, no duplicated keys should ever be | |
306 | * observable in the table. The same guarantee apply for combination of | |
9357c415 | 307 | * add_unique and add_replace (see below). |
7b783f81 MD |
308 | * |
309 | * Upon success, this function issues a full memory barrier before and | |
310 | * after its atomic commit. Upon failure, this function acts like a | |
311 | * simple lookup operation: it acts as a rcu_dereference() to read the | |
312 | * node pointer. The failure case does not guarantee any other memory | |
313 | * barrier. | |
18117871 | 314 | */ |
b9c27904 | 315 | extern |
adc0de68 | 316 | struct cds_lfht_node *cds_lfht_add_unique(struct cds_lfht *ht, |
6f554439 | 317 | unsigned long hash, |
0422d92c | 318 | cds_lfht_match_fct match, |
996ff57c | 319 | const void *key, |
adc0de68 | 320 | struct cds_lfht_node *node); |
3eca1b8c | 321 | |
48ed1c18 | 322 | /* |
9357c415 | 323 | * cds_lfht_add_replace - replace or add a node within hash table. |
0422d92c | 324 | * @ht: the hash table. |
6f554439 | 325 | * @hash: the node's hash. |
0422d92c | 326 | * @match: the key match function. |
04db56f8 | 327 | * @key: the node's key. |
0422d92c | 328 | * @node: the node to add. |
48ed1c18 MD |
329 | * |
330 | * Return the node replaced upon success. If no node matching the key | |
331 | * was present, return NULL, which also means the operation succeeded. | |
332 | * This replacement operation should never fail. | |
333 | * Call with rcu_read_lock held. | |
3df0c49c | 334 | * Threads calling this API need to be registered RCU read-side threads. |
48ed1c18 MD |
335 | * After successful replacement, a grace period must be waited for before |
336 | * freeing the memory reserved for the returned node. | |
337 | * | |
3a9c66db MD |
338 | * The semantic of replacement vs lookups and traversals is the |
339 | * following: if lookups and traversals are performed between a key | |
340 | * unique insertion and its removal, we guarantee that the lookups and | |
341 | * traversals will always find exactly one instance of the key if it is | |
342 | * replaced concurrently with the lookups. | |
48ed1c18 MD |
343 | * |
344 | * Providing this semantic allows us to ensure that replacement-only | |
345 | * schemes will never generate duplicated keys. It also allows us to | |
9357c415 | 346 | * guarantee that a combination of add_replace and add_unique updates |
48ed1c18 | 347 | * will never generate duplicated keys. |
7b783f81 MD |
348 | * |
349 | * This function issues a full memory barrier before and after its | |
350 | * atomic commit. | |
48ed1c18 | 351 | */ |
b9c27904 | 352 | extern |
9357c415 | 353 | struct cds_lfht_node *cds_lfht_add_replace(struct cds_lfht *ht, |
6f554439 | 354 | unsigned long hash, |
0422d92c | 355 | cds_lfht_match_fct match, |
996ff57c | 356 | const void *key, |
adc0de68 | 357 | struct cds_lfht_node *node); |
48ed1c18 | 358 | |
f0c29ed7 | 359 | /* |
929ad508 | 360 | * cds_lfht_replace - replace a node pointed to by iter within hash table. |
0422d92c MD |
361 | * @ht: the hash table. |
362 | * @old_iter: the iterator position of the node to replace. | |
2e79c445 MD |
363 | * @hash: the node's hash. |
364 | * @match: the key match function. | |
365 | * @key: the node's key. | |
366 | * @new_node: the new node to use as replacement. | |
f0c29ed7 | 367 | * |
9357c415 | 368 | * Return 0 if replacement is successful, negative value otherwise. |
2e79c445 MD |
369 | * Replacing a NULL old node or an already removed node will fail with |
370 | * -ENOENT. | |
371 | * If the hash or value of the node to replace and the new node differ, | |
372 | * this function returns -EINVAL without proceeding to the replacement. | |
9357c415 MD |
373 | * Old node can be looked up with cds_lfht_lookup and cds_lfht_next. |
374 | * RCU read-side lock must be held between lookup and replacement. | |
375 | * Call with rcu_read_lock held. | |
3df0c49c | 376 | * Threads calling this API need to be registered RCU read-side threads. |
9357c415 MD |
377 | * After successful replacement, a grace period must be waited for before |
378 | * freeing the memory reserved for the old node (which can be accessed | |
379 | * with cds_lfht_iter_get_node). | |
380 | * | |
3a9c66db MD |
381 | * The semantic of replacement vs lookups is the same as |
382 | * cds_lfht_add_replace(). | |
7b783f81 MD |
383 | * |
384 | * Upon success, this function issues a full memory barrier before and | |
385 | * after its atomic commit. Upon failure, this function does not issue | |
386 | * any memory barrier. | |
9357c415 | 387 | */ |
b9c27904 | 388 | extern |
2e79c445 MD |
389 | int cds_lfht_replace(struct cds_lfht *ht, |
390 | struct cds_lfht_iter *old_iter, | |
391 | unsigned long hash, | |
392 | cds_lfht_match_fct match, | |
393 | const void *key, | |
9357c415 MD |
394 | struct cds_lfht_node *new_node); |
395 | ||
396 | /* | |
397 | * cds_lfht_del - remove node pointed to by iterator from hash table. | |
0422d92c | 398 | * @ht: the hash table. |
bc8c3c74 | 399 | * @node: the node to delete. |
9357c415 MD |
400 | * |
401 | * Return 0 if the node is successfully removed, negative value | |
402 | * otherwise. | |
bc8c3c74 | 403 | * Deleting a NULL node or an already removed node will fail with a |
9357c415 | 404 | * negative value. |
bc8c3c74 MD |
405 | * Node can be looked up with cds_lfht_lookup and cds_lfht_next, |
406 | * followed by use of cds_lfht_iter_get_node. | |
9357c415 | 407 | * RCU read-side lock must be held between lookup and removal. |
f0c29ed7 | 408 | * Call with rcu_read_lock held. |
3df0c49c | 409 | * Threads calling this API need to be registered RCU read-side threads. |
48ed1c18 | 410 | * After successful removal, a grace period must be waited for before |
9357c415 MD |
411 | * freeing the memory reserved for old node (which can be accessed with |
412 | * cds_lfht_iter_get_node). | |
7b783f81 MD |
413 | * Upon success, this function issues a full memory barrier before and |
414 | * after its atomic commit. Upon failure, this function does not issue | |
415 | * any memory barrier. | |
f0c29ed7 | 416 | */ |
b9c27904 | 417 | extern |
bc8c3c74 | 418 | int cds_lfht_del(struct cds_lfht *ht, struct cds_lfht_node *node); |
ab7d5fc6 | 419 | |
df55172a | 420 | /* |
3a9c66db | 421 | * cds_lfht_is_node_deleted - query whether a node is removed from hash table. |
df55172a MD |
422 | * |
423 | * Return non-zero if the node is deleted from the hash table, 0 | |
424 | * otherwise. | |
425 | * Node can be looked up with cds_lfht_lookup and cds_lfht_next, | |
426 | * followed by use of cds_lfht_iter_get_node. | |
427 | * RCU read-side lock must be held between lookup and call to this | |
428 | * function. | |
429 | * Call with rcu_read_lock held. | |
430 | * Threads calling this API need to be registered RCU read-side threads. | |
7b783f81 | 431 | * This function does not issue any memory barrier. |
df55172a | 432 | */ |
b9c27904 | 433 | extern |
df55172a MD |
434 | int cds_lfht_is_node_deleted(struct cds_lfht_node *node); |
435 | ||
f0c29ed7 | 436 | /* |
14044b37 | 437 | * cds_lfht_resize - Force a hash table resize |
0422d92c | 438 | * @ht: the hash table. |
1475579c | 439 | * @new_size: update to this hash table size. |
3df0c49c MD |
440 | * |
441 | * Threads calling this API need to be registered RCU read-side threads. | |
7b783f81 | 442 | * This function does not (necessarily) issue memory barriers. |
43387742 MD |
443 | * cds_lfht_resize should *not* be called from a RCU read-side critical |
444 | * section. | |
f0c29ed7 | 445 | */ |
b9c27904 | 446 | extern |
1475579c | 447 | void cds_lfht_resize(struct cds_lfht *ht, unsigned long new_size); |
464a1ec9 | 448 | |
6d320126 | 449 | /* |
3a9c66db MD |
450 | * Note: it is safe to perform element removal (del), replacement, or |
451 | * any hash table update operation during any of the following hash | |
452 | * table traversals. | |
7b783f81 | 453 | * These functions act as rcu_dereference() to read the node pointers. |
6d320126 MD |
454 | */ |
455 | #define cds_lfht_for_each(ht, iter, node) \ | |
456 | for (cds_lfht_first(ht, iter), \ | |
457 | node = cds_lfht_iter_get_node(iter); \ | |
458 | node != NULL; \ | |
459 | cds_lfht_next(ht, iter), \ | |
460 | node = cds_lfht_iter_get_node(iter)) | |
461 | ||
6f554439 LJ |
462 | #define cds_lfht_for_each_duplicate(ht, hash, match, key, iter, node) \ |
463 | for (cds_lfht_lookup(ht, hash, match, key, iter), \ | |
6d320126 MD |
464 | node = cds_lfht_iter_get_node(iter); \ |
465 | node != NULL; \ | |
466 | cds_lfht_next_duplicate(ht, match, key, iter), \ | |
467 | node = cds_lfht_iter_get_node(iter)) | |
468 | ||
469 | #define cds_lfht_for_each_entry(ht, iter, pos, member) \ | |
470 | for (cds_lfht_first(ht, iter), \ | |
471 | pos = caa_container_of(cds_lfht_iter_get_node(iter), \ | |
bdffa73a | 472 | __typeof__(*(pos)), member); \ |
0b0627bf | 473 | &(pos)->member != NULL; \ |
6d320126 MD |
474 | cds_lfht_next(ht, iter), \ |
475 | pos = caa_container_of(cds_lfht_iter_get_node(iter), \ | |
bdffa73a | 476 | __typeof__(*(pos)), member)) |
6d320126 | 477 | |
6f554439 | 478 | #define cds_lfht_for_each_entry_duplicate(ht, hash, match, key, \ |
6d320126 | 479 | iter, pos, member) \ |
6f554439 | 480 | for (cds_lfht_lookup(ht, hash, match, key, iter), \ |
6d320126 | 481 | pos = caa_container_of(cds_lfht_iter_get_node(iter), \ |
bdffa73a | 482 | __typeof__(*(pos)), member); \ |
0b0627bf | 483 | &(pos)->member != NULL; \ |
6d320126 MD |
484 | cds_lfht_next_duplicate(ht, match, key, iter), \ |
485 | pos = caa_container_of(cds_lfht_iter_get_node(iter), \ | |
bdffa73a | 486 | __typeof__(*(pos)), member)) |
6d320126 | 487 | |
01389791 MD |
488 | #ifdef __cplusplus |
489 | } | |
490 | #endif | |
491 | ||
a42cc659 | 492 | #endif /* _URCU_RCULFHASH_H */ |