4 * Userspace RCU library - Lock-Free Resizable RCU Hash Table
6 * Copyright 2010-2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * Based on the following articles:
25 * - Ori Shalev and Nir Shavit. Split-ordered lists: Lock-free
26 * extensible hash tables. J. ACM 53, 3 (May 2006), 379-405.
27 * - Michael, M. M. High performance dynamic lock-free hash tables
28 * and list-based sets. In Proceedings of the fourteenth annual ACM
29 * symposium on Parallel algorithms and architectures, ACM Press,
32 * Some specificities of this Lock-Free Resizable RCU Hash Table
35 * - RCU read-side critical section allows readers to perform hash
36 * table lookups and use the returned objects safely by delaying
37 * memory reclaim of a grace period.
38 * - Add and remove operations are lock-free, and do not need to
39 * allocate memory. They need to be executed within RCU read-side
40 * critical section to ensure the objects they read are valid and to
41 * deal with the cmpxchg ABA problem.
42 * - add and add_unique operations are supported. add_unique checks if
43 * the node key already exists in the hash table. It ensures no key
45 * - The resize operation executes concurrently with add/remove/lookup.
46 * - Hash table nodes are contained within a split-ordered list. This
47 * list is ordered by incrementing reversed-bits-hash value.
48 * - An index of dummy nodes is kept. These dummy nodes are the hash
49 * table "buckets", and they are also chained together in the
50 * split-ordered list, which allows recursive expansion.
51 * - The resize operation for small tables only allows expanding the hash table.
52 * It is triggered automatically by detecting long chains in the add
54 * - The resize operation for larger tables (and available through an
55 * API) allows both expanding and shrinking the hash table.
56 * - Per-CPU Split-counters are used to keep track of the number of
57 * nodes within the hash table for automatic resize triggering.
58 * - Resize operation initiated by long chain detection is executed by a
59 * call_rcu thread, which keeps lock-freedom of add and remove.
60 * - Resize operations are protected by a mutex.
61 * - The removal operation is split in two parts: first, a "removed"
62 * flag is set in the next pointer within the node to remove. Then,
63 * a "garbage collection" is performed in the bucket containing the
64 * removed node (from the start of the bucket up to the removed node).
65 * All encountered nodes with "removed" flag set in their next
66 * pointers are removed from the linked-list. If the cmpxchg used for
67 * removal fails (due to concurrent garbage-collection or concurrent
68 * add), we retry from the beginning of the bucket. This ensures that
69 * the node with "removed" flag set is removed from the hash table
70 * (not visible to lookups anymore) before the RCU read-side critical
71 * section held across removal ends. Furthermore, this ensures that
72 * the node with "removed" flag set is removed from the linked-list
73 * before its memory is reclaimed. Only the thread which removal
74 * successfully set the "removed" flag (with a cmpxchg) into a node's
75 * next pointer is considered to have succeeded its removal (and thus
76 * owns the node to reclaim). Because we garbage-collect starting from
77 * an invariant node (the start-of-bucket dummy node) up to the
78 * "removed" node (or find a reverse-hash that is higher), we are sure
79 * that a successful traversal of the chain leads to a chain that is
80 * present in the linked-list (the start node is never removed) and
81 * that is does not contain the "removed" node anymore, even if
82 * concurrent delete/add operations are changing the structure of the
84 * - The add operation performs gargage collection of buckets if it
85 * encounters nodes with removed flag set in the bucket where it wants
86 * to add its new node. This ensures lock-freedom of add operation by
87 * helping the remover unlink nodes from the list rather than to wait
89 * - A RCU "order table" indexed by log2(hash index) is copied and
90 * expanded by the resize operation. This order table allows finding
91 * the "dummy node" tables.
92 * - There is one dummy node table per hash index order. The size of
93 * each dummy node table is half the number of hashes contained in
95 * - call_rcu is used to garbage-collect the old order table.
96 * - The per-order dummy node tables contain a compact version of the
97 * hash table nodes. These tables are invariant after they are
98 * populated into the hash table.
100 * A bit of ascii art explanation:
102 * Order index is the off-by-one compare to the actual power of 2 because
103 * we use index 0 to deal with the 0 special-case.
105 * This shows the nodes for a small table ordered by reversed bits:
117 * This shows the nodes in order of non-reversed bits, linked by
118 * reversed-bit order.
123 * 1 | 1 001 100 <- <-
125 * 2 | | 2 010 010 | |
126 * | | | 3 011 110 | <- |
128 * 3 -> | | | 4 100 001 | |
144 #include <urcu-call-rcu.h>
145 #include <urcu/arch.h>
146 #include <urcu/uatomic.h>
147 #include <urcu/jhash.h>
148 #include <urcu/compiler.h>
149 #include <urcu/rculfhash.h>
154 #define dbg_printf(fmt, args...) printf("[debug rculfhash] " fmt, ## args)
156 #define dbg_printf(fmt, args...)
160 * Per-CPU split-counters lazily update the global counter each 1024
161 * addition/removal. It automatically keeps track of resize required.
162 * We use the bucket length as indicator for need to expand for small
163 * tables and machines lacking per-cpu data suppport.
165 #define COUNT_COMMIT_ORDER 10
166 #define CHAIN_LEN_TARGET 1
167 #define CHAIN_LEN_RESIZE_THRESHOLD 3
170 * Define the minimum table size. Protects against hash table resize overload
171 * when too many entries are added quickly before the resize can complete.
172 * This is especially the case if the table could be shrinked to a size of 1.
173 * TODO: we might want to make the add/remove operations help the resize to
174 * add or remove dummy nodes when a resize is ongoing to ensure upper-bound on
177 #define MIN_TABLE_SIZE 128
180 #define max(a, b) ((a) > (b) ? (a) : (b))
184 * The removed flag needs to be updated atomically with the pointer.
185 * The dummy flag does not require to be updated atomically with the
186 * pointer, but it is added as a pointer low bit flag to save space.
188 #define REMOVED_FLAG (1UL << 0)
189 #define DUMMY_FLAG (1UL << 1)
190 #define FLAGS_MASK ((1UL << 2) - 1)
192 struct ht_items_count
{
193 unsigned long add
, remove
;
194 } __attribute__((aligned(CAA_CACHE_LINE_SIZE
)));
197 struct rcu_head head
;
198 struct _cds_lfht_node nodes
[0];
202 unsigned long size
; /* always a power of 2 */
203 unsigned long resize_target
;
204 int resize_initiated
;
205 struct rcu_head head
;
206 struct rcu_level
*tbl
[0];
210 struct rcu_table
*t
; /* shared */
211 cds_lfht_hash_fct hash_fct
;
212 cds_lfht_compare_fct compare_fct
;
213 unsigned long hash_seed
;
215 pthread_mutex_t resize_mutex
; /* resize mutex: add/del mutex */
216 unsigned int in_progress_resize
, in_progress_destroy
;
217 void (*cds_lfht_call_rcu
)(struct rcu_head
*head
,
218 void (*func
)(struct rcu_head
*head
));
219 void (*cds_lfht_synchronize_rcu
)(void);
220 unsigned long count
; /* global approximate item count */
221 struct ht_items_count
*percpu_count
; /* per-cpu item count */
224 struct rcu_resize_work
{
225 struct rcu_head head
;
230 * Algorithm to reverse bits in a word by lookup table, extended to
233 * http://graphics.stanford.edu/~seander/bithacks.html#BitReverseTable
234 * Originally from Public Domain.
237 static const uint8_t BitReverseTable256
[256] =
239 #define R2(n) (n), (n) + 2*64, (n) + 1*64, (n) + 3*64
240 #define R4(n) R2(n), R2((n) + 2*16), R2((n) + 1*16), R2((n) + 3*16)
241 #define R6(n) R4(n), R4((n) + 2*4 ), R4((n) + 1*4 ), R4((n) + 3*4 )
242 R6(0), R6(2), R6(1), R6(3)
249 uint8_t bit_reverse_u8(uint8_t v
)
251 return BitReverseTable256
[v
];
254 static __attribute__((unused
))
255 uint32_t bit_reverse_u32(uint32_t v
)
257 return ((uint32_t) bit_reverse_u8(v
) << 24) |
258 ((uint32_t) bit_reverse_u8(v
>> 8) << 16) |
259 ((uint32_t) bit_reverse_u8(v
>> 16) << 8) |
260 ((uint32_t) bit_reverse_u8(v
>> 24));
263 static __attribute__((unused
))
264 uint64_t bit_reverse_u64(uint64_t v
)
266 return ((uint64_t) bit_reverse_u8(v
) << 56) |
267 ((uint64_t) bit_reverse_u8(v
>> 8) << 48) |
268 ((uint64_t) bit_reverse_u8(v
>> 16) << 40) |
269 ((uint64_t) bit_reverse_u8(v
>> 24) << 32) |
270 ((uint64_t) bit_reverse_u8(v
>> 32) << 24) |
271 ((uint64_t) bit_reverse_u8(v
>> 40) << 16) |
272 ((uint64_t) bit_reverse_u8(v
>> 48) << 8) |
273 ((uint64_t) bit_reverse_u8(v
>> 56));
277 unsigned long bit_reverse_ulong(unsigned long v
)
279 #if (CAA_BITS_PER_LONG == 32)
280 return bit_reverse_u32(v
);
282 return bit_reverse_u64(v
);
287 * fls: returns the position of the most significant bit.
288 * Returns 0 if no bit is set, else returns the position of the most
289 * significant bit (from 1 to 32 on 32-bit, from 1 to 64 on 64-bit).
291 #if defined(__i386) || defined(__x86_64)
293 unsigned int fls_u32(uint32_t x
)
301 : "=r" (r
) : "rm" (x
));
307 #if defined(__x86_64)
309 unsigned int fls_u64(uint64_t x
)
317 : "=r" (r
) : "rm" (x
));
324 static __attribute__((unused
))
325 unsigned int fls_u64(uint64_t x
)
332 if (!(x
& 0xFFFFFFFF00000000ULL
)) {
336 if (!(x
& 0xFFFF000000000000ULL
)) {
340 if (!(x
& 0xFF00000000000000ULL
)) {
344 if (!(x
& 0xF000000000000000ULL
)) {
348 if (!(x
& 0xC000000000000000ULL
)) {
352 if (!(x
& 0x8000000000000000ULL
)) {
361 static __attribute__((unused
))
362 unsigned int fls_u32(uint32_t x
)
368 if (!(x
& 0xFFFF0000U
)) {
372 if (!(x
& 0xFF000000U
)) {
376 if (!(x
& 0xF0000000U
)) {
380 if (!(x
& 0xC0000000U
)) {
384 if (!(x
& 0x80000000U
)) {
392 unsigned int fls_ulong(unsigned long x
)
394 #if (CAA_BITS_PER_lONG == 32)
401 int get_count_order_u32(uint32_t x
)
405 order
= fls_u32(x
) - 1;
411 int get_count_order_ulong(unsigned long x
)
415 order
= fls_ulong(x
) - 1;
422 void cds_lfht_resize_lazy(struct cds_lfht
*ht
, struct rcu_table
*t
, int growth
);
425 * If the sched_getcpu() and sysconf(_SC_NPROCESSORS_CONF) calls are
426 * available, then we support hash table item accounting.
427 * In the unfortunate event the number of CPUs reported would be
428 * inaccurate, we use modulo arithmetic on the number of CPUs we got.
430 #if defined(HAVE_SCHED_GETCPU) && defined(HAVE_SYSCONF)
433 void cds_lfht_resize_lazy_count(struct cds_lfht
*ht
, struct rcu_table
*t
,
434 unsigned long count
);
436 static long nr_cpus_mask
= -1;
439 struct ht_items_count
*alloc_per_cpu_items_count(void)
441 struct ht_items_count
*count
;
443 switch (nr_cpus_mask
) {
450 maxcpus
= sysconf(_SC_NPROCESSORS_CONF
);
456 * round up number of CPUs to next power of two, so we
457 * can use & for modulo.
459 maxcpus
= 1UL << get_count_order_ulong(maxcpus
);
460 nr_cpus_mask
= maxcpus
- 1;
464 return calloc(nr_cpus_mask
+ 1, sizeof(*count
));
469 void free_per_cpu_items_count(struct ht_items_count
*count
)
479 assert(nr_cpus_mask
>= 0);
480 cpu
= sched_getcpu();
481 if (unlikely(cpu
< 0))
484 return cpu
& nr_cpus_mask
;
488 void ht_count_add(struct cds_lfht
*ht
, struct rcu_table
*t
)
490 unsigned long percpu_count
;
493 if (unlikely(!ht
->percpu_count
))
496 if (unlikely(cpu
< 0))
498 percpu_count
= uatomic_add_return(&ht
->percpu_count
[cpu
].add
, 1);
499 if (unlikely(!(percpu_count
& ((1UL << COUNT_COMMIT_ORDER
) - 1)))) {
502 dbg_printf("add percpu %lu\n", percpu_count
);
503 count
= uatomic_add_return(&ht
->count
,
504 1UL << COUNT_COMMIT_ORDER
);
506 if (!(count
& (count
- 1))) {
507 if ((count
>> CHAIN_LEN_RESIZE_THRESHOLD
)
510 dbg_printf("add set global %lu\n", count
);
511 cds_lfht_resize_lazy_count(ht
, t
,
512 count
>> (CHAIN_LEN_TARGET
- 1));
518 void ht_count_remove(struct cds_lfht
*ht
, struct rcu_table
*t
)
520 unsigned long percpu_count
;
523 if (unlikely(!ht
->percpu_count
))
526 if (unlikely(cpu
< 0))
528 percpu_count
= uatomic_add_return(&ht
->percpu_count
[cpu
].remove
, -1);
529 if (unlikely(!(percpu_count
& ((1UL << COUNT_COMMIT_ORDER
) - 1)))) {
532 dbg_printf("remove percpu %lu\n", percpu_count
);
533 count
= uatomic_add_return(&ht
->count
,
534 -(1UL << COUNT_COMMIT_ORDER
));
536 if (!(count
& (count
- 1))) {
537 if ((count
>> CHAIN_LEN_RESIZE_THRESHOLD
)
540 dbg_printf("remove set global %lu\n", count
);
541 cds_lfht_resize_lazy_count(ht
, t
,
542 count
>> (CHAIN_LEN_TARGET
- 1));
547 #else /* #if defined(HAVE_SCHED_GETCPU) && defined(HAVE_SYSCONF) */
549 static const long nr_cpus_mask
= -1;
552 struct ht_items_count
*alloc_per_cpu_items_count(void)
558 void free_per_cpu_items_count(struct ht_items_count
*count
)
563 void ht_count_add(struct cds_lfht
*ht
, struct rcu_table
*t
)
568 void ht_count_remove(struct cds_lfht
*ht
, struct rcu_table
*t
)
572 #endif /* #else #if defined(HAVE_SCHED_GETCPU) && defined(HAVE_SYSCONF) */
576 void check_resize(struct cds_lfht
*ht
, struct rcu_table
*t
,
581 if (!(ht
->flags
& CDS_LFHT_AUTO_RESIZE
))
583 count
= uatomic_read(&ht
->count
);
585 * Use bucket-local length for small table expand and for
586 * environments lacking per-cpu data support.
588 if (count
>= (1UL << COUNT_COMMIT_ORDER
))
591 dbg_printf("WARNING: large chain length: %u.\n",
593 if (chain_len
>= CHAIN_LEN_RESIZE_THRESHOLD
)
594 cds_lfht_resize_lazy(ht
, t
,
595 get_count_order_u32(chain_len
- (CHAIN_LEN_TARGET
- 1)));
599 struct cds_lfht_node
*clear_flag(struct cds_lfht_node
*node
)
601 return (struct cds_lfht_node
*) (((unsigned long) node
) & ~FLAGS_MASK
);
605 int is_removed(struct cds_lfht_node
*node
)
607 return ((unsigned long) node
) & REMOVED_FLAG
;
611 struct cds_lfht_node
*flag_removed(struct cds_lfht_node
*node
)
613 return (struct cds_lfht_node
*) (((unsigned long) node
) | REMOVED_FLAG
);
617 int is_dummy(struct cds_lfht_node
*node
)
619 return ((unsigned long) node
) & DUMMY_FLAG
;
623 struct cds_lfht_node
*flag_dummy(struct cds_lfht_node
*node
)
625 return (struct cds_lfht_node
*) (((unsigned long) node
) | DUMMY_FLAG
);
629 unsigned long _uatomic_max(unsigned long *ptr
, unsigned long v
)
631 unsigned long old1
, old2
;
633 old1
= uatomic_read(ptr
);
638 } while ((old1
= uatomic_cmpxchg(ptr
, old2
, v
)) != old2
);
643 void cds_lfht_free_table_cb(struct rcu_head
*head
)
645 struct rcu_table
*t
=
646 caa_container_of(head
, struct rcu_table
, head
);
651 void cds_lfht_free_level(struct rcu_head
*head
)
653 struct rcu_level
*l
=
654 caa_container_of(head
, struct rcu_level
, head
);
659 * Remove all logically deleted nodes from a bucket up to a certain node key.
662 void _cds_lfht_gc_bucket(struct cds_lfht_node
*dummy
, struct cds_lfht_node
*node
)
664 struct cds_lfht_node
*iter_prev
, *iter
, *next
, *new_next
;
666 assert(!is_dummy(dummy
));
667 assert(!is_removed(dummy
));
668 assert(!is_dummy(node
));
669 assert(!is_removed(node
));
672 /* We can always skip the dummy node initially */
673 iter
= rcu_dereference(iter_prev
->p
.next
);
674 assert(iter_prev
->p
.reverse_hash
<= node
->p
.reverse_hash
);
676 if (unlikely(!clear_flag(iter
)))
678 if (likely(clear_flag(iter
)->p
.reverse_hash
> node
->p
.reverse_hash
))
680 next
= rcu_dereference(clear_flag(iter
)->p
.next
);
681 if (likely(is_removed(next
)))
683 iter_prev
= clear_flag(iter
);
686 assert(!is_removed(iter
));
688 new_next
= flag_dummy(clear_flag(next
));
690 new_next
= clear_flag(next
);
691 (void) uatomic_cmpxchg(&iter_prev
->p
.next
, iter
, new_next
);
696 struct cds_lfht_node
*_cds_lfht_add(struct cds_lfht
*ht
, struct rcu_table
*t
,
697 struct cds_lfht_node
*node
, int unique
, int dummy
)
699 struct cds_lfht_node
*iter_prev
, *iter
, *next
, *new_node
, *new_next
,
701 struct _cds_lfht_node
*lookup
;
702 unsigned long hash
, index
, order
;
704 assert(!is_dummy(node
));
705 assert(!is_removed(node
));
708 node
->p
.next
= flag_dummy(NULL
);
709 return node
; /* Initial first add (head) */
711 hash
= bit_reverse_ulong(node
->p
.reverse_hash
);
713 uint32_t chain_len
= 0;
716 * iter_prev points to the non-removed node prior to the
719 index
= hash
& (t
->size
- 1);
720 order
= get_count_order_ulong(index
+ 1);
721 lookup
= &t
->tbl
[order
]->nodes
[index
& ((!order
? 0 : (1UL << (order
- 1))) - 1)];
722 iter_prev
= (struct cds_lfht_node
*) lookup
;
723 /* We can always skip the dummy node initially */
724 iter
= rcu_dereference(iter_prev
->p
.next
);
725 assert(iter_prev
->p
.reverse_hash
<= node
->p
.reverse_hash
);
727 /* TODO: check if removed */
728 if (unlikely(!clear_flag(iter
)))
730 /* TODO: check if removed */
731 if (likely(clear_flag(iter
)->p
.reverse_hash
> node
->p
.reverse_hash
))
733 next
= rcu_dereference(clear_flag(iter
)->p
.next
);
734 if (unlikely(is_removed(next
)))
738 && !ht
->compare_fct(node
->key
, node
->key_len
,
739 clear_flag(iter
)->key
,
740 clear_flag(iter
)->key_len
))
741 return clear_flag(iter
);
742 /* Only account for identical reverse hash once */
743 if (iter_prev
->p
.reverse_hash
!= clear_flag(iter
)->p
.reverse_hash
745 check_resize(ht
, t
, ++chain_len
);
746 iter_prev
= clear_flag(iter
);
750 assert(node
!= clear_flag(iter
));
751 assert(!is_removed(iter_prev
));
752 assert(!is_removed(iter
));
753 assert(iter_prev
!= node
);
755 node
->p
.next
= clear_flag(iter
);
757 node
->p
.next
= flag_dummy(clear_flag(iter
));
759 new_node
= flag_dummy(node
);
762 if (uatomic_cmpxchg(&iter_prev
->p
.next
, iter
,
764 continue; /* retry */
768 assert(!is_removed(iter
));
770 new_next
= flag_dummy(clear_flag(next
));
772 new_next
= clear_flag(next
);
773 (void) uatomic_cmpxchg(&iter_prev
->p
.next
, iter
, new_next
);
777 /* Garbage collect logically removed nodes in the bucket */
778 index
= hash
& (t
->size
- 1);
779 order
= get_count_order_ulong(index
+ 1);
780 lookup
= &t
->tbl
[order
]->nodes
[index
& (!order
? 0 : ((1UL << (order
- 1)) - 1))];
781 dummy_node
= (struct cds_lfht_node
*) lookup
;
782 _cds_lfht_gc_bucket(dummy_node
, node
);
787 int _cds_lfht_remove(struct cds_lfht
*ht
, struct rcu_table
*t
,
788 struct cds_lfht_node
*node
, int dummy_removal
)
790 struct cds_lfht_node
*dummy
, *next
, *old
;
791 struct _cds_lfht_node
*lookup
;
793 unsigned long hash
, index
, order
;
795 /* logically delete the node */
796 assert(!is_dummy(node
));
797 assert(!is_removed(node
));
798 old
= rcu_dereference(node
->p
.next
);
801 if (unlikely(is_removed(next
)))
804 assert(is_dummy(next
));
806 assert(!is_dummy(next
));
807 old
= uatomic_cmpxchg(&node
->p
.next
, next
,
809 } while (old
!= next
);
811 /* We performed the (logical) deletion. */
815 * Ensure that the node is not visible to readers anymore: lookup for
816 * the node, and remove it (along with any other logically removed node)
819 hash
= bit_reverse_ulong(node
->p
.reverse_hash
);
821 index
= hash
& (t
->size
- 1);
822 order
= get_count_order_ulong(index
+ 1);
823 lookup
= &t
->tbl
[order
]->nodes
[index
& (!order
? 0 : ((1UL << (order
- 1)) - 1))];
824 dummy
= (struct cds_lfht_node
*) lookup
;
825 _cds_lfht_gc_bucket(dummy
, node
);
828 * Only the flagging action indicated that we (and no other)
829 * removed the node from the hash.
832 assert(is_removed(rcu_dereference(node
->p
.next
)));
839 void init_table(struct cds_lfht
*ht
, struct rcu_table
*t
,
840 unsigned long first_order
, unsigned long len_order
)
842 unsigned long i
, end_order
;
844 dbg_printf("init table: first_order %lu end_order %lu\n",
845 first_order
, first_order
+ len_order
);
846 end_order
= first_order
+ len_order
;
847 t
->size
= !first_order
? 0 : (1UL << (first_order
- 1));
848 for (i
= first_order
; i
< end_order
; i
++) {
849 unsigned long j
, len
;
851 len
= !i
? 1 : 1UL << (i
- 1);
852 dbg_printf("init order %lu len: %lu\n", i
, len
);
853 t
->tbl
[i
] = calloc(1, sizeof(struct rcu_level
)
854 + (len
* sizeof(struct _cds_lfht_node
)));
855 for (j
= 0; j
< len
; j
++) {
856 struct cds_lfht_node
*new_node
=
857 (struct cds_lfht_node
*) &t
->tbl
[i
]->nodes
[j
];
859 dbg_printf("init entry: i %lu j %lu hash %lu\n",
860 i
, j
, !i
? 0 : (1UL << (i
- 1)) + j
);
861 new_node
->p
.reverse_hash
=
862 bit_reverse_ulong(!i
? 0 : (1UL << (i
- 1)) + j
);
863 (void) _cds_lfht_add(ht
, t
, new_node
, 0, 1);
864 if (CMM_LOAD_SHARED(ht
->in_progress_destroy
))
867 /* Update table size */
868 t
->size
= !i
? 1 : (1UL << i
);
869 dbg_printf("init new size: %lu\n", t
->size
);
870 if (CMM_LOAD_SHARED(ht
->in_progress_destroy
))
873 t
->resize_target
= t
->size
;
874 t
->resize_initiated
= 0;
878 void fini_table(struct cds_lfht
*ht
, struct rcu_table
*t
,
879 unsigned long first_order
, unsigned long len_order
)
883 dbg_printf("fini table: first_order %lu end_order %lu\n",
884 first_order
, first_order
+ len_order
);
885 end_order
= first_order
+ len_order
;
886 assert(first_order
> 0);
887 assert(t
->size
== (1UL << (end_order
- 1)));
888 for (i
= end_order
- 1; i
>= first_order
; i
--) {
889 unsigned long j
, len
;
891 len
= !i
? 1 : 1UL << (i
- 1);
892 dbg_printf("fini order %lu len: %lu\n", i
, len
);
894 * Update table size. Need to shrink this table prior to
895 * removal so gc lookups use non-logically-removed dummy
898 t
->size
= 1UL << (i
- 2);
900 for (j
= 0; j
< len
; j
++) {
901 struct cds_lfht_node
*fini_node
=
902 (struct cds_lfht_node
*) &t
->tbl
[i
]->nodes
[j
];
904 dbg_printf("fini entry: i %lu j %lu hash %lu\n",
905 i
, j
, !i
? 0 : (1UL << (i
- 1)) + j
);
906 fini_node
->p
.reverse_hash
=
907 bit_reverse_ulong(!i
? 0 : (1UL << (i
- 1)) + j
);
908 (void) _cds_lfht_remove(ht
, t
, fini_node
, 1);
909 if (CMM_LOAD_SHARED(ht
->in_progress_destroy
))
912 ht
->cds_lfht_call_rcu(&t
->tbl
[i
]->head
, cds_lfht_free_level
);
913 dbg_printf("fini new size: %lu\n", t
->size
);
914 if (CMM_LOAD_SHARED(ht
->in_progress_destroy
))
917 t
->resize_target
= t
->size
;
918 t
->resize_initiated
= 0;
921 struct cds_lfht
*cds_lfht_new(cds_lfht_hash_fct hash_fct
,
922 cds_lfht_compare_fct compare_fct
,
923 unsigned long hash_seed
,
924 unsigned long init_size
,
926 void (*cds_lfht_call_rcu
)(struct rcu_head
*head
,
927 void (*func
)(struct rcu_head
*head
)),
928 void (*cds_lfht_synchronize_rcu
)(void))
933 /* init_size must be power of two */
934 if (init_size
&& (init_size
& (init_size
- 1)))
936 ht
= calloc(1, sizeof(struct cds_lfht
));
937 ht
->hash_fct
= hash_fct
;
938 ht
->compare_fct
= compare_fct
;
939 ht
->hash_seed
= hash_seed
;
940 ht
->cds_lfht_call_rcu
= cds_lfht_call_rcu
;
941 ht
->cds_lfht_synchronize_rcu
= cds_lfht_synchronize_rcu
;
942 ht
->in_progress_resize
= 0;
943 ht
->percpu_count
= alloc_per_cpu_items_count();
944 /* this mutex should not nest in read-side C.S. */
945 pthread_mutex_init(&ht
->resize_mutex
, NULL
);
946 order
= get_count_order_ulong(max(init_size
, MIN_TABLE_SIZE
)) + 1;
947 ht
->t
= calloc(1, sizeof(struct cds_lfht
)
948 + (order
* sizeof(struct rcu_level
*)));
951 pthread_mutex_lock(&ht
->resize_mutex
);
952 init_table(ht
, ht
->t
, 0, order
);
953 pthread_mutex_unlock(&ht
->resize_mutex
);
957 struct cds_lfht_node
*cds_lfht_lookup(struct cds_lfht
*ht
, void *key
, size_t key_len
)
960 struct cds_lfht_node
*node
, *next
;
961 struct _cds_lfht_node
*lookup
;
962 unsigned long hash
, reverse_hash
, index
, order
;
964 hash
= ht
->hash_fct(key
, key_len
, ht
->hash_seed
);
965 reverse_hash
= bit_reverse_ulong(hash
);
967 t
= rcu_dereference(ht
->t
);
968 index
= hash
& (t
->size
- 1);
969 order
= get_count_order_ulong(index
+ 1);
970 lookup
= &t
->tbl
[order
]->nodes
[index
& (!order
? 0 : ((1UL << (order
- 1))) - 1)];
971 dbg_printf("lookup hash %lu index %lu order %lu aridx %lu\n",
972 hash
, index
, order
, index
& (!order
? 0 : ((1UL << (order
- 1)) - 1)));
973 node
= (struct cds_lfht_node
*) lookup
;
977 if (unlikely(node
->p
.reverse_hash
> reverse_hash
)) {
981 next
= rcu_dereference(node
->p
.next
);
982 if (likely(!is_removed(next
))
984 && likely(!ht
->compare_fct(node
->key
, node
->key_len
, key
, key_len
))) {
987 node
= clear_flag(next
);
989 assert(!node
|| !is_dummy(rcu_dereference(node
->p
.next
)));
993 struct cds_lfht_node
*cds_lfht_next(struct cds_lfht
*ht
,
994 struct cds_lfht_node
*node
)
996 struct cds_lfht_node
*next
;
997 unsigned long reverse_hash
;
1001 reverse_hash
= node
->p
.reverse_hash
;
1003 key_len
= node
->key_len
;
1004 next
= rcu_dereference(node
->p
.next
);
1005 node
= clear_flag(next
);
1008 if (unlikely(!node
))
1010 if (unlikely(node
->p
.reverse_hash
> reverse_hash
)) {
1014 next
= rcu_dereference(node
->p
.next
);
1015 if (likely(!is_removed(next
))
1017 && likely(!ht
->compare_fct(node
->key
, node
->key_len
, key
, key_len
))) {
1020 node
= clear_flag(next
);
1022 assert(!node
|| !is_dummy(rcu_dereference(node
->p
.next
)));
1026 void cds_lfht_add(struct cds_lfht
*ht
, struct cds_lfht_node
*node
)
1028 struct rcu_table
*t
;
1031 hash
= ht
->hash_fct(node
->key
, node
->key_len
, ht
->hash_seed
);
1032 node
->p
.reverse_hash
= bit_reverse_ulong((unsigned long) hash
);
1034 t
= rcu_dereference(ht
->t
);
1035 (void) _cds_lfht_add(ht
, t
, node
, 0, 0);
1036 ht_count_add(ht
, t
);
1039 struct cds_lfht_node
*cds_lfht_add_unique(struct cds_lfht
*ht
,
1040 struct cds_lfht_node
*node
)
1042 struct rcu_table
*t
;
1044 struct cds_lfht_node
*ret
;
1046 hash
= ht
->hash_fct(node
->key
, node
->key_len
, ht
->hash_seed
);
1047 node
->p
.reverse_hash
= bit_reverse_ulong((unsigned long) hash
);
1049 t
= rcu_dereference(ht
->t
);
1050 ret
= _cds_lfht_add(ht
, t
, node
, 1, 0);
1052 ht_count_add(ht
, t
);
1056 int cds_lfht_remove(struct cds_lfht
*ht
, struct cds_lfht_node
*node
)
1058 struct rcu_table
*t
;
1061 t
= rcu_dereference(ht
->t
);
1062 ret
= _cds_lfht_remove(ht
, t
, node
, 0);
1064 ht_count_remove(ht
, t
);
1069 int cds_lfht_delete_dummy(struct cds_lfht
*ht
)
1071 struct rcu_table
*t
;
1072 struct cds_lfht_node
*node
;
1073 struct _cds_lfht_node
*lookup
;
1074 unsigned long order
, i
;
1077 /* Check that the table is empty */
1078 lookup
= &t
->tbl
[0]->nodes
[0];
1079 node
= (struct cds_lfht_node
*) lookup
;
1081 node
= clear_flag(node
)->p
.next
;
1082 if (!is_dummy(node
))
1084 assert(!is_removed(node
));
1085 } while (clear_flag(node
));
1086 /* Internal sanity check: all nodes left should be dummy */
1087 for (order
= 0; order
< get_count_order_ulong(t
->size
) + 1; order
++) {
1090 len
= !order
? 1 : 1UL << (order
- 1);
1091 for (i
= 0; i
< len
; i
++) {
1092 dbg_printf("delete order %lu i %lu hash %lu\n",
1094 bit_reverse_ulong(t
->tbl
[order
]->nodes
[i
].reverse_hash
));
1095 assert(is_dummy(t
->tbl
[order
]->nodes
[i
].next
));
1097 free(t
->tbl
[order
]);
1103 * Should only be called when no more concurrent readers nor writers can
1104 * possibly access the table.
1106 int cds_lfht_destroy(struct cds_lfht
*ht
)
1110 /* Wait for in-flight resize operations to complete */
1111 CMM_STORE_SHARED(ht
->in_progress_destroy
, 1);
1112 while (uatomic_read(&ht
->in_progress_resize
))
1113 poll(NULL
, 0, 100); /* wait for 100ms */
1114 ret
= cds_lfht_delete_dummy(ht
);
1118 free_per_cpu_items_count(ht
->percpu_count
);
1123 void cds_lfht_count_nodes(struct cds_lfht
*ht
,
1124 unsigned long *count
,
1125 unsigned long *removed
)
1127 struct rcu_table
*t
;
1128 struct cds_lfht_node
*node
, *next
;
1129 struct _cds_lfht_node
*lookup
;
1130 unsigned long nr_dummy
= 0;
1135 t
= rcu_dereference(ht
->t
);
1136 /* Count non-dummy nodes in the table */
1137 lookup
= &t
->tbl
[0]->nodes
[0];
1138 node
= (struct cds_lfht_node
*) lookup
;
1140 next
= rcu_dereference(node
->p
.next
);
1141 if (is_removed(next
)) {
1142 assert(!is_dummy(next
));
1144 } else if (!is_dummy(next
))
1148 node
= clear_flag(next
);
1150 dbg_printf("number of dummy nodes: %lu\n", nr_dummy
);
1153 /* called with resize mutex held */
1155 void _do_cds_lfht_grow(struct cds_lfht
*ht
, struct rcu_table
*old_t
,
1156 unsigned long old_size
, unsigned long new_size
)
1158 unsigned long old_order
, new_order
;
1159 struct rcu_table
*new_t
;
1161 old_order
= get_count_order_ulong(old_size
) + 1;
1162 new_order
= get_count_order_ulong(new_size
) + 1;
1163 printf("resize from %lu (order %lu) to %lu (order %lu) buckets\n",
1164 old_size
, old_order
, new_size
, new_order
);
1165 new_t
= malloc(sizeof(struct cds_lfht
)
1166 + (new_order
* sizeof(struct rcu_level
*)));
1167 assert(new_size
> old_size
);
1168 memcpy(&new_t
->tbl
, &old_t
->tbl
,
1169 old_order
* sizeof(struct rcu_level
*));
1170 init_table(ht
, new_t
, old_order
, new_order
- old_order
);
1171 /* Changing table and size atomically wrt lookups */
1172 rcu_assign_pointer(ht
->t
, new_t
);
1173 ht
->cds_lfht_call_rcu(&old_t
->head
, cds_lfht_free_table_cb
);
1176 /* called with resize mutex held */
1178 void _do_cds_lfht_shrink(struct cds_lfht
*ht
, struct rcu_table
*old_t
,
1179 unsigned long old_size
, unsigned long new_size
)
1181 unsigned long old_order
, new_order
;
1182 struct rcu_table
*new_t
;
1184 new_size
= max(new_size
, MIN_TABLE_SIZE
);
1185 old_order
= get_count_order_ulong(old_size
) + 1;
1186 new_order
= get_count_order_ulong(new_size
) + 1;
1187 printf("resize from %lu (order %lu) to %lu (order %lu) buckets\n",
1188 old_size
, old_order
, new_size
, new_order
);
1189 new_t
= malloc(sizeof(struct cds_lfht
)
1190 + (new_order
* sizeof(struct rcu_level
*)));
1191 assert(new_size
< old_size
);
1192 memcpy(&new_t
->tbl
, &old_t
->tbl
,
1193 new_order
* sizeof(struct rcu_level
*));
1194 new_t
->size
= !new_order
? 1 : (1UL << (new_order
- 1));
1195 assert(new_t
->size
== new_size
);
1196 new_t
->resize_target
= new_t
->size
;
1197 new_t
->resize_initiated
= 0;
1199 /* Changing table and size atomically wrt lookups */
1200 rcu_assign_pointer(ht
->t
, new_t
);
1203 * We need to wait for all add operations to reach Q.S. (and
1204 * thus use the new table for lookups) before we can start
1205 * releasing the old dummy nodes. Otherwise their lookup will
1206 * return a logically removed node as insert position.
1208 ht
->cds_lfht_synchronize_rcu();
1210 /* Unlink and remove all now-unused dummy node pointers. */
1211 fini_table(ht
, old_t
, new_order
, old_order
- new_order
);
1212 ht
->cds_lfht_call_rcu(&old_t
->head
, cds_lfht_free_table_cb
);
1216 /* called with resize mutex held */
1218 void _do_cds_lfht_resize(struct cds_lfht
*ht
)
1220 unsigned long new_size
, old_size
;
1221 struct rcu_table
*old_t
;
1224 old_size
= old_t
->size
;
1225 new_size
= CMM_LOAD_SHARED(old_t
->resize_target
);
1226 if (old_size
< new_size
)
1227 _do_cds_lfht_grow(ht
, old_t
, old_size
, new_size
);
1228 else if (old_size
> new_size
)
1229 _do_cds_lfht_shrink(ht
, old_t
, old_size
, new_size
);
1231 CMM_STORE_SHARED(old_t
->resize_initiated
, 0);
1235 unsigned long resize_target_update(struct rcu_table
*t
,
1238 return _uatomic_max(&t
->resize_target
,
1239 t
->size
<< growth_order
);
1243 void resize_target_update_count(struct rcu_table
*t
,
1244 unsigned long count
)
1246 count
= max(count
, MIN_TABLE_SIZE
);
1247 uatomic_set(&t
->resize_target
, count
);
1250 void cds_lfht_resize(struct cds_lfht
*ht
, unsigned long new_size
)
1252 struct rcu_table
*t
= rcu_dereference(ht
->t
);
1254 resize_target_update_count(t
, new_size
);
1255 CMM_STORE_SHARED(t
->resize_initiated
, 1);
1256 pthread_mutex_lock(&ht
->resize_mutex
);
1257 _do_cds_lfht_resize(ht
);
1258 pthread_mutex_unlock(&ht
->resize_mutex
);
1262 void do_resize_cb(struct rcu_head
*head
)
1264 struct rcu_resize_work
*work
=
1265 caa_container_of(head
, struct rcu_resize_work
, head
);
1266 struct cds_lfht
*ht
= work
->ht
;
1268 pthread_mutex_lock(&ht
->resize_mutex
);
1269 _do_cds_lfht_resize(ht
);
1270 pthread_mutex_unlock(&ht
->resize_mutex
);
1272 cmm_smp_mb(); /* finish resize before decrement */
1273 uatomic_dec(&ht
->in_progress_resize
);
1277 void cds_lfht_resize_lazy(struct cds_lfht
*ht
, struct rcu_table
*t
, int growth
)
1279 struct rcu_resize_work
*work
;
1280 unsigned long target_size
;
1282 target_size
= resize_target_update(t
, growth
);
1283 if (!CMM_LOAD_SHARED(t
->resize_initiated
) && t
->size
< target_size
) {
1284 uatomic_inc(&ht
->in_progress_resize
);
1285 cmm_smp_mb(); /* increment resize count before calling it */
1286 work
= malloc(sizeof(*work
));
1288 ht
->cds_lfht_call_rcu(&work
->head
, do_resize_cb
);
1289 CMM_STORE_SHARED(t
->resize_initiated
, 1);
1293 #if defined(HAVE_SCHED_GETCPU) && defined(HAVE_SYSCONF)
1296 void cds_lfht_resize_lazy_count(struct cds_lfht
*ht
, struct rcu_table
*t
,
1297 unsigned long count
)
1299 struct rcu_resize_work
*work
;
1301 if (!(ht
->flags
& CDS_LFHT_AUTO_RESIZE
))
1303 resize_target_update_count(t
, count
);
1304 if (!CMM_LOAD_SHARED(t
->resize_initiated
)) {
1305 uatomic_inc(&ht
->in_progress_resize
);
1306 cmm_smp_mb(); /* increment resize count before calling it */
1307 work
= malloc(sizeof(*work
));
1309 ht
->cds_lfht_call_rcu(&work
->head
, do_resize_cb
);
1310 CMM_STORE_SHARED(t
->resize_initiated
, 1);