Remove dead code in _cds_lfht_gc_bucket()
[urcu.git] / rculfhash.c
1 /*
2 * rculfhash.c
3 *
4 * Userspace RCU library - Lock-Free Resizable RCU Hash Table
5 *
6 * Copyright 2010-2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 *
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.
12 *
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.
17 *
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
21 */
22
23 /*
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,
30 * (2002), 73-82.
31 *
32 * Some specificities of this Lock-Free Resizable RCU Hash Table
33 * implementation:
34 *
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
44 * duplicata exists.
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
53 * operation.
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
83 * list concurrently.
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
88 * for it do to so.
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
94 * this order.
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.
99 *
100 * A bit of ascii art explanation:
101 *
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.
104 *
105 * This shows the nodes for a small table ordered by reversed bits:
106 *
107 * bits reverse
108 * 0 000 000
109 * 4 100 001
110 * 2 010 010
111 * 6 110 011
112 * 1 001 100
113 * 5 101 101
114 * 3 011 110
115 * 7 111 111
116 *
117 * This shows the nodes in order of non-reversed bits, linked by
118 * reversed-bit order.
119 *
120 * order bits reverse
121 * 0 0 000 000
122 * |
123 * 1 | 1 001 100 <- <-
124 * | | | |
125 * 2 | | 2 010 010 | |
126 * | | | 3 011 110 | <- |
127 * | | | | | | |
128 * 3 -> | | | 4 100 001 | |
129 * -> | | 5 101 101 |
130 * -> | 6 110 011
131 * -> 7 111 111
132 */
133
134 #define _LGPL_SOURCE
135 #include <stdlib.h>
136 #include <errno.h>
137 #include <assert.h>
138 #include <stdio.h>
139 #include <stdint.h>
140 #include <string.h>
141
142 #include "config.h"
143 #include <urcu.h>
144 #include <urcu-call-rcu.h>
145 #include <urcu/arch.h>
146 #include <urcu/uatomic.h>
147 #include <urcu/compiler.h>
148 #include <urcu/rculfhash.h>
149 #include <stdio.h>
150 #include <pthread.h>
151
152 #ifdef DEBUG
153 #define dbg_printf(fmt, args...) printf("[debug rculfhash] " fmt, ## args)
154 #else
155 #define dbg_printf(fmt, args...)
156 #endif
157
158 /*
159 * Per-CPU split-counters lazily update the global counter each 1024
160 * addition/removal. It automatically keeps track of resize required.
161 * We use the bucket length as indicator for need to expand for small
162 * tables and machines lacking per-cpu data suppport.
163 */
164 #define COUNT_COMMIT_ORDER 10
165 #define CHAIN_LEN_TARGET 1
166 #define CHAIN_LEN_RESIZE_THRESHOLD 3
167
168 /*
169 * Define the minimum table size.
170 */
171 #define MIN_TABLE_SIZE 1
172
173 #if (CAA_BITS_PER_LONG == 32)
174 #define MAX_TABLE_ORDER 32
175 #else
176 #define MAX_TABLE_ORDER 64
177 #endif
178
179 /*
180 * Minimum number of dummy nodes to touch per thread to parallelize grow/shrink.
181 */
182 #define MIN_PARTITION_PER_THREAD_ORDER 12
183 #define MIN_PARTITION_PER_THREAD (1UL << MIN_PARTITION_PER_THREAD_ORDER)
184
185 #ifndef min
186 #define min(a, b) ((a) < (b) ? (a) : (b))
187 #endif
188
189 #ifndef max
190 #define max(a, b) ((a) > (b) ? (a) : (b))
191 #endif
192
193 /*
194 * The removed flag needs to be updated atomically with the pointer.
195 * It indicates that no node must attach to the node scheduled for
196 * removal, and that node garbage collection must be performed.
197 * The dummy flag does not require to be updated atomically with the
198 * pointer, but it is added as a pointer low bit flag to save space.
199 */
200 #define REMOVED_FLAG (1UL << 0)
201 #define DUMMY_FLAG (1UL << 1)
202 #define FLAGS_MASK ((1UL << 2) - 1)
203
204 /* Value of the end pointer. Should not interact with flags. */
205 #define END_VALUE NULL
206
207 struct ht_items_count {
208 unsigned long add, del;
209 } __attribute__((aligned(CAA_CACHE_LINE_SIZE)));
210
211 struct rcu_level {
212 /* Note: manually update allocation length when adding a field */
213 struct _cds_lfht_node nodes[0];
214 };
215
216 struct rcu_table {
217 unsigned long size; /* always a power of 2, shared (RCU) */
218 unsigned long resize_target;
219 int resize_initiated;
220 struct rcu_level *tbl[MAX_TABLE_ORDER];
221 };
222
223 struct cds_lfht {
224 struct rcu_table t;
225 cds_lfht_hash_fct hash_fct;
226 cds_lfht_compare_fct compare_fct;
227 unsigned long hash_seed;
228 int flags;
229 /*
230 * We need to put the work threads offline (QSBR) when taking this
231 * mutex, because we use synchronize_rcu within this mutex critical
232 * section, which waits on read-side critical sections, and could
233 * therefore cause grace-period deadlock if we hold off RCU G.P.
234 * completion.
235 */
236 pthread_mutex_t resize_mutex; /* resize mutex: add/del mutex */
237 unsigned int in_progress_resize, in_progress_destroy;
238 void (*cds_lfht_call_rcu)(struct rcu_head *head,
239 void (*func)(struct rcu_head *head));
240 void (*cds_lfht_synchronize_rcu)(void);
241 void (*cds_lfht_rcu_read_lock)(void);
242 void (*cds_lfht_rcu_read_unlock)(void);
243 void (*cds_lfht_rcu_thread_offline)(void);
244 void (*cds_lfht_rcu_thread_online)(void);
245 void (*cds_lfht_rcu_register_thread)(void);
246 void (*cds_lfht_rcu_unregister_thread)(void);
247 pthread_attr_t *resize_attr; /* Resize threads attributes */
248 long count; /* global approximate item count */
249 struct ht_items_count *percpu_count; /* per-cpu item count */
250 };
251
252 struct rcu_resize_work {
253 struct rcu_head head;
254 struct cds_lfht *ht;
255 };
256
257 struct partition_resize_work {
258 pthread_t thread_id;
259 struct cds_lfht *ht;
260 unsigned long i, start, len;
261 void (*fct)(struct cds_lfht *ht, unsigned long i,
262 unsigned long start, unsigned long len);
263 };
264
265 static
266 void _cds_lfht_add(struct cds_lfht *ht,
267 unsigned long size,
268 struct cds_lfht_node *node,
269 struct cds_lfht_iter *unique_ret,
270 int dummy);
271
272 /*
273 * Algorithm to reverse bits in a word by lookup table, extended to
274 * 64-bit words.
275 * Source:
276 * http://graphics.stanford.edu/~seander/bithacks.html#BitReverseTable
277 * Originally from Public Domain.
278 */
279
280 static const uint8_t BitReverseTable256[256] =
281 {
282 #define R2(n) (n), (n) + 2*64, (n) + 1*64, (n) + 3*64
283 #define R4(n) R2(n), R2((n) + 2*16), R2((n) + 1*16), R2((n) + 3*16)
284 #define R6(n) R4(n), R4((n) + 2*4 ), R4((n) + 1*4 ), R4((n) + 3*4 )
285 R6(0), R6(2), R6(1), R6(3)
286 };
287 #undef R2
288 #undef R4
289 #undef R6
290
291 static
292 uint8_t bit_reverse_u8(uint8_t v)
293 {
294 return BitReverseTable256[v];
295 }
296
297 static __attribute__((unused))
298 uint32_t bit_reverse_u32(uint32_t v)
299 {
300 return ((uint32_t) bit_reverse_u8(v) << 24) |
301 ((uint32_t) bit_reverse_u8(v >> 8) << 16) |
302 ((uint32_t) bit_reverse_u8(v >> 16) << 8) |
303 ((uint32_t) bit_reverse_u8(v >> 24));
304 }
305
306 static __attribute__((unused))
307 uint64_t bit_reverse_u64(uint64_t v)
308 {
309 return ((uint64_t) bit_reverse_u8(v) << 56) |
310 ((uint64_t) bit_reverse_u8(v >> 8) << 48) |
311 ((uint64_t) bit_reverse_u8(v >> 16) << 40) |
312 ((uint64_t) bit_reverse_u8(v >> 24) << 32) |
313 ((uint64_t) bit_reverse_u8(v >> 32) << 24) |
314 ((uint64_t) bit_reverse_u8(v >> 40) << 16) |
315 ((uint64_t) bit_reverse_u8(v >> 48) << 8) |
316 ((uint64_t) bit_reverse_u8(v >> 56));
317 }
318
319 static
320 unsigned long bit_reverse_ulong(unsigned long v)
321 {
322 #if (CAA_BITS_PER_LONG == 32)
323 return bit_reverse_u32(v);
324 #else
325 return bit_reverse_u64(v);
326 #endif
327 }
328
329 /*
330 * fls: returns the position of the most significant bit.
331 * Returns 0 if no bit is set, else returns the position of the most
332 * significant bit (from 1 to 32 on 32-bit, from 1 to 64 on 64-bit).
333 */
334 #if defined(__i386) || defined(__x86_64)
335 static inline
336 unsigned int fls_u32(uint32_t x)
337 {
338 int r;
339
340 asm("bsrl %1,%0\n\t"
341 "jnz 1f\n\t"
342 "movl $-1,%0\n\t"
343 "1:\n\t"
344 : "=r" (r) : "rm" (x));
345 return r + 1;
346 }
347 #define HAS_FLS_U32
348 #endif
349
350 #if defined(__x86_64)
351 static inline
352 unsigned int fls_u64(uint64_t x)
353 {
354 long r;
355
356 asm("bsrq %1,%0\n\t"
357 "jnz 1f\n\t"
358 "movq $-1,%0\n\t"
359 "1:\n\t"
360 : "=r" (r) : "rm" (x));
361 return r + 1;
362 }
363 #define HAS_FLS_U64
364 #endif
365
366 #ifndef HAS_FLS_U64
367 static __attribute__((unused))
368 unsigned int fls_u64(uint64_t x)
369 {
370 unsigned int r = 64;
371
372 if (!x)
373 return 0;
374
375 if (!(x & 0xFFFFFFFF00000000ULL)) {
376 x <<= 32;
377 r -= 32;
378 }
379 if (!(x & 0xFFFF000000000000ULL)) {
380 x <<= 16;
381 r -= 16;
382 }
383 if (!(x & 0xFF00000000000000ULL)) {
384 x <<= 8;
385 r -= 8;
386 }
387 if (!(x & 0xF000000000000000ULL)) {
388 x <<= 4;
389 r -= 4;
390 }
391 if (!(x & 0xC000000000000000ULL)) {
392 x <<= 2;
393 r -= 2;
394 }
395 if (!(x & 0x8000000000000000ULL)) {
396 x <<= 1;
397 r -= 1;
398 }
399 return r;
400 }
401 #endif
402
403 #ifndef HAS_FLS_U32
404 static __attribute__((unused))
405 unsigned int fls_u32(uint32_t x)
406 {
407 unsigned int r = 32;
408
409 if (!x)
410 return 0;
411 if (!(x & 0xFFFF0000U)) {
412 x <<= 16;
413 r -= 16;
414 }
415 if (!(x & 0xFF000000U)) {
416 x <<= 8;
417 r -= 8;
418 }
419 if (!(x & 0xF0000000U)) {
420 x <<= 4;
421 r -= 4;
422 }
423 if (!(x & 0xC0000000U)) {
424 x <<= 2;
425 r -= 2;
426 }
427 if (!(x & 0x80000000U)) {
428 x <<= 1;
429 r -= 1;
430 }
431 return r;
432 }
433 #endif
434
435 unsigned int fls_ulong(unsigned long x)
436 {
437 #if (CAA_BITS_PER_lONG == 32)
438 return fls_u32(x);
439 #else
440 return fls_u64(x);
441 #endif
442 }
443
444 /*
445 * Return the minimum order for which x <= (1UL << order).
446 * Return -1 if x is 0.
447 */
448 int get_count_order_u32(uint32_t x)
449 {
450 if (!x)
451 return -1;
452
453 return fls_u32(x - 1);
454 }
455
456 /*
457 * Return the minimum order for which x <= (1UL << order).
458 * Return -1 if x is 0.
459 */
460 int get_count_order_ulong(unsigned long x)
461 {
462 if (!x)
463 return -1;
464
465 return fls_ulong(x - 1);
466 }
467
468 #ifdef POISON_FREE
469 #define poison_free(ptr) \
470 do { \
471 memset(ptr, 0x42, sizeof(*(ptr))); \
472 free(ptr); \
473 } while (0)
474 #else
475 #define poison_free(ptr) free(ptr)
476 #endif
477
478 static
479 void cds_lfht_resize_lazy(struct cds_lfht *ht, unsigned long size, int growth);
480
481 /*
482 * If the sched_getcpu() and sysconf(_SC_NPROCESSORS_CONF) calls are
483 * available, then we support hash table item accounting.
484 * In the unfortunate event the number of CPUs reported would be
485 * inaccurate, we use modulo arithmetic on the number of CPUs we got.
486 */
487 #if defined(HAVE_SCHED_GETCPU) && defined(HAVE_SYSCONF)
488
489 static
490 void cds_lfht_resize_lazy_count(struct cds_lfht *ht, unsigned long size,
491 unsigned long count);
492
493 static long nr_cpus_mask = -1;
494
495 static
496 struct ht_items_count *alloc_per_cpu_items_count(void)
497 {
498 struct ht_items_count *count;
499
500 switch (nr_cpus_mask) {
501 case -2:
502 return NULL;
503 case -1:
504 {
505 long maxcpus;
506
507 maxcpus = sysconf(_SC_NPROCESSORS_CONF);
508 if (maxcpus <= 0) {
509 nr_cpus_mask = -2;
510 return NULL;
511 }
512 /*
513 * round up number of CPUs to next power of two, so we
514 * can use & for modulo.
515 */
516 maxcpus = 1UL << get_count_order_ulong(maxcpus);
517 nr_cpus_mask = maxcpus - 1;
518 }
519 /* Fall-through */
520 default:
521 return calloc(nr_cpus_mask + 1, sizeof(*count));
522 }
523 }
524
525 static
526 void free_per_cpu_items_count(struct ht_items_count *count)
527 {
528 poison_free(count);
529 }
530
531 static
532 int ht_get_cpu(void)
533 {
534 int cpu;
535
536 assert(nr_cpus_mask >= 0);
537 cpu = sched_getcpu();
538 if (unlikely(cpu < 0))
539 return cpu;
540 else
541 return cpu & nr_cpus_mask;
542 }
543
544 static
545 void ht_count_add(struct cds_lfht *ht, unsigned long size)
546 {
547 unsigned long percpu_count;
548 int cpu;
549
550 if (unlikely(!ht->percpu_count))
551 return;
552 cpu = ht_get_cpu();
553 if (unlikely(cpu < 0))
554 return;
555 percpu_count = uatomic_add_return(&ht->percpu_count[cpu].add, 1);
556 if (unlikely(!(percpu_count & ((1UL << COUNT_COMMIT_ORDER) - 1)))) {
557 long count;
558
559 dbg_printf("add percpu %lu\n", percpu_count);
560 count = uatomic_add_return(&ht->count,
561 1UL << COUNT_COMMIT_ORDER);
562 /* If power of 2 */
563 if (!(count & (count - 1))) {
564 if ((count >> CHAIN_LEN_RESIZE_THRESHOLD) < size)
565 return;
566 dbg_printf("add set global %ld\n", count);
567 cds_lfht_resize_lazy_count(ht, size,
568 count >> (CHAIN_LEN_TARGET - 1));
569 }
570 }
571 }
572
573 static
574 void ht_count_del(struct cds_lfht *ht, unsigned long size)
575 {
576 unsigned long percpu_count;
577 int cpu;
578
579 if (unlikely(!ht->percpu_count))
580 return;
581 cpu = ht_get_cpu();
582 if (unlikely(cpu < 0))
583 return;
584 percpu_count = uatomic_add_return(&ht->percpu_count[cpu].del, 1);
585 if (unlikely(!(percpu_count & ((1UL << COUNT_COMMIT_ORDER) - 1)))) {
586 long count;
587
588 dbg_printf("del percpu %lu\n", percpu_count);
589 count = uatomic_add_return(&ht->count,
590 -(1UL << COUNT_COMMIT_ORDER));
591 /* If power of 2 */
592 if (!(count & (count - 1))) {
593 if ((count >> CHAIN_LEN_RESIZE_THRESHOLD) >= size)
594 return;
595 dbg_printf("del set global %ld\n", count);
596 /*
597 * Don't shrink table if the number of nodes is below a
598 * certain threshold.
599 */
600 if (count < (1UL << COUNT_COMMIT_ORDER) * (nr_cpus_mask + 1))
601 return;
602 cds_lfht_resize_lazy_count(ht, size,
603 count >> (CHAIN_LEN_TARGET - 1));
604 }
605 }
606 }
607
608 #else /* #if defined(HAVE_SCHED_GETCPU) && defined(HAVE_SYSCONF) */
609
610 static const long nr_cpus_mask = -2;
611
612 static
613 struct ht_items_count *alloc_per_cpu_items_count(void)
614 {
615 return NULL;
616 }
617
618 static
619 void free_per_cpu_items_count(struct ht_items_count *count)
620 {
621 }
622
623 static
624 void ht_count_add(struct cds_lfht *ht, unsigned long size)
625 {
626 }
627
628 static
629 void ht_count_del(struct cds_lfht *ht, unsigned long size)
630 {
631 }
632
633 #endif /* #else #if defined(HAVE_SCHED_GETCPU) && defined(HAVE_SYSCONF) */
634
635
636 static
637 void check_resize(struct cds_lfht *ht, unsigned long size, uint32_t chain_len)
638 {
639 unsigned long count;
640
641 if (!(ht->flags & CDS_LFHT_AUTO_RESIZE))
642 return;
643 count = uatomic_read(&ht->count);
644 /*
645 * Use bucket-local length for small table expand and for
646 * environments lacking per-cpu data support.
647 */
648 if (count >= (1UL << COUNT_COMMIT_ORDER))
649 return;
650 if (chain_len > 100)
651 dbg_printf("WARNING: large chain length: %u.\n",
652 chain_len);
653 if (chain_len >= CHAIN_LEN_RESIZE_THRESHOLD)
654 cds_lfht_resize_lazy(ht, size,
655 get_count_order_u32(chain_len - (CHAIN_LEN_TARGET - 1)));
656 }
657
658 static
659 struct cds_lfht_node *clear_flag(struct cds_lfht_node *node)
660 {
661 return (struct cds_lfht_node *) (((unsigned long) node) & ~FLAGS_MASK);
662 }
663
664 static
665 int is_removed(struct cds_lfht_node *node)
666 {
667 return ((unsigned long) node) & REMOVED_FLAG;
668 }
669
670 static
671 struct cds_lfht_node *flag_removed(struct cds_lfht_node *node)
672 {
673 return (struct cds_lfht_node *) (((unsigned long) node) | REMOVED_FLAG);
674 }
675
676 static
677 int is_dummy(struct cds_lfht_node *node)
678 {
679 return ((unsigned long) node) & DUMMY_FLAG;
680 }
681
682 static
683 struct cds_lfht_node *flag_dummy(struct cds_lfht_node *node)
684 {
685 return (struct cds_lfht_node *) (((unsigned long) node) | DUMMY_FLAG);
686 }
687
688 static
689 struct cds_lfht_node *get_end(void)
690 {
691 return (struct cds_lfht_node *) END_VALUE;
692 }
693
694 static
695 int is_end(struct cds_lfht_node *node)
696 {
697 return clear_flag(node) == (struct cds_lfht_node *) END_VALUE;
698 }
699
700 static
701 unsigned long _uatomic_max(unsigned long *ptr, unsigned long v)
702 {
703 unsigned long old1, old2;
704
705 old1 = uatomic_read(ptr);
706 do {
707 old2 = old1;
708 if (old2 >= v)
709 return old2;
710 } while ((old1 = uatomic_cmpxchg(ptr, old2, v)) != old2);
711 return v;
712 }
713
714 static
715 struct _cds_lfht_node *lookup_bucket(struct cds_lfht *ht, unsigned long size,
716 unsigned long hash)
717 {
718 unsigned long index, order;
719
720 assert(size > 0);
721 index = hash & (size - 1);
722 /*
723 * equivalent to get_count_order_ulong(index + 1), but optimizes
724 * away the non-existing 0 special-case for
725 * get_count_order_ulong.
726 */
727 order = fls_ulong(index);
728
729 dbg_printf("lookup hash %lu index %lu order %lu aridx %lu\n",
730 hash, index, order, index & (!order ? 0 : ((1UL << (order - 1)) - 1)));
731
732 return &ht->t.tbl[order]->nodes[index & (!order ? 0 : ((1UL << (order - 1)) - 1))];
733 }
734
735 /*
736 * Remove all logically deleted nodes from a bucket up to a certain node key.
737 */
738 static
739 void _cds_lfht_gc_bucket(struct cds_lfht_node *dummy, struct cds_lfht_node *node)
740 {
741 struct cds_lfht_node *iter_prev, *iter, *next, *new_next;
742
743 assert(!is_dummy(dummy));
744 assert(!is_removed(dummy));
745 assert(!is_dummy(node));
746 assert(!is_removed(node));
747 for (;;) {
748 iter_prev = dummy;
749 /* We can always skip the dummy node initially */
750 iter = rcu_dereference(iter_prev->p.next);
751 assert(!is_removed(iter));
752 assert(iter_prev->p.reverse_hash <= node->p.reverse_hash);
753 /*
754 * We should never be called with dummy (start of chain)
755 * and logically removed node (end of path compression
756 * marker) being the actual same node. This would be a
757 * bug in the algorithm implementation.
758 */
759 assert(dummy != node);
760 for (;;) {
761 if (unlikely(is_end(iter)))
762 return;
763 if (likely(clear_flag(iter)->p.reverse_hash > node->p.reverse_hash))
764 return;
765 next = rcu_dereference(clear_flag(iter)->p.next);
766 if (likely(is_removed(next)))
767 break;
768 iter_prev = clear_flag(iter);
769 iter = next;
770 }
771 assert(!is_removed(iter));
772 if (is_dummy(iter))
773 new_next = flag_dummy(clear_flag(next));
774 else
775 new_next = clear_flag(next);
776 (void) uatomic_cmpxchg(&iter_prev->p.next, iter, new_next);
777 }
778 return;
779 }
780
781 static
782 int _cds_lfht_replace(struct cds_lfht *ht, unsigned long size,
783 struct cds_lfht_node *old_node,
784 struct cds_lfht_node *old_next,
785 struct cds_lfht_node *new_node)
786 {
787 struct cds_lfht_node *dummy, *ret_next;
788 struct _cds_lfht_node *lookup;
789 int flagged = 0;
790
791 if (!old_node) /* Return -ENOENT if asked to replace NULL node */
792 goto end;
793
794 assert(!is_removed(old_node));
795 assert(!is_dummy(old_node));
796 assert(!is_removed(new_node));
797 assert(!is_dummy(new_node));
798 assert(new_node != old_node);
799 for (;;) {
800 /* Insert after node to be replaced */
801 if (is_removed(old_next)) {
802 /*
803 * Too late, the old node has been removed under us
804 * between lookup and replace. Fail.
805 */
806 goto end;
807 }
808 assert(!is_dummy(old_next));
809 assert(new_node != clear_flag(old_next));
810 new_node->p.next = clear_flag(old_next);
811 /*
812 * Here is the whole trick for lock-free replace: we add
813 * the replacement node _after_ the node we want to
814 * replace by atomically setting its next pointer at the
815 * same time we set its removal flag. Given that
816 * the lookups/get next use an iterator aware of the
817 * next pointer, they will either skip the old node due
818 * to the removal flag and see the new node, or use
819 * the old node, but will not see the new one.
820 */
821 ret_next = uatomic_cmpxchg(&old_node->p.next,
822 old_next, flag_removed(new_node));
823 if (ret_next == old_next)
824 break;
825 old_next = ret_next;
826 }
827
828 /* We performed the replacement. */
829 flagged = 1;
830
831 /*
832 * Ensure that the old node is not visible to readers anymore:
833 * lookup for the node, and remove it (along with any other
834 * logically removed node) if found.
835 */
836 lookup = lookup_bucket(ht, size, bit_reverse_ulong(old_node->p.reverse_hash));
837 dummy = (struct cds_lfht_node *) lookup;
838 _cds_lfht_gc_bucket(dummy, new_node);
839 end:
840 /*
841 * Only the flagging action indicated that we (and no other)
842 * replaced the node from the hash table.
843 */
844 if (flagged) {
845 assert(is_removed(rcu_dereference(old_node->p.next)));
846 return 0;
847 } else {
848 return -ENOENT;
849 }
850 }
851
852 /*
853 * A non-NULL unique_ret pointer uses the "add unique" (or uniquify) add
854 * mode. A NULL unique_ret allows creation of duplicate keys.
855 */
856 static
857 void _cds_lfht_add(struct cds_lfht *ht,
858 unsigned long size,
859 struct cds_lfht_node *node,
860 struct cds_lfht_iter *unique_ret,
861 int dummy)
862 {
863 struct cds_lfht_node *iter_prev, *iter, *next, *new_node, *new_next,
864 *return_node;
865 struct _cds_lfht_node *lookup;
866
867 assert(!is_dummy(node));
868 assert(!is_removed(node));
869 if (!size) {
870 assert(dummy);
871 assert(!unique_ret);
872 node->p.next = flag_dummy(get_end());
873 return; /* Initial first add (head) */
874 }
875 lookup = lookup_bucket(ht, size, bit_reverse_ulong(node->p.reverse_hash));
876 for (;;) {
877 uint32_t chain_len = 0;
878
879 /*
880 * iter_prev points to the non-removed node prior to the
881 * insert location.
882 */
883 iter_prev = (struct cds_lfht_node *) lookup;
884 /* We can always skip the dummy node initially */
885 iter = rcu_dereference(iter_prev->p.next);
886 assert(iter_prev->p.reverse_hash <= node->p.reverse_hash);
887 for (;;) {
888 if (unlikely(is_end(iter)))
889 goto insert;
890 if (likely(clear_flag(iter)->p.reverse_hash > node->p.reverse_hash))
891 goto insert;
892 /* dummy node is the first node of the identical-hash-value chain */
893 if (dummy && clear_flag(iter)->p.reverse_hash == node->p.reverse_hash)
894 goto insert;
895 next = rcu_dereference(clear_flag(iter)->p.next);
896 if (unlikely(is_removed(next)))
897 goto gc_node;
898 if (unique_ret
899 && !is_dummy(next)
900 && clear_flag(iter)->p.reverse_hash == node->p.reverse_hash
901 && !ht->compare_fct(node->key, node->key_len,
902 clear_flag(iter)->key,
903 clear_flag(iter)->key_len)) {
904 unique_ret->node = clear_flag(iter);
905 unique_ret->next = next;
906 return;
907 }
908 /* Only account for identical reverse hash once */
909 if (iter_prev->p.reverse_hash != clear_flag(iter)->p.reverse_hash
910 && !is_dummy(next))
911 check_resize(ht, size, ++chain_len);
912 iter_prev = clear_flag(iter);
913 iter = next;
914 }
915
916 insert:
917 assert(node != clear_flag(iter));
918 assert(!is_removed(iter_prev));
919 assert(!is_removed(iter));
920 assert(iter_prev != node);
921 if (!dummy)
922 node->p.next = clear_flag(iter);
923 else
924 node->p.next = flag_dummy(clear_flag(iter));
925 if (is_dummy(iter))
926 new_node = flag_dummy(node);
927 else
928 new_node = node;
929 if (uatomic_cmpxchg(&iter_prev->p.next, iter,
930 new_node) != iter) {
931 continue; /* retry */
932 } else {
933 return_node = node;
934 goto end;
935 }
936
937 gc_node:
938 assert(!is_removed(iter));
939 if (is_dummy(iter))
940 new_next = flag_dummy(clear_flag(next));
941 else
942 new_next = clear_flag(next);
943 (void) uatomic_cmpxchg(&iter_prev->p.next, iter, new_next);
944 /* retry */
945 }
946 end:
947 if (unique_ret) {
948 unique_ret->node = return_node;
949 /* unique_ret->next left unset, never used. */
950 }
951 }
952
953 static
954 int _cds_lfht_del(struct cds_lfht *ht, unsigned long size,
955 struct cds_lfht_node *node,
956 int dummy_removal)
957 {
958 struct cds_lfht_node *dummy, *next, *old;
959 struct _cds_lfht_node *lookup;
960 int flagged = 0;
961
962 if (!node) /* Return -ENOENT if asked to delete NULL node */
963 goto end;
964
965 /* logically delete the node */
966 assert(!is_dummy(node));
967 assert(!is_removed(node));
968 old = rcu_dereference(node->p.next);
969 do {
970 struct cds_lfht_node *new_next;
971
972 next = old;
973 if (unlikely(is_removed(next)))
974 goto end;
975 if (dummy_removal)
976 assert(is_dummy(next));
977 else
978 assert(!is_dummy(next));
979 new_next = flag_removed(next);
980 old = uatomic_cmpxchg(&node->p.next, next, new_next);
981 } while (old != next);
982
983 /* We performed the (logical) deletion. */
984 flagged = 1;
985
986 /*
987 * Ensure that the node is not visible to readers anymore: lookup for
988 * the node, and remove it (along with any other logically removed node)
989 * if found.
990 */
991 lookup = lookup_bucket(ht, size, bit_reverse_ulong(node->p.reverse_hash));
992 dummy = (struct cds_lfht_node *) lookup;
993 _cds_lfht_gc_bucket(dummy, node);
994 end:
995 /*
996 * Only the flagging action indicated that we (and no other)
997 * removed the node from the hash.
998 */
999 if (flagged) {
1000 assert(is_removed(rcu_dereference(node->p.next)));
1001 return 0;
1002 } else {
1003 return -ENOENT;
1004 }
1005 }
1006
1007 static
1008 void *partition_resize_thread(void *arg)
1009 {
1010 struct partition_resize_work *work = arg;
1011
1012 work->ht->cds_lfht_rcu_register_thread();
1013 work->fct(work->ht, work->i, work->start, work->len);
1014 work->ht->cds_lfht_rcu_unregister_thread();
1015 return NULL;
1016 }
1017
1018 static
1019 void partition_resize_helper(struct cds_lfht *ht, unsigned long i,
1020 unsigned long len,
1021 void (*fct)(struct cds_lfht *ht, unsigned long i,
1022 unsigned long start, unsigned long len))
1023 {
1024 unsigned long partition_len;
1025 struct partition_resize_work *work;
1026 int thread, ret;
1027 unsigned long nr_threads;
1028
1029 /*
1030 * Note: nr_cpus_mask + 1 is always power of 2.
1031 * We spawn just the number of threads we need to satisfy the minimum
1032 * partition size, up to the number of CPUs in the system.
1033 */
1034 if (nr_cpus_mask > 0) {
1035 nr_threads = min(nr_cpus_mask + 1,
1036 len >> MIN_PARTITION_PER_THREAD_ORDER);
1037 } else {
1038 nr_threads = 1;
1039 }
1040 partition_len = len >> get_count_order_ulong(nr_threads);
1041 work = calloc(nr_threads, sizeof(*work));
1042 assert(work);
1043 for (thread = 0; thread < nr_threads; thread++) {
1044 work[thread].ht = ht;
1045 work[thread].i = i;
1046 work[thread].len = partition_len;
1047 work[thread].start = thread * partition_len;
1048 work[thread].fct = fct;
1049 ret = pthread_create(&(work[thread].thread_id), ht->resize_attr,
1050 partition_resize_thread, &work[thread]);
1051 assert(!ret);
1052 }
1053 for (thread = 0; thread < nr_threads; thread++) {
1054 ret = pthread_join(work[thread].thread_id, NULL);
1055 assert(!ret);
1056 }
1057 free(work);
1058 }
1059
1060 /*
1061 * Holding RCU read lock to protect _cds_lfht_add against memory
1062 * reclaim that could be performed by other call_rcu worker threads (ABA
1063 * problem).
1064 *
1065 * When we reach a certain length, we can split this population phase over
1066 * many worker threads, based on the number of CPUs available in the system.
1067 * This should therefore take care of not having the expand lagging behind too
1068 * many concurrent insertion threads by using the scheduler's ability to
1069 * schedule dummy node population fairly with insertions.
1070 */
1071 static
1072 void init_table_populate_partition(struct cds_lfht *ht, unsigned long i,
1073 unsigned long start, unsigned long len)
1074 {
1075 unsigned long j;
1076
1077 ht->cds_lfht_rcu_read_lock();
1078 for (j = start; j < start + len; j++) {
1079 struct cds_lfht_node *new_node =
1080 (struct cds_lfht_node *) &ht->t.tbl[i]->nodes[j];
1081
1082 dbg_printf("init populate: i %lu j %lu hash %lu\n",
1083 i, j, !i ? 0 : (1UL << (i - 1)) + j);
1084 new_node->p.reverse_hash =
1085 bit_reverse_ulong(!i ? 0 : (1UL << (i - 1)) + j);
1086 _cds_lfht_add(ht, !i ? 0 : (1UL << (i - 1)),
1087 new_node, NULL, 1);
1088 }
1089 ht->cds_lfht_rcu_read_unlock();
1090 }
1091
1092 static
1093 void init_table_populate(struct cds_lfht *ht, unsigned long i,
1094 unsigned long len)
1095 {
1096 assert(nr_cpus_mask != -1);
1097 if (nr_cpus_mask < 0 || len < 2 * MIN_PARTITION_PER_THREAD) {
1098 ht->cds_lfht_rcu_thread_online();
1099 init_table_populate_partition(ht, i, 0, len);
1100 ht->cds_lfht_rcu_thread_offline();
1101 return;
1102 }
1103 partition_resize_helper(ht, i, len, init_table_populate_partition);
1104 }
1105
1106 static
1107 void init_table(struct cds_lfht *ht,
1108 unsigned long first_order, unsigned long len_order)
1109 {
1110 unsigned long i, end_order;
1111
1112 dbg_printf("init table: first_order %lu end_order %lu\n",
1113 first_order, first_order + len_order);
1114 end_order = first_order + len_order;
1115 for (i = first_order; i < end_order; i++) {
1116 unsigned long len;
1117
1118 len = !i ? 1 : 1UL << (i - 1);
1119 dbg_printf("init order %lu len: %lu\n", i, len);
1120
1121 /* Stop expand if the resize target changes under us */
1122 if (CMM_LOAD_SHARED(ht->t.resize_target) < (!i ? 1 : (1UL << i)))
1123 break;
1124
1125 ht->t.tbl[i] = calloc(1, len * sizeof(struct _cds_lfht_node));
1126 assert(ht->t.tbl[i]);
1127
1128 /*
1129 * Set all dummy nodes reverse hash values for a level and
1130 * link all dummy nodes into the table.
1131 */
1132 init_table_populate(ht, i, len);
1133
1134 /*
1135 * Update table size.
1136 */
1137 cmm_smp_wmb(); /* populate data before RCU size */
1138 CMM_STORE_SHARED(ht->t.size, !i ? 1 : (1UL << i));
1139
1140 dbg_printf("init new size: %lu\n", !i ? 1 : (1UL << i));
1141 if (CMM_LOAD_SHARED(ht->in_progress_destroy))
1142 break;
1143 }
1144 }
1145
1146 /*
1147 * Holding RCU read lock to protect _cds_lfht_remove against memory
1148 * reclaim that could be performed by other call_rcu worker threads (ABA
1149 * problem).
1150 * For a single level, we logically remove and garbage collect each node.
1151 *
1152 * As a design choice, we perform logical removal and garbage collection on a
1153 * node-per-node basis to simplify this algorithm. We also assume keeping good
1154 * cache locality of the operation would overweight possible performance gain
1155 * that could be achieved by batching garbage collection for multiple levels.
1156 * However, this would have to be justified by benchmarks.
1157 *
1158 * Concurrent removal and add operations are helping us perform garbage
1159 * collection of logically removed nodes. We guarantee that all logically
1160 * removed nodes have been garbage-collected (unlinked) before call_rcu is
1161 * invoked to free a hole level of dummy nodes (after a grace period).
1162 *
1163 * Logical removal and garbage collection can therefore be done in batch or on a
1164 * node-per-node basis, as long as the guarantee above holds.
1165 *
1166 * When we reach a certain length, we can split this removal over many worker
1167 * threads, based on the number of CPUs available in the system. This should
1168 * take care of not letting resize process lag behind too many concurrent
1169 * updater threads actively inserting into the hash table.
1170 */
1171 static
1172 void remove_table_partition(struct cds_lfht *ht, unsigned long i,
1173 unsigned long start, unsigned long len)
1174 {
1175 unsigned long j;
1176
1177 ht->cds_lfht_rcu_read_lock();
1178 for (j = start; j < start + len; j++) {
1179 struct cds_lfht_node *fini_node =
1180 (struct cds_lfht_node *) &ht->t.tbl[i]->nodes[j];
1181
1182 dbg_printf("remove entry: i %lu j %lu hash %lu\n",
1183 i, j, !i ? 0 : (1UL << (i - 1)) + j);
1184 fini_node->p.reverse_hash =
1185 bit_reverse_ulong(!i ? 0 : (1UL << (i - 1)) + j);
1186 (void) _cds_lfht_del(ht, !i ? 0 : (1UL << (i - 1)),
1187 fini_node, 1);
1188 }
1189 ht->cds_lfht_rcu_read_unlock();
1190 }
1191
1192 static
1193 void remove_table(struct cds_lfht *ht, unsigned long i, unsigned long len)
1194 {
1195
1196 assert(nr_cpus_mask != -1);
1197 if (nr_cpus_mask < 0 || len < 2 * MIN_PARTITION_PER_THREAD) {
1198 ht->cds_lfht_rcu_thread_online();
1199 remove_table_partition(ht, i, 0, len);
1200 ht->cds_lfht_rcu_thread_offline();
1201 return;
1202 }
1203 partition_resize_helper(ht, i, len, remove_table_partition);
1204 }
1205
1206 static
1207 void fini_table(struct cds_lfht *ht,
1208 unsigned long first_order, unsigned long len_order)
1209 {
1210 long i, end_order;
1211 void *free_by_rcu = NULL;
1212
1213 dbg_printf("fini table: first_order %lu end_order %lu\n",
1214 first_order, first_order + len_order);
1215 end_order = first_order + len_order;
1216 assert(first_order > 0);
1217 for (i = end_order - 1; i >= first_order; i--) {
1218 unsigned long len;
1219
1220 len = !i ? 1 : 1UL << (i - 1);
1221 dbg_printf("fini order %lu len: %lu\n", i, len);
1222
1223 /* Stop shrink if the resize target changes under us */
1224 if (CMM_LOAD_SHARED(ht->t.resize_target) > (1UL << (i - 1)))
1225 break;
1226
1227 cmm_smp_wmb(); /* populate data before RCU size */
1228 CMM_STORE_SHARED(ht->t.size, 1UL << (i - 1));
1229
1230 /*
1231 * We need to wait for all add operations to reach Q.S. (and
1232 * thus use the new table for lookups) before we can start
1233 * releasing the old dummy nodes. Otherwise their lookup will
1234 * return a logically removed node as insert position.
1235 */
1236 ht->cds_lfht_synchronize_rcu();
1237 if (free_by_rcu)
1238 free(free_by_rcu);
1239
1240 /*
1241 * Set "removed" flag in dummy nodes about to be removed.
1242 * Unlink all now-logically-removed dummy node pointers.
1243 * Concurrent add/remove operation are helping us doing
1244 * the gc.
1245 */
1246 remove_table(ht, i, len);
1247
1248 free_by_rcu = ht->t.tbl[i];
1249
1250 dbg_printf("fini new size: %lu\n", 1UL << i);
1251 if (CMM_LOAD_SHARED(ht->in_progress_destroy))
1252 break;
1253 }
1254
1255 if (free_by_rcu) {
1256 ht->cds_lfht_synchronize_rcu();
1257 free(free_by_rcu);
1258 }
1259 }
1260
1261 struct cds_lfht *_cds_lfht_new(cds_lfht_hash_fct hash_fct,
1262 cds_lfht_compare_fct compare_fct,
1263 unsigned long hash_seed,
1264 unsigned long init_size,
1265 int flags,
1266 void (*cds_lfht_call_rcu)(struct rcu_head *head,
1267 void (*func)(struct rcu_head *head)),
1268 void (*cds_lfht_synchronize_rcu)(void),
1269 void (*cds_lfht_rcu_read_lock)(void),
1270 void (*cds_lfht_rcu_read_unlock)(void),
1271 void (*cds_lfht_rcu_thread_offline)(void),
1272 void (*cds_lfht_rcu_thread_online)(void),
1273 void (*cds_lfht_rcu_register_thread)(void),
1274 void (*cds_lfht_rcu_unregister_thread)(void),
1275 pthread_attr_t *attr)
1276 {
1277 struct cds_lfht *ht;
1278 unsigned long order;
1279
1280 /* init_size must be power of two */
1281 if (init_size && (init_size & (init_size - 1)))
1282 return NULL;
1283 ht = calloc(1, sizeof(struct cds_lfht));
1284 assert(ht);
1285 ht->hash_fct = hash_fct;
1286 ht->compare_fct = compare_fct;
1287 ht->hash_seed = hash_seed;
1288 ht->cds_lfht_call_rcu = cds_lfht_call_rcu;
1289 ht->cds_lfht_synchronize_rcu = cds_lfht_synchronize_rcu;
1290 ht->cds_lfht_rcu_read_lock = cds_lfht_rcu_read_lock;
1291 ht->cds_lfht_rcu_read_unlock = cds_lfht_rcu_read_unlock;
1292 ht->cds_lfht_rcu_thread_offline = cds_lfht_rcu_thread_offline;
1293 ht->cds_lfht_rcu_thread_online = cds_lfht_rcu_thread_online;
1294 ht->cds_lfht_rcu_register_thread = cds_lfht_rcu_register_thread;
1295 ht->cds_lfht_rcu_unregister_thread = cds_lfht_rcu_unregister_thread;
1296 ht->resize_attr = attr;
1297 ht->percpu_count = alloc_per_cpu_items_count();
1298 /* this mutex should not nest in read-side C.S. */
1299 pthread_mutex_init(&ht->resize_mutex, NULL);
1300 order = get_count_order_ulong(max(init_size, MIN_TABLE_SIZE)) + 1;
1301 ht->flags = flags;
1302 ht->cds_lfht_rcu_thread_offline();
1303 pthread_mutex_lock(&ht->resize_mutex);
1304 ht->t.resize_target = 1UL << (order - 1);
1305 init_table(ht, 0, order);
1306 pthread_mutex_unlock(&ht->resize_mutex);
1307 ht->cds_lfht_rcu_thread_online();
1308 return ht;
1309 }
1310
1311 void cds_lfht_lookup(struct cds_lfht *ht, void *key, size_t key_len,
1312 struct cds_lfht_iter *iter)
1313 {
1314 struct cds_lfht_node *node, *next, *dummy_node;
1315 struct _cds_lfht_node *lookup;
1316 unsigned long hash, reverse_hash, size;
1317
1318 hash = ht->hash_fct(key, key_len, ht->hash_seed);
1319 reverse_hash = bit_reverse_ulong(hash);
1320
1321 size = rcu_dereference(ht->t.size);
1322 lookup = lookup_bucket(ht, size, hash);
1323 dummy_node = (struct cds_lfht_node *) lookup;
1324 /* We can always skip the dummy node initially */
1325 node = rcu_dereference(dummy_node->p.next);
1326 node = clear_flag(node);
1327 for (;;) {
1328 if (unlikely(is_end(node))) {
1329 node = next = NULL;
1330 break;
1331 }
1332 if (unlikely(node->p.reverse_hash > reverse_hash)) {
1333 node = next = NULL;
1334 break;
1335 }
1336 next = rcu_dereference(node->p.next);
1337 if (likely(!is_removed(next))
1338 && !is_dummy(next)
1339 && clear_flag(node)->p.reverse_hash == reverse_hash
1340 && likely(!ht->compare_fct(node->key, node->key_len, key, key_len))) {
1341 break;
1342 }
1343 node = clear_flag(next);
1344 }
1345 assert(!node || !is_dummy(rcu_dereference(node->p.next)));
1346 iter->node = node;
1347 iter->next = next;
1348 }
1349
1350 void cds_lfht_next_duplicate(struct cds_lfht *ht, struct cds_lfht_iter *iter)
1351 {
1352 struct cds_lfht_node *node, *next;
1353 unsigned long reverse_hash;
1354 void *key;
1355 size_t key_len;
1356
1357 node = iter->node;
1358 reverse_hash = node->p.reverse_hash;
1359 key = node->key;
1360 key_len = node->key_len;
1361 next = iter->next;
1362 node = clear_flag(next);
1363
1364 for (;;) {
1365 if (unlikely(is_end(node))) {
1366 node = next = NULL;
1367 break;
1368 }
1369 if (unlikely(node->p.reverse_hash > reverse_hash)) {
1370 node = next = NULL;
1371 break;
1372 }
1373 next = rcu_dereference(node->p.next);
1374 if (likely(!is_removed(next))
1375 && !is_dummy(next)
1376 && likely(!ht->compare_fct(node->key, node->key_len, key, key_len))) {
1377 break;
1378 }
1379 node = clear_flag(next);
1380 }
1381 assert(!node || !is_dummy(rcu_dereference(node->p.next)));
1382 iter->node = node;
1383 iter->next = next;
1384 }
1385
1386 void cds_lfht_next(struct cds_lfht *ht, struct cds_lfht_iter *iter)
1387 {
1388 struct cds_lfht_node *node, *next;
1389
1390 node = clear_flag(iter->next);
1391 for (;;) {
1392 if (unlikely(is_end(node))) {
1393 node = next = NULL;
1394 break;
1395 }
1396 next = rcu_dereference(node->p.next);
1397 if (likely(!is_removed(next))
1398 && !is_dummy(next)) {
1399 break;
1400 }
1401 node = clear_flag(next);
1402 }
1403 assert(!node || !is_dummy(rcu_dereference(node->p.next)));
1404 iter->node = node;
1405 iter->next = next;
1406 }
1407
1408 void cds_lfht_first(struct cds_lfht *ht, struct cds_lfht_iter *iter)
1409 {
1410 struct _cds_lfht_node *lookup;
1411
1412 /*
1413 * Get next after first dummy node. The first dummy node is the
1414 * first node of the linked list.
1415 */
1416 lookup = &ht->t.tbl[0]->nodes[0];
1417 iter->next = lookup->next;
1418 cds_lfht_next(ht, iter);
1419 }
1420
1421 void cds_lfht_add(struct cds_lfht *ht, struct cds_lfht_node *node)
1422 {
1423 unsigned long hash, size;
1424
1425 hash = ht->hash_fct(node->key, node->key_len, ht->hash_seed);
1426 node->p.reverse_hash = bit_reverse_ulong((unsigned long) hash);
1427
1428 size = rcu_dereference(ht->t.size);
1429 _cds_lfht_add(ht, size, node, NULL, 0);
1430 ht_count_add(ht, size);
1431 }
1432
1433 struct cds_lfht_node *cds_lfht_add_unique(struct cds_lfht *ht,
1434 struct cds_lfht_node *node)
1435 {
1436 unsigned long hash, size;
1437 struct cds_lfht_iter iter;
1438
1439 hash = ht->hash_fct(node->key, node->key_len, ht->hash_seed);
1440 node->p.reverse_hash = bit_reverse_ulong((unsigned long) hash);
1441
1442 size = rcu_dereference(ht->t.size);
1443 _cds_lfht_add(ht, size, node, &iter, 0);
1444 if (iter.node == node)
1445 ht_count_add(ht, size);
1446 return iter.node;
1447 }
1448
1449 struct cds_lfht_node *cds_lfht_add_replace(struct cds_lfht *ht,
1450 struct cds_lfht_node *node)
1451 {
1452 unsigned long hash, size;
1453 struct cds_lfht_iter iter;
1454
1455 hash = ht->hash_fct(node->key, node->key_len, ht->hash_seed);
1456 node->p.reverse_hash = bit_reverse_ulong((unsigned long) hash);
1457
1458 size = rcu_dereference(ht->t.size);
1459 for (;;) {
1460 _cds_lfht_add(ht, size, node, &iter, 0);
1461 if (iter.node == node) {
1462 ht_count_add(ht, size);
1463 return NULL;
1464 }
1465
1466 if (!_cds_lfht_replace(ht, size, iter.node, iter.next, node))
1467 return iter.node;
1468 }
1469 }
1470
1471 int cds_lfht_replace(struct cds_lfht *ht, struct cds_lfht_iter *old_iter,
1472 struct cds_lfht_node *new_node)
1473 {
1474 unsigned long size;
1475
1476 size = rcu_dereference(ht->t.size);
1477 return _cds_lfht_replace(ht, size, old_iter->node, old_iter->next,
1478 new_node);
1479 }
1480
1481 int cds_lfht_del(struct cds_lfht *ht, struct cds_lfht_iter *iter)
1482 {
1483 unsigned long size;
1484 int ret;
1485
1486 size = rcu_dereference(ht->t.size);
1487 ret = _cds_lfht_del(ht, size, iter->node, 0);
1488 if (!ret)
1489 ht_count_del(ht, size);
1490 return ret;
1491 }
1492
1493 static
1494 int cds_lfht_delete_dummy(struct cds_lfht *ht)
1495 {
1496 struct cds_lfht_node *node;
1497 struct _cds_lfht_node *lookup;
1498 unsigned long order, i, size;
1499
1500 /* Check that the table is empty */
1501 lookup = &ht->t.tbl[0]->nodes[0];
1502 node = (struct cds_lfht_node *) lookup;
1503 do {
1504 node = clear_flag(node)->p.next;
1505 if (!is_dummy(node))
1506 return -EPERM;
1507 assert(!is_removed(node));
1508 } while (!is_end(node));
1509 /*
1510 * size accessed without rcu_dereference because hash table is
1511 * being destroyed.
1512 */
1513 size = ht->t.size;
1514 /* Internal sanity check: all nodes left should be dummy */
1515 for (order = 0; order < get_count_order_ulong(size) + 1; order++) {
1516 unsigned long len;
1517
1518 len = !order ? 1 : 1UL << (order - 1);
1519 for (i = 0; i < len; i++) {
1520 dbg_printf("delete order %lu i %lu hash %lu\n",
1521 order, i,
1522 bit_reverse_ulong(ht->t.tbl[order]->nodes[i].reverse_hash));
1523 assert(is_dummy(ht->t.tbl[order]->nodes[i].next));
1524 }
1525 poison_free(ht->t.tbl[order]);
1526 }
1527 return 0;
1528 }
1529
1530 /*
1531 * Should only be called when no more concurrent readers nor writers can
1532 * possibly access the table.
1533 */
1534 int cds_lfht_destroy(struct cds_lfht *ht, pthread_attr_t **attr)
1535 {
1536 int ret;
1537
1538 /* Wait for in-flight resize operations to complete */
1539 _CMM_STORE_SHARED(ht->in_progress_destroy, 1);
1540 cmm_smp_mb(); /* Store destroy before load resize */
1541 while (uatomic_read(&ht->in_progress_resize))
1542 poll(NULL, 0, 100); /* wait for 100ms */
1543 ret = cds_lfht_delete_dummy(ht);
1544 if (ret)
1545 return ret;
1546 free_per_cpu_items_count(ht->percpu_count);
1547 if (attr)
1548 *attr = ht->resize_attr;
1549 poison_free(ht);
1550 return ret;
1551 }
1552
1553 void cds_lfht_count_nodes(struct cds_lfht *ht,
1554 long *approx_before,
1555 unsigned long *count,
1556 unsigned long *removed,
1557 long *approx_after)
1558 {
1559 struct cds_lfht_node *node, *next;
1560 struct _cds_lfht_node *lookup;
1561 unsigned long nr_dummy = 0;
1562
1563 *approx_before = 0;
1564 if (nr_cpus_mask >= 0) {
1565 int i;
1566
1567 for (i = 0; i < nr_cpus_mask + 1; i++) {
1568 *approx_before += uatomic_read(&ht->percpu_count[i].add);
1569 *approx_before -= uatomic_read(&ht->percpu_count[i].del);
1570 }
1571 }
1572
1573 *count = 0;
1574 *removed = 0;
1575
1576 /* Count non-dummy nodes in the table */
1577 lookup = &ht->t.tbl[0]->nodes[0];
1578 node = (struct cds_lfht_node *) lookup;
1579 do {
1580 next = rcu_dereference(node->p.next);
1581 if (is_removed(next)) {
1582 if (!is_dummy(next))
1583 (*removed)++;
1584 else
1585 (nr_dummy)++;
1586 } else if (!is_dummy(next))
1587 (*count)++;
1588 else
1589 (nr_dummy)++;
1590 node = clear_flag(next);
1591 } while (!is_end(node));
1592 dbg_printf("number of dummy nodes: %lu\n", nr_dummy);
1593 *approx_after = 0;
1594 if (nr_cpus_mask >= 0) {
1595 int i;
1596
1597 for (i = 0; i < nr_cpus_mask + 1; i++) {
1598 *approx_after += uatomic_read(&ht->percpu_count[i].add);
1599 *approx_after -= uatomic_read(&ht->percpu_count[i].del);
1600 }
1601 }
1602 }
1603
1604 /* called with resize mutex held */
1605 static
1606 void _do_cds_lfht_grow(struct cds_lfht *ht,
1607 unsigned long old_size, unsigned long new_size)
1608 {
1609 unsigned long old_order, new_order;
1610
1611 old_order = get_count_order_ulong(old_size) + 1;
1612 new_order = get_count_order_ulong(new_size) + 1;
1613 dbg_printf("resize from %lu (order %lu) to %lu (order %lu) buckets\n",
1614 old_size, old_order, new_size, new_order);
1615 assert(new_size > old_size);
1616 init_table(ht, old_order, new_order - old_order);
1617 }
1618
1619 /* called with resize mutex held */
1620 static
1621 void _do_cds_lfht_shrink(struct cds_lfht *ht,
1622 unsigned long old_size, unsigned long new_size)
1623 {
1624 unsigned long old_order, new_order;
1625
1626 new_size = max(new_size, MIN_TABLE_SIZE);
1627 old_order = get_count_order_ulong(old_size) + 1;
1628 new_order = get_count_order_ulong(new_size) + 1;
1629 dbg_printf("resize from %lu (order %lu) to %lu (order %lu) buckets\n",
1630 old_size, old_order, new_size, new_order);
1631 assert(new_size < old_size);
1632
1633 /* Remove and unlink all dummy nodes to remove. */
1634 fini_table(ht, new_order, old_order - new_order);
1635 }
1636
1637
1638 /* called with resize mutex held */
1639 static
1640 void _do_cds_lfht_resize(struct cds_lfht *ht)
1641 {
1642 unsigned long new_size, old_size;
1643
1644 /*
1645 * Resize table, re-do if the target size has changed under us.
1646 */
1647 do {
1648 assert(uatomic_read(&ht->in_progress_resize));
1649 if (CMM_LOAD_SHARED(ht->in_progress_destroy))
1650 break;
1651 ht->t.resize_initiated = 1;
1652 old_size = ht->t.size;
1653 new_size = CMM_LOAD_SHARED(ht->t.resize_target);
1654 if (old_size < new_size)
1655 _do_cds_lfht_grow(ht, old_size, new_size);
1656 else if (old_size > new_size)
1657 _do_cds_lfht_shrink(ht, old_size, new_size);
1658 ht->t.resize_initiated = 0;
1659 /* write resize_initiated before read resize_target */
1660 cmm_smp_mb();
1661 } while (ht->t.size != CMM_LOAD_SHARED(ht->t.resize_target));
1662 }
1663
1664 static
1665 unsigned long resize_target_update(struct cds_lfht *ht, unsigned long size,
1666 int growth_order)
1667 {
1668 return _uatomic_max(&ht->t.resize_target,
1669 size << growth_order);
1670 }
1671
1672 static
1673 void resize_target_update_count(struct cds_lfht *ht,
1674 unsigned long count)
1675 {
1676 count = max(count, MIN_TABLE_SIZE);
1677 uatomic_set(&ht->t.resize_target, count);
1678 }
1679
1680 void cds_lfht_resize(struct cds_lfht *ht, unsigned long new_size)
1681 {
1682 resize_target_update_count(ht, new_size);
1683 CMM_STORE_SHARED(ht->t.resize_initiated, 1);
1684 ht->cds_lfht_rcu_thread_offline();
1685 pthread_mutex_lock(&ht->resize_mutex);
1686 _do_cds_lfht_resize(ht);
1687 pthread_mutex_unlock(&ht->resize_mutex);
1688 ht->cds_lfht_rcu_thread_online();
1689 }
1690
1691 static
1692 void do_resize_cb(struct rcu_head *head)
1693 {
1694 struct rcu_resize_work *work =
1695 caa_container_of(head, struct rcu_resize_work, head);
1696 struct cds_lfht *ht = work->ht;
1697
1698 ht->cds_lfht_rcu_thread_offline();
1699 pthread_mutex_lock(&ht->resize_mutex);
1700 _do_cds_lfht_resize(ht);
1701 pthread_mutex_unlock(&ht->resize_mutex);
1702 ht->cds_lfht_rcu_thread_online();
1703 poison_free(work);
1704 cmm_smp_mb(); /* finish resize before decrement */
1705 uatomic_dec(&ht->in_progress_resize);
1706 }
1707
1708 static
1709 void cds_lfht_resize_lazy(struct cds_lfht *ht, unsigned long size, int growth)
1710 {
1711 struct rcu_resize_work *work;
1712 unsigned long target_size;
1713
1714 target_size = resize_target_update(ht, size, growth);
1715 /* Store resize_target before read resize_initiated */
1716 cmm_smp_mb();
1717 if (!CMM_LOAD_SHARED(ht->t.resize_initiated) && size < target_size) {
1718 uatomic_inc(&ht->in_progress_resize);
1719 cmm_smp_mb(); /* increment resize count before load destroy */
1720 if (CMM_LOAD_SHARED(ht->in_progress_destroy)) {
1721 uatomic_dec(&ht->in_progress_resize);
1722 return;
1723 }
1724 work = malloc(sizeof(*work));
1725 work->ht = ht;
1726 ht->cds_lfht_call_rcu(&work->head, do_resize_cb);
1727 CMM_STORE_SHARED(ht->t.resize_initiated, 1);
1728 }
1729 }
1730
1731 #if defined(HAVE_SCHED_GETCPU) && defined(HAVE_SYSCONF)
1732
1733 static
1734 void cds_lfht_resize_lazy_count(struct cds_lfht *ht, unsigned long size,
1735 unsigned long count)
1736 {
1737 struct rcu_resize_work *work;
1738
1739 if (!(ht->flags & CDS_LFHT_AUTO_RESIZE))
1740 return;
1741 resize_target_update_count(ht, count);
1742 /* Store resize_target before read resize_initiated */
1743 cmm_smp_mb();
1744 if (!CMM_LOAD_SHARED(ht->t.resize_initiated)) {
1745 uatomic_inc(&ht->in_progress_resize);
1746 cmm_smp_mb(); /* increment resize count before load destroy */
1747 if (CMM_LOAD_SHARED(ht->in_progress_destroy)) {
1748 uatomic_dec(&ht->in_progress_resize);
1749 return;
1750 }
1751 work = malloc(sizeof(*work));
1752 work->ht = ht;
1753 ht->cds_lfht_call_rcu(&work->head, do_resize_cb);
1754 CMM_STORE_SHARED(ht->t.resize_initiated, 1);
1755 }
1756 }
1757
1758 #endif
This page took 0.066145 seconds and 5 git commands to generate.