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