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