| 1 | #ifndef _URCU_RCULFHASH_H |
| 2 | #define _URCU_RCULFHASH_H |
| 3 | |
| 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> |
| 10 | * Copyright 2011 - Lai Jiangshan <laijs@cn.fujitsu.com> |
| 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 |
| 25 | * |
| 26 | * Include this file _after_ including your URCU flavor. |
| 27 | */ |
| 28 | |
| 29 | #include <stdint.h> |
| 30 | #include <urcu/compiler.h> |
| 31 | #include <urcu-call-rcu.h> |
| 32 | #include <urcu-flavor.h> |
| 33 | |
| 34 | #ifdef __cplusplus |
| 35 | extern "C" { |
| 36 | #endif |
| 37 | |
| 38 | /* |
| 39 | * cds_lfht_node: Contains the next pointers and reverse-hash |
| 40 | * value required for lookup and traversal of the hash table. |
| 41 | * |
| 42 | * struct cds_lfht_node should be aligned on 8-bytes boundaries because |
| 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. |
| 51 | * |
| 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. |
| 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. |
| 59 | */ |
| 60 | struct cds_lfht_node { |
| 61 | struct cds_lfht_node *next; /* ptr | REMOVAL_OWNER_FLAG | BUCKET_FLAG | REMOVED_FLAG */ |
| 62 | unsigned long reverse_hash; |
| 63 | } __attribute__((aligned(8))); |
| 64 | |
| 65 | /* cds_lfht_iter: Used to track state while traversing a hash chain. */ |
| 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 | |
| 76 | struct cds_lfht; |
| 77 | |
| 78 | /* |
| 79 | * Caution ! |
| 80 | * Ensure reader and writer threads are registered as urcu readers. |
| 81 | */ |
| 82 | |
| 83 | typedef int (*cds_lfht_match_fct)(struct cds_lfht_node *node, const void *key); |
| 84 | |
| 85 | /* |
| 86 | * cds_lfht_node_init - initialize a hash table node |
| 87 | * @node: the node to initialize. |
| 88 | * |
| 89 | * This function is kept to be eventually used for debugging purposes |
| 90 | * (detection of memory corruption). |
| 91 | */ |
| 92 | static inline |
| 93 | void cds_lfht_node_init(struct cds_lfht_node *node) |
| 94 | { |
| 95 | } |
| 96 | |
| 97 | /* |
| 98 | * Hash table creation flags. |
| 99 | */ |
| 100 | enum { |
| 101 | CDS_LFHT_AUTO_RESIZE = (1U << 0), |
| 102 | CDS_LFHT_ACCOUNTING = (1U << 1), |
| 103 | }; |
| 104 | |
| 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; |
| 115 | extern const struct cds_lfht_mm_type cds_lfht_mm_chunk; |
| 116 | extern const struct cds_lfht_mm_type cds_lfht_mm_mmap; |
| 117 | |
| 118 | /* |
| 119 | * _cds_lfht_new - API used by cds_lfht_new wrapper. Do not use directly. |
| 120 | */ |
| 121 | struct cds_lfht *_cds_lfht_new(unsigned long init_size, |
| 122 | unsigned long min_nr_alloc_buckets, |
| 123 | unsigned long max_nr_buckets, |
| 124 | int flags, |
| 125 | const struct cds_lfht_mm_type *mm, |
| 126 | const struct rcu_flavor_struct *flavor, |
| 127 | pthread_attr_t *attr); |
| 128 | |
| 129 | /* |
| 130 | * cds_lfht_new - allocate a hash table. |
| 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) |
| 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. |
| 139 | * CDS_LFHT_ACCOUNTING: count the number of node addition |
| 140 | * and removal in the table |
| 141 | * @attr: optional resize worker thread attributes. NULL for default. |
| 142 | * |
| 143 | * Return NULL on error. |
| 144 | * Note: the RCU flavor must be already included before the hash table header. |
| 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. |
| 153 | * Threads calling this API are NOT required to be registered RCU read-side |
| 154 | * threads. It can be called very early.(before rcu is initialized ...etc.) |
| 155 | */ |
| 156 | static inline |
| 157 | struct cds_lfht *cds_lfht_new(unsigned long init_size, |
| 158 | unsigned long min_nr_alloc_buckets, |
| 159 | unsigned long max_nr_buckets, |
| 160 | int flags, |
| 161 | pthread_attr_t *attr) |
| 162 | { |
| 163 | return _cds_lfht_new(init_size, min_nr_alloc_buckets, max_nr_buckets, |
| 164 | flags, NULL, &rcu_flavor, attr); |
| 165 | } |
| 166 | |
| 167 | /* |
| 168 | * cds_lfht_destroy - destroy a hash table. |
| 169 | * @ht: the hash table to destroy. |
| 170 | * @attr: (output) resize worker thread attributes, as received by cds_lfht_new. |
| 171 | * The caller will typically want to free this pointer if dynamically |
| 172 | * allocated. The attr point can be NULL if the caller does not |
| 173 | * need to be informed of the value passed to cds_lfht_new(). |
| 174 | * |
| 175 | * Return 0 on success, negative error value on error. |
| 176 | * Threads calling this API need to be registered RCU read-side threads. |
| 177 | */ |
| 178 | int cds_lfht_destroy(struct cds_lfht *ht, pthread_attr_t **attr); |
| 179 | |
| 180 | /* |
| 181 | * cds_lfht_count_nodes - count the number of nodes in the hash table. |
| 182 | * @ht: the hash table. |
| 183 | * @split_count_before: Sample the node count split-counter before traversal. |
| 184 | * @count: Traverse the hash table, count the number of nodes observed. |
| 185 | * @split_count_after: Sample the node count split-counter after traversal. |
| 186 | * |
| 187 | * Call with rcu_read_lock held. |
| 188 | * Threads calling this API need to be registered RCU read-side threads. |
| 189 | */ |
| 190 | void cds_lfht_count_nodes(struct cds_lfht *ht, |
| 191 | long *split_count_before, |
| 192 | unsigned long *count, |
| 193 | long *split_count_after); |
| 194 | |
| 195 | /* |
| 196 | * cds_lfht_lookup - lookup a node by key. |
| 197 | * @ht: the hash table. |
| 198 | * @hash: the key hash. |
| 199 | * @match: the key match function. |
| 200 | * @key: the current node key. |
| 201 | * @iter: Node, if found (output). *iter->node set to NULL if not found. |
| 202 | * |
| 203 | * Call with rcu_read_lock held. |
| 204 | * Threads calling this API need to be registered RCU read-side threads. |
| 205 | */ |
| 206 | void cds_lfht_lookup(struct cds_lfht *ht, unsigned long hash, |
| 207 | cds_lfht_match_fct match, const void *key, |
| 208 | struct cds_lfht_iter *iter); |
| 209 | |
| 210 | /* |
| 211 | * cds_lfht_next_duplicate - get the next item with same key (after a lookup). |
| 212 | * @ht: the hash table. |
| 213 | * @match: the key match function. |
| 214 | * @key: the current node key. |
| 215 | * @iter: Node, if found (output). *iter->node set to NULL if not found. |
| 216 | * |
| 217 | * Uses an iterator initialized by a lookup. Important: the iterator |
| 218 | * _needs_ to be initialized before calling cds_lfht_next_duplicate. |
| 219 | * Sets *iter-node to the following node with same key. |
| 220 | * Sets *iter->node to NULL if no following node exists with same key. |
| 221 | * RCU read-side lock must be held across cds_lfht_lookup and |
| 222 | * cds_lfht_next calls, and also between cds_lfht_next calls using the |
| 223 | * node returned by a previous cds_lfht_next. |
| 224 | * Call with rcu_read_lock held. |
| 225 | * Threads calling this API need to be registered RCU read-side threads. |
| 226 | */ |
| 227 | void cds_lfht_next_duplicate(struct cds_lfht *ht, |
| 228 | cds_lfht_match_fct match, const void *key, |
| 229 | struct cds_lfht_iter *iter); |
| 230 | |
| 231 | /* |
| 232 | * cds_lfht_first - get the first node in the table. |
| 233 | * @ht: the hash table. |
| 234 | * @iter: First node, if exists (output). *iter->node set to NULL if not found. |
| 235 | * |
| 236 | * Output in "*iter". *iter->node set to NULL if table is empty. |
| 237 | * Call with rcu_read_lock held. |
| 238 | * Threads calling this API need to be registered RCU read-side threads. |
| 239 | */ |
| 240 | void cds_lfht_first(struct cds_lfht *ht, struct cds_lfht_iter *iter); |
| 241 | |
| 242 | /* |
| 243 | * cds_lfht_next - get the next node in the table. |
| 244 | * @ht: the hash table. |
| 245 | * @iter: Next node, if exists (output). *iter->node set to NULL if not found. |
| 246 | * |
| 247 | * Input/Output in "*iter". *iter->node set to NULL if *iter was |
| 248 | * pointing to the last table node. |
| 249 | * Call with rcu_read_lock held. |
| 250 | * Threads calling this API need to be registered RCU read-side threads. |
| 251 | */ |
| 252 | void cds_lfht_next(struct cds_lfht *ht, struct cds_lfht_iter *iter); |
| 253 | |
| 254 | /* |
| 255 | * cds_lfht_add - add a node to the hash table. |
| 256 | * @ht: the hash table. |
| 257 | * @hash: the key hash. |
| 258 | * @node: the node to add. |
| 259 | * |
| 260 | * This function supports adding redundant keys into the table. |
| 261 | * Call with rcu_read_lock held. |
| 262 | * Threads calling this API need to be registered RCU read-side threads. |
| 263 | */ |
| 264 | void cds_lfht_add(struct cds_lfht *ht, unsigned long hash, |
| 265 | struct cds_lfht_node *node); |
| 266 | |
| 267 | /* |
| 268 | * cds_lfht_add_unique - add a node to hash table, if key is not present. |
| 269 | * @ht: the hash table. |
| 270 | * @hash: the node's hash. |
| 271 | * @match: the key match function. |
| 272 | * @key: the node's key. |
| 273 | * @node: the node to try adding. |
| 274 | * |
| 275 | * Return the node added upon success. |
| 276 | * Return the unique node already present upon failure. If |
| 277 | * cds_lfht_add_unique fails, the node passed as parameter should be |
| 278 | * freed by the caller. |
| 279 | * Call with rcu_read_lock held. |
| 280 | * Threads calling this API need to be registered RCU read-side threads. |
| 281 | * |
| 282 | * The semantic of this function is that if only this function is used |
| 283 | * to add keys into the table, no duplicated keys should ever be |
| 284 | * observable in the table. The same guarantee apply for combination of |
| 285 | * add_unique and add_replace (see below). |
| 286 | */ |
| 287 | struct cds_lfht_node *cds_lfht_add_unique(struct cds_lfht *ht, |
| 288 | unsigned long hash, |
| 289 | cds_lfht_match_fct match, |
| 290 | const void *key, |
| 291 | struct cds_lfht_node *node); |
| 292 | |
| 293 | /* |
| 294 | * cds_lfht_add_replace - replace or add a node within hash table. |
| 295 | * @ht: the hash table. |
| 296 | * @hash: the node's hash. |
| 297 | * @match: the key match function. |
| 298 | * @key: the node's key. |
| 299 | * @node: the node to add. |
| 300 | * |
| 301 | * Return the node replaced upon success. If no node matching the key |
| 302 | * was present, return NULL, which also means the operation succeeded. |
| 303 | * This replacement operation should never fail. |
| 304 | * Call with rcu_read_lock held. |
| 305 | * Threads calling this API need to be registered RCU read-side threads. |
| 306 | * After successful replacement, a grace period must be waited for before |
| 307 | * freeing the memory reserved for the returned node. |
| 308 | * |
| 309 | * The semantic of replacement vs lookups is the following: if lookups |
| 310 | * are performed between a key unique insertion and its removal, we |
| 311 | * guarantee that the lookups and get next will always find exactly one |
| 312 | * instance of the key if it is replaced concurrently with the lookups. |
| 313 | * |
| 314 | * Providing this semantic allows us to ensure that replacement-only |
| 315 | * schemes will never generate duplicated keys. It also allows us to |
| 316 | * guarantee that a combination of add_replace and add_unique updates |
| 317 | * will never generate duplicated keys. |
| 318 | */ |
| 319 | struct cds_lfht_node *cds_lfht_add_replace(struct cds_lfht *ht, |
| 320 | unsigned long hash, |
| 321 | cds_lfht_match_fct match, |
| 322 | const void *key, |
| 323 | struct cds_lfht_node *node); |
| 324 | |
| 325 | /* |
| 326 | * cds_lfht_replace - replace a node pointed to by iter within hash table. |
| 327 | * @ht: the hash table. |
| 328 | * @old_iter: the iterator position of the node to replace. |
| 329 | * @hash: the node's hash. |
| 330 | * @match: the key match function. |
| 331 | * @key: the node's key. |
| 332 | * @new_node: the new node to use as replacement. |
| 333 | * |
| 334 | * Return 0 if replacement is successful, negative value otherwise. |
| 335 | * Replacing a NULL old node or an already removed node will fail with |
| 336 | * -ENOENT. |
| 337 | * If the hash or value of the node to replace and the new node differ, |
| 338 | * this function returns -EINVAL without proceeding to the replacement. |
| 339 | * Old node can be looked up with cds_lfht_lookup and cds_lfht_next. |
| 340 | * RCU read-side lock must be held between lookup and replacement. |
| 341 | * Call with rcu_read_lock held. |
| 342 | * Threads calling this API need to be registered RCU read-side threads. |
| 343 | * After successful replacement, a grace period must be waited for before |
| 344 | * freeing the memory reserved for the old node (which can be accessed |
| 345 | * with cds_lfht_iter_get_node). |
| 346 | * |
| 347 | * The semantic of replacement vs lookups is the following: if lookups |
| 348 | * are performed between a key unique insertion and its removal, we |
| 349 | * guarantee that the lookups and get next will always find exactly one |
| 350 | * instance of the key if it is replaced concurrently with the lookups. |
| 351 | * |
| 352 | * Providing this semantic allows us to ensure that replacement-only |
| 353 | * schemes will never generate duplicated keys. It also allows us to |
| 354 | * guarantee that a combination of add_replace and add_unique updates |
| 355 | * will never generate duplicated keys. |
| 356 | */ |
| 357 | int cds_lfht_replace(struct cds_lfht *ht, |
| 358 | struct cds_lfht_iter *old_iter, |
| 359 | unsigned long hash, |
| 360 | cds_lfht_match_fct match, |
| 361 | const void *key, |
| 362 | struct cds_lfht_node *new_node); |
| 363 | |
| 364 | /* |
| 365 | * cds_lfht_del - remove node pointed to by iterator from hash table. |
| 366 | * @ht: the hash table. |
| 367 | * @node: the node to delete. |
| 368 | * |
| 369 | * Return 0 if the node is successfully removed, negative value |
| 370 | * otherwise. |
| 371 | * Deleting a NULL node or an already removed node will fail with a |
| 372 | * negative value. |
| 373 | * Node can be looked up with cds_lfht_lookup and cds_lfht_next, |
| 374 | * followed by use of cds_lfht_iter_get_node. |
| 375 | * RCU read-side lock must be held between lookup and removal. |
| 376 | * Call with rcu_read_lock held. |
| 377 | * Threads calling this API need to be registered RCU read-side threads. |
| 378 | * After successful removal, a grace period must be waited for before |
| 379 | * freeing the memory reserved for old node (which can be accessed with |
| 380 | * cds_lfht_iter_get_node). |
| 381 | */ |
| 382 | int cds_lfht_del(struct cds_lfht *ht, struct cds_lfht_node *node); |
| 383 | |
| 384 | /* |
| 385 | * cds_lfht_is_node_deleted - query if a node is removed from hash table. |
| 386 | * |
| 387 | * Return non-zero if the node is deleted from the hash table, 0 |
| 388 | * otherwise. |
| 389 | * Node can be looked up with cds_lfht_lookup and cds_lfht_next, |
| 390 | * followed by use of cds_lfht_iter_get_node. |
| 391 | * RCU read-side lock must be held between lookup and call to this |
| 392 | * function. |
| 393 | * Call with rcu_read_lock held. |
| 394 | * Threads calling this API need to be registered RCU read-side threads. |
| 395 | */ |
| 396 | int cds_lfht_is_node_deleted(struct cds_lfht_node *node); |
| 397 | |
| 398 | /* |
| 399 | * cds_lfht_resize - Force a hash table resize |
| 400 | * @ht: the hash table. |
| 401 | * @new_size: update to this hash table size. |
| 402 | * |
| 403 | * Threads calling this API need to be registered RCU read-side threads. |
| 404 | */ |
| 405 | void cds_lfht_resize(struct cds_lfht *ht, unsigned long new_size); |
| 406 | |
| 407 | /* |
| 408 | * Note: cds_lfht_for_each are safe for element removal during |
| 409 | * iteration. |
| 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 | |
| 418 | #define cds_lfht_for_each_duplicate(ht, hash, match, key, iter, node) \ |
| 419 | for (cds_lfht_lookup(ht, hash, match, key, iter), \ |
| 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); \ |
| 429 | &(pos)->member != NULL; \ |
| 430 | cds_lfht_next(ht, iter), \ |
| 431 | pos = caa_container_of(cds_lfht_iter_get_node(iter), \ |
| 432 | typeof(*(pos)), member)) |
| 433 | |
| 434 | #define cds_lfht_for_each_entry_duplicate(ht, hash, match, key, \ |
| 435 | iter, pos, member) \ |
| 436 | for (cds_lfht_lookup(ht, hash, match, key, iter), \ |
| 437 | pos = caa_container_of(cds_lfht_iter_get_node(iter), \ |
| 438 | typeof(*(pos)), member); \ |
| 439 | &(pos)->member != NULL; \ |
| 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 | |
| 444 | #ifdef __cplusplus |
| 445 | } |
| 446 | #endif |
| 447 | |
| 448 | #endif /* _URCU_RCULFHASH_H */ |