4 * Userspace RCU library - Lock-Free Resizable RCU Hash Table
6 * Copyright 2010-2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 * Copyright 2011 - Lai Jiangshan <laijs@cn.fujitsu.com>
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 * Based on the following articles:
26 * - Ori Shalev and Nir Shavit. Split-ordered lists: Lock-free
27 * extensible hash tables. J. ACM 53, 3 (May 2006), 379-405.
28 * - Michael, M. M. High performance dynamic lock-free hash tables
29 * and list-based sets. In Proceedings of the fourteenth annual ACM
30 * symposium on Parallel algorithms and architectures, ACM Press,
33 * Some specificities of this Lock-Free Resizable RCU Hash Table
36 * - RCU read-side critical section allows readers to perform hash
37 * table lookups and use the returned objects safely by delaying
38 * memory reclaim of a grace period.
39 * - Add and remove operations are lock-free, and do not need to
40 * allocate memory. They need to be executed within RCU read-side
41 * critical section to ensure the objects they read are valid and to
42 * deal with the cmpxchg ABA problem.
43 * - add and add_unique operations are supported. add_unique checks if
44 * the node key already exists in the hash table. It ensures no key
46 * - The resize operation executes concurrently with add/remove/lookup.
47 * - Hash table nodes are contained within a split-ordered list. This
48 * list is ordered by incrementing reversed-bits-hash value.
49 * - An index of bucket nodes is kept. These bucket nodes are the hash
50 * table "buckets", and they are also chained together in the
51 * split-ordered list, which allows recursive expansion.
52 * - The resize operation for small tables only allows expanding the hash table.
53 * It is triggered automatically by detecting long chains in the add
55 * - The resize operation for larger tables (and available through an
56 * API) allows both expanding and shrinking the hash table.
57 * - Split-counters are used to keep track of the number of
58 * nodes within the hash table for automatic resize triggering.
59 * - Resize operation initiated by long chain detection is executed by a
60 * call_rcu thread, which keeps lock-freedom of add and remove.
61 * - Resize operations are protected by a mutex.
62 * - The removal operation is split in two parts: first, a "removed"
63 * flag is set in the next pointer within the node to remove. Then,
64 * a "garbage collection" is performed in the bucket containing the
65 * removed node (from the start of the bucket up to the removed node).
66 * All encountered nodes with "removed" flag set in their next
67 * pointers are removed from the linked-list. If the cmpxchg used for
68 * removal fails (due to concurrent garbage-collection or concurrent
69 * add), we retry from the beginning of the bucket. This ensures that
70 * the node with "removed" flag set is removed from the hash table
71 * (not visible to lookups anymore) before the RCU read-side critical
72 * section held across removal ends. Furthermore, this ensures that
73 * the node with "removed" flag set is removed from the linked-list
74 * before its memory is reclaimed. Only the thread which removal
75 * successfully set the "removed" flag (with a cmpxchg) into a node's
76 * next pointer is considered to have succeeded its removal (and thus
77 * owns the node to reclaim). Because we garbage-collect starting from
78 * an invariant node (the start-of-bucket bucket node) up to the
79 * "removed" node (or find a reverse-hash that is higher), we are sure
80 * that a successful traversal of the chain leads to a chain that is
81 * present in the linked-list (the start node is never removed) and
82 * that is does not contain the "removed" node anymore, even if
83 * concurrent delete/add operations are changing the structure of the
85 * - The add operation performs gargage collection of buckets if it
86 * encounters nodes with removed flag set in the bucket where it wants
87 * to add its new node. This ensures lock-freedom of add operation by
88 * helping the remover unlink nodes from the list rather than to wait
90 * - A RCU "order table" indexed by log2(hash index) is copied and
91 * expanded by the resize operation. This order table allows finding
92 * the "bucket node" tables.
93 * - There is one bucket node table per hash index order. The size of
94 * each bucket node table is half the number of hashes contained in
95 * this order (except for order 0).
96 * - synchronzie_rcu is used to garbage-collect the old bucket node table.
97 * - The per-order bucket node tables contain a compact version of the
98 * hash table nodes. These tables are invariant after they are
99 * populated into the hash table.
101 * Bucket node tables:
103 * hash table hash table the last all bucket node tables
104 * order size bucket node 0 1 2 3 4 5 6(index)
111 * 5 32 16 1 1 2 4 8 16
112 * 6 64 32 1 1 2 4 8 16 32
114 * When growing/shrinking, we only focus on the last bucket node table
115 * which size is (!order ? 1 : (1 << (order -1))).
117 * Example for growing/shrinking:
118 * grow hash table from order 5 to 6: init the index=6 bucket node table
119 * shrink hash table from order 6 to 5: fini the index=6 bucket node table
121 * A bit of ascii art explanation:
123 * Order index is the off-by-one compare to the actual power of 2 because
124 * we use index 0 to deal with the 0 special-case.
126 * This shows the nodes for a small table ordered by reversed bits:
138 * This shows the nodes in order of non-reversed bits, linked by
139 * reversed-bit order.
144 * 2 | | 2 010 010 <- |
145 * | | | 3 011 110 | <- |
146 * 3 -> | | | 4 100 001 | |
162 #include <urcu-call-rcu.h>
163 #include <urcu-flavor.h>
164 #include <urcu/arch.h>
165 #include <urcu/uatomic.h>
166 #include <urcu/compiler.h>
167 #include <urcu/rculfhash.h>
168 #include <rculfhash-internal.h>
173 * Split-counters lazily update the global counter each 1024
174 * addition/removal. It automatically keeps track of resize required.
175 * We use the bucket length as indicator for need to expand for small
176 * tables and machines lacking per-cpu data suppport.
178 #define COUNT_COMMIT_ORDER 10
179 #define DEFAULT_SPLIT_COUNT_MASK 0xFUL
180 #define CHAIN_LEN_TARGET 1
181 #define CHAIN_LEN_RESIZE_THRESHOLD 3
184 * Define the minimum table size.
186 #define MIN_TABLE_ORDER 0
187 #define MIN_TABLE_SIZE (1UL << MIN_TABLE_ORDER)
190 * Minimum number of bucket nodes to touch per thread to parallelize grow/shrink.
192 #define MIN_PARTITION_PER_THREAD_ORDER 12
193 #define MIN_PARTITION_PER_THREAD (1UL << MIN_PARTITION_PER_THREAD_ORDER)
196 * The removed flag needs to be updated atomically with the pointer.
197 * It indicates that no node must attach to the node scheduled for
198 * removal, and that node garbage collection must be performed.
199 * The bucket flag does not require to be updated atomically with the
200 * pointer, but it is added as a pointer low bit flag to save space.
202 #define REMOVED_FLAG (1UL << 0)
203 #define BUCKET_FLAG (1UL << 1)
204 #define FLAGS_MASK ((1UL << 2) - 1)
206 /* Value of the end pointer. Should not interact with flags. */
207 #define END_VALUE NULL
210 * ht_items_count: Split-counters counting the number of node addition
211 * and removal in the table. Only used if the CDS_LFHT_ACCOUNTING flag
212 * is set at hash table creation.
214 * These are free-running counters, never reset to zero. They count the
215 * number of add/remove, and trigger every (1 << COUNT_COMMIT_ORDER)
216 * operations to update the global counter. We choose a power-of-2 value
217 * for the trigger to deal with 32 or 64-bit overflow of the counter.
219 struct ht_items_count
{
220 unsigned long add
, del
;
221 } __attribute__((aligned(CAA_CACHE_LINE_SIZE
)));
224 * rcu_resize_work: Contains arguments passed to RCU worker thread
225 * responsible for performing lazy resize.
227 struct rcu_resize_work
{
228 struct rcu_head head
;
233 * partition_resize_work: Contains arguments passed to worker threads
234 * executing the hash table resize on partitions of the hash table
235 * assigned to each processor's worker thread.
237 struct partition_resize_work
{
240 unsigned long i
, start
, len
;
241 void (*fct
)(struct cds_lfht
*ht
, unsigned long i
,
242 unsigned long start
, unsigned long len
);
246 * Algorithm to reverse bits in a word by lookup table, extended to
249 * http://graphics.stanford.edu/~seander/bithacks.html#BitReverseTable
250 * Originally from Public Domain.
253 static const uint8_t BitReverseTable256
[256] =
255 #define R2(n) (n), (n) + 2*64, (n) + 1*64, (n) + 3*64
256 #define R4(n) R2(n), R2((n) + 2*16), R2((n) + 1*16), R2((n) + 3*16)
257 #define R6(n) R4(n), R4((n) + 2*4 ), R4((n) + 1*4 ), R4((n) + 3*4 )
258 R6(0), R6(2), R6(1), R6(3)
265 uint8_t bit_reverse_u8(uint8_t v
)
267 return BitReverseTable256
[v
];
270 static __attribute__((unused
))
271 uint32_t bit_reverse_u32(uint32_t v
)
273 return ((uint32_t) bit_reverse_u8(v
) << 24) |
274 ((uint32_t) bit_reverse_u8(v
>> 8) << 16) |
275 ((uint32_t) bit_reverse_u8(v
>> 16) << 8) |
276 ((uint32_t) bit_reverse_u8(v
>> 24));
279 static __attribute__((unused
))
280 uint64_t bit_reverse_u64(uint64_t v
)
282 return ((uint64_t) bit_reverse_u8(v
) << 56) |
283 ((uint64_t) bit_reverse_u8(v
>> 8) << 48) |
284 ((uint64_t) bit_reverse_u8(v
>> 16) << 40) |
285 ((uint64_t) bit_reverse_u8(v
>> 24) << 32) |
286 ((uint64_t) bit_reverse_u8(v
>> 32) << 24) |
287 ((uint64_t) bit_reverse_u8(v
>> 40) << 16) |
288 ((uint64_t) bit_reverse_u8(v
>> 48) << 8) |
289 ((uint64_t) bit_reverse_u8(v
>> 56));
293 unsigned long bit_reverse_ulong(unsigned long v
)
295 #if (CAA_BITS_PER_LONG == 32)
296 return bit_reverse_u32(v
);
298 return bit_reverse_u64(v
);
303 * fls: returns the position of the most significant bit.
304 * Returns 0 if no bit is set, else returns the position of the most
305 * significant bit (from 1 to 32 on 32-bit, from 1 to 64 on 64-bit).
307 #if defined(__i386) || defined(__x86_64)
309 unsigned int fls_u32(uint32_t x
)
317 : "=r" (r
) : "rm" (x
));
323 #if defined(__x86_64)
325 unsigned int fls_u64(uint64_t x
)
333 : "=r" (r
) : "rm" (x
));
340 static __attribute__((unused
))
341 unsigned int fls_u64(uint64_t x
)
348 if (!(x
& 0xFFFFFFFF00000000ULL
)) {
352 if (!(x
& 0xFFFF000000000000ULL
)) {
356 if (!(x
& 0xFF00000000000000ULL
)) {
360 if (!(x
& 0xF000000000000000ULL
)) {
364 if (!(x
& 0xC000000000000000ULL
)) {
368 if (!(x
& 0x8000000000000000ULL
)) {
377 static __attribute__((unused
))
378 unsigned int fls_u32(uint32_t x
)
384 if (!(x
& 0xFFFF0000U
)) {
388 if (!(x
& 0xFF000000U
)) {
392 if (!(x
& 0xF0000000U
)) {
396 if (!(x
& 0xC0000000U
)) {
400 if (!(x
& 0x80000000U
)) {
408 unsigned int fls_ulong(unsigned long x
)
410 #if (CAA_BITS_PER_LONG == 32)
418 * Return the minimum order for which x <= (1UL << order).
419 * Return -1 if x is 0.
421 int get_count_order_u32(uint32_t x
)
426 return fls_u32(x
- 1);
430 * Return the minimum order for which x <= (1UL << order).
431 * Return -1 if x is 0.
433 int get_count_order_ulong(unsigned long x
)
438 return fls_ulong(x
- 1);
442 void cds_lfht_resize_lazy_grow(struct cds_lfht
*ht
, unsigned long size
, int growth
);
445 void cds_lfht_resize_lazy_count(struct cds_lfht
*ht
, unsigned long size
,
446 unsigned long count
);
448 static long nr_cpus_mask
= -1;
449 static long split_count_mask
= -1;
451 #if defined(HAVE_SYSCONF)
452 static void ht_init_nr_cpus_mask(void)
456 maxcpus
= sysconf(_SC_NPROCESSORS_CONF
);
462 * round up number of CPUs to next power of two, so we
463 * can use & for modulo.
465 maxcpus
= 1UL << get_count_order_ulong(maxcpus
);
466 nr_cpus_mask
= maxcpus
- 1;
468 #else /* #if defined(HAVE_SYSCONF) */
469 static void ht_init_nr_cpus_mask(void)
473 #endif /* #else #if defined(HAVE_SYSCONF) */
476 void alloc_split_items_count(struct cds_lfht
*ht
)
478 struct ht_items_count
*count
;
480 if (nr_cpus_mask
== -1) {
481 ht_init_nr_cpus_mask();
482 if (nr_cpus_mask
< 0)
483 split_count_mask
= DEFAULT_SPLIT_COUNT_MASK
;
485 split_count_mask
= nr_cpus_mask
;
488 assert(split_count_mask
>= 0);
490 if (ht
->flags
& CDS_LFHT_ACCOUNTING
) {
491 ht
->split_count
= calloc(split_count_mask
+ 1, sizeof(*count
));
492 assert(ht
->split_count
);
494 ht
->split_count
= NULL
;
499 void free_split_items_count(struct cds_lfht
*ht
)
501 poison_free(ht
->split_count
);
504 #if defined(HAVE_SCHED_GETCPU)
506 int ht_get_split_count_index(unsigned long hash
)
510 assert(split_count_mask
>= 0);
511 cpu
= sched_getcpu();
512 if (caa_unlikely(cpu
< 0))
513 return hash
& split_count_mask
;
515 return cpu
& split_count_mask
;
517 #else /* #if defined(HAVE_SCHED_GETCPU) */
519 int ht_get_split_count_index(unsigned long hash
)
521 return hash
& split_count_mask
;
523 #endif /* #else #if defined(HAVE_SCHED_GETCPU) */
526 void ht_count_add(struct cds_lfht
*ht
, unsigned long size
, unsigned long hash
)
528 unsigned long split_count
;
532 if (caa_unlikely(!ht
->split_count
))
534 index
= ht_get_split_count_index(hash
);
535 split_count
= uatomic_add_return(&ht
->split_count
[index
].add
, 1);
536 if (caa_likely(split_count
& ((1UL << COUNT_COMMIT_ORDER
) - 1)))
538 /* Only if number of add multiple of 1UL << COUNT_COMMIT_ORDER */
540 dbg_printf("add split count %lu\n", split_count
);
541 count
= uatomic_add_return(&ht
->count
,
542 1UL << COUNT_COMMIT_ORDER
);
543 if (caa_likely(count
& (count
- 1)))
545 /* Only if global count is power of 2 */
547 if ((count
>> CHAIN_LEN_RESIZE_THRESHOLD
) < size
)
549 dbg_printf("add set global %ld\n", count
);
550 cds_lfht_resize_lazy_count(ht
, size
,
551 count
>> (CHAIN_LEN_TARGET
- 1));
555 void ht_count_del(struct cds_lfht
*ht
, unsigned long size
, unsigned long hash
)
557 unsigned long split_count
;
561 if (caa_unlikely(!ht
->split_count
))
563 index
= ht_get_split_count_index(hash
);
564 split_count
= uatomic_add_return(&ht
->split_count
[index
].del
, 1);
565 if (caa_likely(split_count
& ((1UL << COUNT_COMMIT_ORDER
) - 1)))
567 /* Only if number of deletes multiple of 1UL << COUNT_COMMIT_ORDER */
569 dbg_printf("del split count %lu\n", split_count
);
570 count
= uatomic_add_return(&ht
->count
,
571 -(1UL << COUNT_COMMIT_ORDER
));
572 if (caa_likely(count
& (count
- 1)))
574 /* Only if global count is power of 2 */
576 if ((count
>> CHAIN_LEN_RESIZE_THRESHOLD
) >= size
)
578 dbg_printf("del set global %ld\n", count
);
580 * Don't shrink table if the number of nodes is below a
583 if (count
< (1UL << COUNT_COMMIT_ORDER
) * (split_count_mask
+ 1))
585 cds_lfht_resize_lazy_count(ht
, size
,
586 count
>> (CHAIN_LEN_TARGET
- 1));
590 void check_resize(struct cds_lfht
*ht
, unsigned long size
, uint32_t chain_len
)
594 if (!(ht
->flags
& CDS_LFHT_AUTO_RESIZE
))
596 count
= uatomic_read(&ht
->count
);
598 * Use bucket-local length for small table expand and for
599 * environments lacking per-cpu data support.
601 if (count
>= (1UL << COUNT_COMMIT_ORDER
))
604 dbg_printf("WARNING: large chain length: %u.\n",
606 if (chain_len
>= CHAIN_LEN_RESIZE_THRESHOLD
)
607 cds_lfht_resize_lazy_grow(ht
, size
,
608 get_count_order_u32(chain_len
- (CHAIN_LEN_TARGET
- 1)));
612 struct cds_lfht_node
*clear_flag(struct cds_lfht_node
*node
)
614 return (struct cds_lfht_node
*) (((unsigned long) node
) & ~FLAGS_MASK
);
618 int is_removed(struct cds_lfht_node
*node
)
620 return ((unsigned long) node
) & REMOVED_FLAG
;
624 struct cds_lfht_node
*flag_removed(struct cds_lfht_node
*node
)
626 return (struct cds_lfht_node
*) (((unsigned long) node
) | REMOVED_FLAG
);
630 int is_bucket(struct cds_lfht_node
*node
)
632 return ((unsigned long) node
) & BUCKET_FLAG
;
636 struct cds_lfht_node
*flag_bucket(struct cds_lfht_node
*node
)
638 return (struct cds_lfht_node
*) (((unsigned long) node
) | BUCKET_FLAG
);
642 struct cds_lfht_node
*get_end(void)
644 return (struct cds_lfht_node
*) END_VALUE
;
648 int is_end(struct cds_lfht_node
*node
)
650 return clear_flag(node
) == (struct cds_lfht_node
*) END_VALUE
;
654 unsigned long _uatomic_xchg_monotonic_increase(unsigned long *ptr
,
657 unsigned long old1
, old2
;
659 old1
= uatomic_read(ptr
);
664 } while ((old1
= uatomic_cmpxchg(ptr
, old2
, v
)) != old2
);
669 void cds_lfht_alloc_bucket_table(struct cds_lfht
*ht
, unsigned long order
)
671 return ht
->mm
->alloc_bucket_table(ht
, order
);
675 * cds_lfht_free_bucket_table() should be called with decreasing order.
676 * When cds_lfht_free_bucket_table(0) is called, it means the whole
680 void cds_lfht_free_bucket_table(struct cds_lfht
*ht
, unsigned long order
)
682 return ht
->mm
->free_bucket_table(ht
, order
);
686 struct cds_lfht_node
*bucket_at(struct cds_lfht
*ht
, unsigned long index
)
688 return ht
->bucket_at(ht
, index
);
692 struct cds_lfht_node
*lookup_bucket(struct cds_lfht
*ht
, unsigned long size
,
696 return bucket_at(ht
, hash
& (size
- 1));
700 * Remove all logically deleted nodes from a bucket up to a certain node key.
703 void _cds_lfht_gc_bucket(struct cds_lfht_node
*bucket
, struct cds_lfht_node
*node
)
705 struct cds_lfht_node
*iter_prev
, *iter
, *next
, *new_next
;
707 assert(!is_bucket(bucket
));
708 assert(!is_removed(bucket
));
709 assert(!is_bucket(node
));
710 assert(!is_removed(node
));
713 /* We can always skip the bucket node initially */
714 iter
= rcu_dereference(iter_prev
->next
);
715 assert(!is_removed(iter
));
716 assert(iter_prev
->reverse_hash
<= node
->reverse_hash
);
718 * We should never be called with bucket (start of chain)
719 * and logically removed node (end of path compression
720 * marker) being the actual same node. This would be a
721 * bug in the algorithm implementation.
723 assert(bucket
!= node
);
725 if (caa_unlikely(is_end(iter
)))
727 if (caa_likely(clear_flag(iter
)->reverse_hash
> node
->reverse_hash
))
729 next
= rcu_dereference(clear_flag(iter
)->next
);
730 if (caa_likely(is_removed(next
)))
732 iter_prev
= clear_flag(iter
);
735 assert(!is_removed(iter
));
737 new_next
= flag_bucket(clear_flag(next
));
739 new_next
= clear_flag(next
);
740 (void) uatomic_cmpxchg(&iter_prev
->next
, iter
, new_next
);
746 int _cds_lfht_replace(struct cds_lfht
*ht
, unsigned long size
,
747 struct cds_lfht_node
*old_node
,
748 struct cds_lfht_node
*old_next
,
749 struct cds_lfht_node
*new_node
)
751 struct cds_lfht_node
*bucket
, *ret_next
;
753 if (!old_node
) /* Return -ENOENT if asked to replace NULL node */
756 assert(!is_removed(old_node
));
757 assert(!is_bucket(old_node
));
758 assert(!is_removed(new_node
));
759 assert(!is_bucket(new_node
));
760 assert(new_node
!= old_node
);
762 /* Insert after node to be replaced */
763 if (is_removed(old_next
)) {
765 * Too late, the old node has been removed under us
766 * between lookup and replace. Fail.
770 assert(!is_bucket(old_next
));
771 assert(new_node
!= clear_flag(old_next
));
772 new_node
->next
= clear_flag(old_next
);
774 * Here is the whole trick for lock-free replace: we add
775 * the replacement node _after_ the node we want to
776 * replace by atomically setting its next pointer at the
777 * same time we set its removal flag. Given that
778 * the lookups/get next use an iterator aware of the
779 * next pointer, they will either skip the old node due
780 * to the removal flag and see the new node, or use
781 * the old node, but will not see the new one.
783 ret_next
= uatomic_cmpxchg(&old_node
->next
,
784 old_next
, flag_removed(new_node
));
785 if (ret_next
== old_next
)
786 break; /* We performed the replacement. */
791 * Ensure that the old node is not visible to readers anymore:
792 * lookup for the node, and remove it (along with any other
793 * logically removed node) if found.
795 bucket
= lookup_bucket(ht
, size
, bit_reverse_ulong(old_node
->reverse_hash
));
796 _cds_lfht_gc_bucket(bucket
, new_node
);
798 assert(is_removed(rcu_dereference(old_node
->next
)));
803 * A non-NULL unique_ret pointer uses the "add unique" (or uniquify) add
804 * mode. A NULL unique_ret allows creation of duplicate keys.
807 void _cds_lfht_add(struct cds_lfht
*ht
,
808 cds_lfht_match_fct match
,
811 struct cds_lfht_node
*node
,
812 struct cds_lfht_iter
*unique_ret
,
815 struct cds_lfht_node
*iter_prev
, *iter
, *next
, *new_node
, *new_next
,
817 struct cds_lfht_node
*bucket
;
819 assert(!is_bucket(node
));
820 assert(!is_removed(node
));
821 bucket
= lookup_bucket(ht
, size
, bit_reverse_ulong(node
->reverse_hash
));
823 uint32_t chain_len
= 0;
826 * iter_prev points to the non-removed node prior to the
830 /* We can always skip the bucket node initially */
831 iter
= rcu_dereference(iter_prev
->next
);
832 assert(iter_prev
->reverse_hash
<= node
->reverse_hash
);
834 if (caa_unlikely(is_end(iter
)))
836 if (caa_likely(clear_flag(iter
)->reverse_hash
> node
->reverse_hash
))
839 /* bucket node is the first node of the identical-hash-value chain */
840 if (bucket_flag
&& clear_flag(iter
)->reverse_hash
== node
->reverse_hash
)
843 next
= rcu_dereference(clear_flag(iter
)->next
);
844 if (caa_unlikely(is_removed(next
)))
850 && clear_flag(iter
)->reverse_hash
== node
->reverse_hash
) {
851 struct cds_lfht_iter d_iter
= { .node
= node
, .next
= iter
, };
854 * uniquely adding inserts the node as the first
855 * node of the identical-hash-value node chain.
857 * This semantic ensures no duplicated keys
858 * should ever be observable in the table
859 * (including observe one node by one node
860 * by forward iterations)
862 cds_lfht_next_duplicate(ht
, match
, key
, &d_iter
);
866 *unique_ret
= d_iter
;
870 /* Only account for identical reverse hash once */
871 if (iter_prev
->reverse_hash
!= clear_flag(iter
)->reverse_hash
873 check_resize(ht
, size
, ++chain_len
);
874 iter_prev
= clear_flag(iter
);
879 assert(node
!= clear_flag(iter
));
880 assert(!is_removed(iter_prev
));
881 assert(!is_removed(iter
));
882 assert(iter_prev
!= node
);
884 node
->next
= clear_flag(iter
);
886 node
->next
= flag_bucket(clear_flag(iter
));
888 new_node
= flag_bucket(node
);
891 if (uatomic_cmpxchg(&iter_prev
->next
, iter
,
893 continue; /* retry */
900 assert(!is_removed(iter
));
902 new_next
= flag_bucket(clear_flag(next
));
904 new_next
= clear_flag(next
);
905 (void) uatomic_cmpxchg(&iter_prev
->next
, iter
, new_next
);
910 unique_ret
->node
= return_node
;
911 /* unique_ret->next left unset, never used. */
916 int _cds_lfht_del(struct cds_lfht
*ht
, unsigned long size
,
917 struct cds_lfht_node
*node
,
920 struct cds_lfht_node
*bucket
, *next
, *old
;
922 if (!node
) /* Return -ENOENT if asked to delete NULL node */
925 /* logically delete the node */
926 assert(!is_bucket(node
));
927 assert(!is_removed(node
));
928 old
= rcu_dereference(node
->next
);
930 struct cds_lfht_node
*new_next
;
933 if (caa_unlikely(is_removed(next
)))
936 assert(is_bucket(next
));
938 assert(!is_bucket(next
));
939 new_next
= flag_removed(next
);
940 old
= uatomic_cmpxchg(&node
->next
, next
, new_next
);
941 } while (old
!= next
);
942 /* We performed the (logical) deletion. */
945 * Ensure that the node is not visible to readers anymore: lookup for
946 * the node, and remove it (along with any other logically removed node)
949 bucket
= lookup_bucket(ht
, size
, bit_reverse_ulong(node
->reverse_hash
));
950 _cds_lfht_gc_bucket(bucket
, node
);
952 assert(is_removed(rcu_dereference(node
->next
)));
957 void *partition_resize_thread(void *arg
)
959 struct partition_resize_work
*work
= arg
;
961 work
->ht
->flavor
->register_thread();
962 work
->fct(work
->ht
, work
->i
, work
->start
, work
->len
);
963 work
->ht
->flavor
->unregister_thread();
968 void partition_resize_helper(struct cds_lfht
*ht
, unsigned long i
,
970 void (*fct
)(struct cds_lfht
*ht
, unsigned long i
,
971 unsigned long start
, unsigned long len
))
973 unsigned long partition_len
;
974 struct partition_resize_work
*work
;
976 unsigned long nr_threads
;
979 * Note: nr_cpus_mask + 1 is always power of 2.
980 * We spawn just the number of threads we need to satisfy the minimum
981 * partition size, up to the number of CPUs in the system.
983 if (nr_cpus_mask
> 0) {
984 nr_threads
= min(nr_cpus_mask
+ 1,
985 len
>> MIN_PARTITION_PER_THREAD_ORDER
);
989 partition_len
= len
>> get_count_order_ulong(nr_threads
);
990 work
= calloc(nr_threads
, sizeof(*work
));
992 for (thread
= 0; thread
< nr_threads
; thread
++) {
993 work
[thread
].ht
= ht
;
995 work
[thread
].len
= partition_len
;
996 work
[thread
].start
= thread
* partition_len
;
997 work
[thread
].fct
= fct
;
998 ret
= pthread_create(&(work
[thread
].thread_id
), ht
->resize_attr
,
999 partition_resize_thread
, &work
[thread
]);
1002 for (thread
= 0; thread
< nr_threads
; thread
++) {
1003 ret
= pthread_join(work
[thread
].thread_id
, NULL
);
1010 * Holding RCU read lock to protect _cds_lfht_add against memory
1011 * reclaim that could be performed by other call_rcu worker threads (ABA
1014 * When we reach a certain length, we can split this population phase over
1015 * many worker threads, based on the number of CPUs available in the system.
1016 * This should therefore take care of not having the expand lagging behind too
1017 * many concurrent insertion threads by using the scheduler's ability to
1018 * schedule bucket node population fairly with insertions.
1021 void init_table_populate_partition(struct cds_lfht
*ht
, unsigned long i
,
1022 unsigned long start
, unsigned long len
)
1024 unsigned long j
, size
= 1UL << (i
- 1);
1026 assert(i
> MIN_TABLE_ORDER
);
1027 ht
->flavor
->read_lock();
1028 for (j
= size
+ start
; j
< size
+ start
+ len
; j
++) {
1029 struct cds_lfht_node
*new_node
= bucket_at(ht
, j
);
1031 assert(j
>= size
&& j
< (size
<< 1));
1032 dbg_printf("init populate: order %lu index %lu hash %lu\n",
1034 new_node
->reverse_hash
= bit_reverse_ulong(j
);
1035 _cds_lfht_add(ht
, NULL
, NULL
, size
, new_node
, NULL
, 1);
1037 ht
->flavor
->read_unlock();
1041 void init_table_populate(struct cds_lfht
*ht
, unsigned long i
,
1044 assert(nr_cpus_mask
!= -1);
1045 if (nr_cpus_mask
< 0 || len
< 2 * MIN_PARTITION_PER_THREAD
) {
1046 ht
->flavor
->thread_online();
1047 init_table_populate_partition(ht
, i
, 0, len
);
1048 ht
->flavor
->thread_offline();
1051 partition_resize_helper(ht
, i
, len
, init_table_populate_partition
);
1055 void init_table(struct cds_lfht
*ht
,
1056 unsigned long first_order
, unsigned long last_order
)
1060 dbg_printf("init table: first_order %lu last_order %lu\n",
1061 first_order
, last_order
);
1062 assert(first_order
> MIN_TABLE_ORDER
);
1063 for (i
= first_order
; i
<= last_order
; i
++) {
1066 len
= 1UL << (i
- 1);
1067 dbg_printf("init order %lu len: %lu\n", i
, len
);
1069 /* Stop expand if the resize target changes under us */
1070 if (CMM_LOAD_SHARED(ht
->resize_target
) < (1UL << i
))
1073 cds_lfht_alloc_bucket_table(ht
, i
);
1076 * Set all bucket nodes reverse hash values for a level and
1077 * link all bucket nodes into the table.
1079 init_table_populate(ht
, i
, len
);
1082 * Update table size.
1084 cmm_smp_wmb(); /* populate data before RCU size */
1085 CMM_STORE_SHARED(ht
->size
, 1UL << i
);
1087 dbg_printf("init new size: %lu\n", 1UL << i
);
1088 if (CMM_LOAD_SHARED(ht
->in_progress_destroy
))
1094 * Holding RCU read lock to protect _cds_lfht_remove against memory
1095 * reclaim that could be performed by other call_rcu worker threads (ABA
1097 * For a single level, we logically remove and garbage collect each node.
1099 * As a design choice, we perform logical removal and garbage collection on a
1100 * node-per-node basis to simplify this algorithm. We also assume keeping good
1101 * cache locality of the operation would overweight possible performance gain
1102 * that could be achieved by batching garbage collection for multiple levels.
1103 * However, this would have to be justified by benchmarks.
1105 * Concurrent removal and add operations are helping us perform garbage
1106 * collection of logically removed nodes. We guarantee that all logically
1107 * removed nodes have been garbage-collected (unlinked) before call_rcu is
1108 * invoked to free a hole level of bucket nodes (after a grace period).
1110 * Logical removal and garbage collection can therefore be done in batch or on a
1111 * node-per-node basis, as long as the guarantee above holds.
1113 * When we reach a certain length, we can split this removal over many worker
1114 * threads, based on the number of CPUs available in the system. This should
1115 * take care of not letting resize process lag behind too many concurrent
1116 * updater threads actively inserting into the hash table.
1119 void remove_table_partition(struct cds_lfht
*ht
, unsigned long i
,
1120 unsigned long start
, unsigned long len
)
1122 unsigned long j
, size
= 1UL << (i
- 1);
1124 assert(i
> MIN_TABLE_ORDER
);
1125 ht
->flavor
->read_lock();
1126 for (j
= size
+ start
; j
< size
+ start
+ len
; j
++) {
1127 struct cds_lfht_node
*fini_node
= bucket_at(ht
, j
);
1129 assert(j
>= size
&& j
< (size
<< 1));
1130 dbg_printf("remove entry: order %lu index %lu hash %lu\n",
1132 fini_node
->reverse_hash
= bit_reverse_ulong(j
);
1133 (void) _cds_lfht_del(ht
, size
, fini_node
, 1);
1135 ht
->flavor
->read_unlock();
1139 void remove_table(struct cds_lfht
*ht
, unsigned long i
, unsigned long len
)
1142 assert(nr_cpus_mask
!= -1);
1143 if (nr_cpus_mask
< 0 || len
< 2 * MIN_PARTITION_PER_THREAD
) {
1144 ht
->flavor
->thread_online();
1145 remove_table_partition(ht
, i
, 0, len
);
1146 ht
->flavor
->thread_offline();
1149 partition_resize_helper(ht
, i
, len
, remove_table_partition
);
1153 * fini_table() is never called for first_order == 0, which is why
1154 * free_by_rcu_order == 0 can be used as criterion to know if free must
1158 void fini_table(struct cds_lfht
*ht
,
1159 unsigned long first_order
, unsigned long last_order
)
1162 unsigned long free_by_rcu_order
= 0;
1164 dbg_printf("fini table: first_order %lu last_order %lu\n",
1165 first_order
, last_order
);
1166 assert(first_order
> MIN_TABLE_ORDER
);
1167 for (i
= last_order
; i
>= first_order
; i
--) {
1170 len
= 1UL << (i
- 1);
1171 dbg_printf("fini order %lu len: %lu\n", i
, len
);
1173 /* Stop shrink if the resize target changes under us */
1174 if (CMM_LOAD_SHARED(ht
->resize_target
) > (1UL << (i
- 1)))
1177 cmm_smp_wmb(); /* populate data before RCU size */
1178 CMM_STORE_SHARED(ht
->size
, 1UL << (i
- 1));
1181 * We need to wait for all add operations to reach Q.S. (and
1182 * thus use the new table for lookups) before we can start
1183 * releasing the old bucket nodes. Otherwise their lookup will
1184 * return a logically removed node as insert position.
1186 ht
->flavor
->update_synchronize_rcu();
1187 if (free_by_rcu_order
)
1188 cds_lfht_free_bucket_table(ht
, free_by_rcu_order
);
1191 * Set "removed" flag in bucket nodes about to be removed.
1192 * Unlink all now-logically-removed bucket node pointers.
1193 * Concurrent add/remove operation are helping us doing
1196 remove_table(ht
, i
, len
);
1198 free_by_rcu_order
= i
;
1200 dbg_printf("fini new size: %lu\n", 1UL << i
);
1201 if (CMM_LOAD_SHARED(ht
->in_progress_destroy
))
1205 if (free_by_rcu_order
) {
1206 ht
->flavor
->update_synchronize_rcu();
1207 cds_lfht_free_bucket_table(ht
, free_by_rcu_order
);
1212 void cds_lfht_create_bucket(struct cds_lfht
*ht
, unsigned long size
)
1214 struct cds_lfht_node
*prev
, *node
;
1215 unsigned long order
, len
, i
;
1217 cds_lfht_alloc_bucket_table(ht
, 0);
1219 dbg_printf("create bucket: order 0 index 0 hash 0\n");
1220 node
= bucket_at(ht
, 0);
1221 node
->next
= flag_bucket(get_end());
1222 node
->reverse_hash
= 0;
1224 for (order
= 1; order
< get_count_order_ulong(size
) + 1; order
++) {
1225 len
= 1UL << (order
- 1);
1226 cds_lfht_alloc_bucket_table(ht
, order
);
1228 for (i
= 0; i
< len
; i
++) {
1230 * Now, we are trying to init the node with the
1231 * hash=(len+i) (which is also a bucket with the
1232 * index=(len+i)) and insert it into the hash table,
1233 * so this node has to be inserted after the bucket
1234 * with the index=(len+i)&(len-1)=i. And because there
1235 * is no other non-bucket node nor bucket node with
1236 * larger index/hash inserted, so the bucket node
1237 * being inserted should be inserted directly linked
1238 * after the bucket node with index=i.
1240 prev
= bucket_at(ht
, i
);
1241 node
= bucket_at(ht
, len
+ i
);
1243 dbg_printf("create bucket: order %lu index %lu hash %lu\n",
1244 order
, len
+ i
, len
+ i
);
1245 node
->reverse_hash
= bit_reverse_ulong(len
+ i
);
1247 /* insert after prev */
1248 assert(is_bucket(prev
->next
));
1249 node
->next
= prev
->next
;
1250 prev
->next
= flag_bucket(node
);
1255 struct cds_lfht
*_cds_lfht_new(unsigned long init_size
,
1256 unsigned long min_nr_alloc_buckets
,
1257 unsigned long max_nr_buckets
,
1259 const struct cds_lfht_mm_type
*mm
,
1260 const struct rcu_flavor_struct
*flavor
,
1261 pthread_attr_t
*attr
)
1263 struct cds_lfht
*ht
;
1264 unsigned long order
;
1266 /* min_nr_alloc_buckets must be power of two */
1267 if (!min_nr_alloc_buckets
|| (min_nr_alloc_buckets
& (min_nr_alloc_buckets
- 1)))
1270 /* init_size must be power of two */
1271 if (!init_size
|| (init_size
& (init_size
- 1)))
1275 * Memory management plugin default.
1278 if (CAA_BITS_PER_LONG
> 32
1280 && max_nr_buckets
<= (1ULL << 32)) {
1282 * For 64-bit architectures, with max number of
1283 * buckets small enough not to use the entire
1284 * 64-bit memory mapping space (and allowing a
1285 * fair number of hash table instances), use the
1286 * mmap allocator, which is faster than the
1289 mm
= &cds_lfht_mm_mmap
;
1292 * The fallback is to use the order allocator.
1294 mm
= &cds_lfht_mm_order
;
1298 /* max_nr_buckets == 0 for order based mm means infinite */
1299 if (mm
== &cds_lfht_mm_order
&& !max_nr_buckets
)
1300 max_nr_buckets
= 1UL << (MAX_TABLE_ORDER
- 1);
1302 /* max_nr_buckets must be power of two */
1303 if (!max_nr_buckets
|| (max_nr_buckets
& (max_nr_buckets
- 1)))
1306 min_nr_alloc_buckets
= max(min_nr_alloc_buckets
, MIN_TABLE_SIZE
);
1307 init_size
= max(init_size
, MIN_TABLE_SIZE
);
1308 max_nr_buckets
= max(max_nr_buckets
, min_nr_alloc_buckets
);
1309 init_size
= min(init_size
, max_nr_buckets
);
1311 ht
= mm
->alloc_cds_lfht(min_nr_alloc_buckets
, max_nr_buckets
);
1313 assert(ht
->mm
== mm
);
1314 assert(ht
->bucket_at
== mm
->bucket_at
);
1317 ht
->flavor
= flavor
;
1318 ht
->resize_attr
= attr
;
1319 alloc_split_items_count(ht
);
1320 /* this mutex should not nest in read-side C.S. */
1321 pthread_mutex_init(&ht
->resize_mutex
, NULL
);
1322 order
= get_count_order_ulong(init_size
);
1323 ht
->resize_target
= 1UL << order
;
1324 cds_lfht_create_bucket(ht
, 1UL << order
);
1325 ht
->size
= 1UL << order
;
1329 void cds_lfht_lookup(struct cds_lfht
*ht
, unsigned long hash
,
1330 cds_lfht_match_fct match
, const void *key
,
1331 struct cds_lfht_iter
*iter
)
1333 struct cds_lfht_node
*node
, *next
, *bucket
;
1334 unsigned long reverse_hash
, size
;
1336 reverse_hash
= bit_reverse_ulong(hash
);
1338 size
= rcu_dereference(ht
->size
);
1339 bucket
= lookup_bucket(ht
, size
, hash
);
1340 /* We can always skip the bucket node initially */
1341 node
= rcu_dereference(bucket
->next
);
1342 node
= clear_flag(node
);
1344 if (caa_unlikely(is_end(node
))) {
1348 if (caa_unlikely(node
->reverse_hash
> reverse_hash
)) {
1352 next
= rcu_dereference(node
->next
);
1353 assert(node
== clear_flag(node
));
1354 if (caa_likely(!is_removed(next
))
1356 && node
->reverse_hash
== reverse_hash
1357 && caa_likely(match(node
, key
))) {
1360 node
= clear_flag(next
);
1362 assert(!node
|| !is_bucket(rcu_dereference(node
->next
)));
1367 void cds_lfht_next_duplicate(struct cds_lfht
*ht
, cds_lfht_match_fct match
,
1368 const void *key
, struct cds_lfht_iter
*iter
)
1370 struct cds_lfht_node
*node
, *next
;
1371 unsigned long reverse_hash
;
1374 reverse_hash
= node
->reverse_hash
;
1376 node
= clear_flag(next
);
1379 if (caa_unlikely(is_end(node
))) {
1383 if (caa_unlikely(node
->reverse_hash
> reverse_hash
)) {
1387 next
= rcu_dereference(node
->next
);
1388 if (caa_likely(!is_removed(next
))
1390 && caa_likely(match(node
, key
))) {
1393 node
= clear_flag(next
);
1395 assert(!node
|| !is_bucket(rcu_dereference(node
->next
)));
1400 void cds_lfht_next(struct cds_lfht
*ht
, struct cds_lfht_iter
*iter
)
1402 struct cds_lfht_node
*node
, *next
;
1404 node
= clear_flag(iter
->next
);
1406 if (caa_unlikely(is_end(node
))) {
1410 next
= rcu_dereference(node
->next
);
1411 if (caa_likely(!is_removed(next
))
1412 && !is_bucket(next
)) {
1415 node
= clear_flag(next
);
1417 assert(!node
|| !is_bucket(rcu_dereference(node
->next
)));
1422 void cds_lfht_first(struct cds_lfht
*ht
, struct cds_lfht_iter
*iter
)
1425 * Get next after first bucket node. The first bucket node is the
1426 * first node of the linked list.
1428 iter
->next
= bucket_at(ht
, 0)->next
;
1429 cds_lfht_next(ht
, iter
);
1432 void cds_lfht_add(struct cds_lfht
*ht
, unsigned long hash
,
1433 struct cds_lfht_node
*node
)
1437 node
->reverse_hash
= bit_reverse_ulong((unsigned long) hash
);
1438 size
= rcu_dereference(ht
->size
);
1439 _cds_lfht_add(ht
, NULL
, NULL
, size
, node
, NULL
, 0);
1440 ht_count_add(ht
, size
, hash
);
1443 struct cds_lfht_node
*cds_lfht_add_unique(struct cds_lfht
*ht
,
1445 cds_lfht_match_fct match
,
1447 struct cds_lfht_node
*node
)
1450 struct cds_lfht_iter iter
;
1452 node
->reverse_hash
= bit_reverse_ulong((unsigned long) hash
);
1453 size
= rcu_dereference(ht
->size
);
1454 _cds_lfht_add(ht
, match
, key
, size
, node
, &iter
, 0);
1455 if (iter
.node
== node
)
1456 ht_count_add(ht
, size
, hash
);
1460 struct cds_lfht_node
*cds_lfht_add_replace(struct cds_lfht
*ht
,
1462 cds_lfht_match_fct match
,
1464 struct cds_lfht_node
*node
)
1467 struct cds_lfht_iter iter
;
1469 node
->reverse_hash
= bit_reverse_ulong((unsigned long) hash
);
1470 size
= rcu_dereference(ht
->size
);
1472 _cds_lfht_add(ht
, match
, key
, size
, node
, &iter
, 0);
1473 if (iter
.node
== node
) {
1474 ht_count_add(ht
, size
, hash
);
1478 if (!_cds_lfht_replace(ht
, size
, iter
.node
, iter
.next
, node
))
1483 int cds_lfht_replace(struct cds_lfht
*ht
, struct cds_lfht_iter
*old_iter
,
1484 struct cds_lfht_node
*new_node
)
1488 size
= rcu_dereference(ht
->size
);
1489 return _cds_lfht_replace(ht
, size
, old_iter
->node
, old_iter
->next
,
1493 int cds_lfht_del(struct cds_lfht
*ht
, struct cds_lfht_iter
*iter
)
1495 unsigned long size
, hash
;
1498 size
= rcu_dereference(ht
->size
);
1499 ret
= _cds_lfht_del(ht
, size
, iter
->node
, 0);
1501 hash
= bit_reverse_ulong(iter
->node
->reverse_hash
);
1502 ht_count_del(ht
, size
, hash
);
1508 int cds_lfht_delete_bucket(struct cds_lfht
*ht
)
1510 struct cds_lfht_node
*node
;
1511 unsigned long order
, i
, size
;
1513 /* Check that the table is empty */
1514 node
= bucket_at(ht
, 0);
1516 node
= clear_flag(node
)->next
;
1517 if (!is_bucket(node
))
1519 assert(!is_removed(node
));
1520 } while (!is_end(node
));
1522 * size accessed without rcu_dereference because hash table is
1526 /* Internal sanity check: all nodes left should be bucket */
1527 for (i
= 0; i
< size
; i
++) {
1528 node
= bucket_at(ht
, i
);
1529 dbg_printf("delete bucket: index %lu expected hash %lu hash %lu\n",
1530 i
, i
, bit_reverse_ulong(node
->reverse_hash
));
1531 assert(is_bucket(node
->next
));
1534 for (order
= get_count_order_ulong(size
); (long)order
>= 0; order
--)
1535 cds_lfht_free_bucket_table(ht
, order
);
1541 * Should only be called when no more concurrent readers nor writers can
1542 * possibly access the table.
1544 int cds_lfht_destroy(struct cds_lfht
*ht
, pthread_attr_t
**attr
)
1548 /* Wait for in-flight resize operations to complete */
1549 _CMM_STORE_SHARED(ht
->in_progress_destroy
, 1);
1550 cmm_smp_mb(); /* Store destroy before load resize */
1551 while (uatomic_read(&ht
->in_progress_resize
))
1552 poll(NULL
, 0, 100); /* wait for 100ms */
1553 ret
= cds_lfht_delete_bucket(ht
);
1556 free_split_items_count(ht
);
1558 *attr
= ht
->resize_attr
;
1563 void cds_lfht_count_nodes(struct cds_lfht
*ht
,
1564 long *approx_before
,
1565 unsigned long *count
,
1566 unsigned long *removed
,
1569 struct cds_lfht_node
*node
, *next
;
1570 unsigned long nr_bucket
= 0;
1573 if (ht
->split_count
) {
1576 for (i
= 0; i
< split_count_mask
+ 1; i
++) {
1577 *approx_before
+= uatomic_read(&ht
->split_count
[i
].add
);
1578 *approx_before
-= uatomic_read(&ht
->split_count
[i
].del
);
1585 /* Count non-bucket nodes in the table */
1586 node
= bucket_at(ht
, 0);
1588 next
= rcu_dereference(node
->next
);
1589 if (is_removed(next
)) {
1590 if (!is_bucket(next
))
1594 } else if (!is_bucket(next
))
1598 node
= clear_flag(next
);
1599 } while (!is_end(node
));
1600 dbg_printf("number of bucket nodes: %lu\n", nr_bucket
);
1602 if (ht
->split_count
) {
1605 for (i
= 0; i
< split_count_mask
+ 1; i
++) {
1606 *approx_after
+= uatomic_read(&ht
->split_count
[i
].add
);
1607 *approx_after
-= uatomic_read(&ht
->split_count
[i
].del
);
1612 /* called with resize mutex held */
1614 void _do_cds_lfht_grow(struct cds_lfht
*ht
,
1615 unsigned long old_size
, unsigned long new_size
)
1617 unsigned long old_order
, new_order
;
1619 old_order
= get_count_order_ulong(old_size
);
1620 new_order
= get_count_order_ulong(new_size
);
1621 dbg_printf("resize from %lu (order %lu) to %lu (order %lu) buckets\n",
1622 old_size
, old_order
, new_size
, new_order
);
1623 assert(new_size
> old_size
);
1624 init_table(ht
, old_order
+ 1, new_order
);
1627 /* called with resize mutex held */
1629 void _do_cds_lfht_shrink(struct cds_lfht
*ht
,
1630 unsigned long old_size
, unsigned long new_size
)
1632 unsigned long old_order
, new_order
;
1634 new_size
= max(new_size
, MIN_TABLE_SIZE
);
1635 old_order
= get_count_order_ulong(old_size
);
1636 new_order
= get_count_order_ulong(new_size
);
1637 dbg_printf("resize from %lu (order %lu) to %lu (order %lu) buckets\n",
1638 old_size
, old_order
, new_size
, new_order
);
1639 assert(new_size
< old_size
);
1641 /* Remove and unlink all bucket nodes to remove. */
1642 fini_table(ht
, new_order
+ 1, old_order
);
1646 /* called with resize mutex held */
1648 void _do_cds_lfht_resize(struct cds_lfht
*ht
)
1650 unsigned long new_size
, old_size
;
1653 * Resize table, re-do if the target size has changed under us.
1656 assert(uatomic_read(&ht
->in_progress_resize
));
1657 if (CMM_LOAD_SHARED(ht
->in_progress_destroy
))
1659 ht
->resize_initiated
= 1;
1660 old_size
= ht
->size
;
1661 new_size
= CMM_LOAD_SHARED(ht
->resize_target
);
1662 if (old_size
< new_size
)
1663 _do_cds_lfht_grow(ht
, old_size
, new_size
);
1664 else if (old_size
> new_size
)
1665 _do_cds_lfht_shrink(ht
, old_size
, new_size
);
1666 ht
->resize_initiated
= 0;
1667 /* write resize_initiated before read resize_target */
1669 } while (ht
->size
!= CMM_LOAD_SHARED(ht
->resize_target
));
1673 unsigned long resize_target_grow(struct cds_lfht
*ht
, unsigned long new_size
)
1675 return _uatomic_xchg_monotonic_increase(&ht
->resize_target
, new_size
);
1679 void resize_target_update_count(struct cds_lfht
*ht
,
1680 unsigned long count
)
1682 count
= max(count
, MIN_TABLE_SIZE
);
1683 count
= min(count
, ht
->max_nr_buckets
);
1684 uatomic_set(&ht
->resize_target
, count
);
1687 void cds_lfht_resize(struct cds_lfht
*ht
, unsigned long new_size
)
1689 resize_target_update_count(ht
, new_size
);
1690 CMM_STORE_SHARED(ht
->resize_initiated
, 1);
1691 ht
->flavor
->thread_offline();
1692 pthread_mutex_lock(&ht
->resize_mutex
);
1693 _do_cds_lfht_resize(ht
);
1694 pthread_mutex_unlock(&ht
->resize_mutex
);
1695 ht
->flavor
->thread_online();
1699 void do_resize_cb(struct rcu_head
*head
)
1701 struct rcu_resize_work
*work
=
1702 caa_container_of(head
, struct rcu_resize_work
, head
);
1703 struct cds_lfht
*ht
= work
->ht
;
1705 ht
->flavor
->thread_offline();
1706 pthread_mutex_lock(&ht
->resize_mutex
);
1707 _do_cds_lfht_resize(ht
);
1708 pthread_mutex_unlock(&ht
->resize_mutex
);
1709 ht
->flavor
->thread_online();
1711 cmm_smp_mb(); /* finish resize before decrement */
1712 uatomic_dec(&ht
->in_progress_resize
);
1716 void __cds_lfht_resize_lazy_launch(struct cds_lfht
*ht
)
1718 struct rcu_resize_work
*work
;
1720 /* Store resize_target before read resize_initiated */
1722 if (!CMM_LOAD_SHARED(ht
->resize_initiated
)) {
1723 uatomic_inc(&ht
->in_progress_resize
);
1724 cmm_smp_mb(); /* increment resize count before load destroy */
1725 if (CMM_LOAD_SHARED(ht
->in_progress_destroy
)) {
1726 uatomic_dec(&ht
->in_progress_resize
);
1729 work
= malloc(sizeof(*work
));
1731 ht
->flavor
->update_call_rcu(&work
->head
, do_resize_cb
);
1732 CMM_STORE_SHARED(ht
->resize_initiated
, 1);
1737 void cds_lfht_resize_lazy_grow(struct cds_lfht
*ht
, unsigned long size
, int growth
)
1739 unsigned long target_size
= size
<< growth
;
1741 target_size
= min(target_size
, ht
->max_nr_buckets
);
1742 if (resize_target_grow(ht
, target_size
) >= target_size
)
1745 __cds_lfht_resize_lazy_launch(ht
);
1749 * We favor grow operations over shrink. A shrink operation never occurs
1750 * if a grow operation is queued for lazy execution. A grow operation
1751 * cancels any pending shrink lazy execution.
1754 void cds_lfht_resize_lazy_count(struct cds_lfht
*ht
, unsigned long size
,
1755 unsigned long count
)
1757 if (!(ht
->flags
& CDS_LFHT_AUTO_RESIZE
))
1759 count
= max(count
, MIN_TABLE_SIZE
);
1760 count
= min(count
, ht
->max_nr_buckets
);
1762 return; /* Already the right size, no resize needed */
1763 if (count
> size
) { /* lazy grow */
1764 if (resize_target_grow(ht
, count
) >= count
)
1766 } else { /* lazy shrink */
1770 s
= uatomic_cmpxchg(&ht
->resize_target
, size
, count
);
1772 break; /* no resize needed */
1774 return; /* growing is/(was just) in progress */
1776 return; /* some other thread do shrink */
1780 __cds_lfht_resize_lazy_launch(ht
);