4 * Userspace RCU library - test program
6 * Copyright 2009-2012 - Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program 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
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 #include "test_urcu_hash.h"
32 void (*sigusr1
)(int signo
);
33 void (*sigusr2
)(int signo
);
34 void *(*thr_reader
)(void *_count
);
35 void *(*thr_writer
)(void *_count
);
36 int (*populate_hash
)(void);
40 struct test_hash_cb test_hash_cb
[] = {
42 test_hash_rw_sigusr1_handler
,
43 test_hash_rw_sigusr2_handler
,
44 test_hash_rw_thr_reader
,
45 test_hash_rw_thr_writer
,
46 test_hash_rw_populate_hash
,
48 [TEST_HASH_UNIQUE
] = {
49 test_hash_unique_sigusr1_handler
,
50 test_hash_unique_sigusr2_handler
,
51 test_hash_unique_thr_reader
,
52 test_hash_unique_thr_writer
,
53 test_hash_unique_populate_hash
,
58 static enum test_hash test_choice
= TEST_HASH_RW
;
60 void (*get_sigusr1_cb(void))(int)
62 return test_hash_cb
[test_choice
].sigusr1
;
65 void (*get_sigusr2_cb(void))(int)
67 return test_hash_cb
[test_choice
].sigusr2
;
70 void *(*get_thr_reader_cb(void))(void *)
72 return test_hash_cb
[test_choice
].thr_reader
;
75 void *(*get_thr_writer_cb(void))(void *)
77 return test_hash_cb
[test_choice
].thr_writer
;
80 int (*get_populate_hash_cb(void))(void)
82 return test_hash_cb
[test_choice
].populate_hash
;
85 DEFINE_URCU_TLS(unsigned int, rand_lookup
);
86 DEFINE_URCU_TLS(unsigned long, nr_add
);
87 DEFINE_URCU_TLS(unsigned long, nr_addexist
);
88 DEFINE_URCU_TLS(unsigned long, nr_del
);
89 DEFINE_URCU_TLS(unsigned long, nr_delnoent
);
90 DEFINE_URCU_TLS(unsigned long, lookup_fail
);
91 DEFINE_URCU_TLS(unsigned long, lookup_ok
);
93 struct cds_lfht
*test_ht
;
95 volatile int test_go
, test_stop
;
99 unsigned long duration
;
101 /* read-side C.S. duration, in loops */
102 unsigned long rduration
;
104 unsigned long init_hash_size
= DEFAULT_HASH_SIZE
;
105 unsigned long min_hash_alloc_size
= DEFAULT_MIN_ALLOC_SIZE
;
106 unsigned long max_hash_buckets_size
= (1UL << 20);
107 unsigned long init_populate
;
109 int add_only
, add_unique
, add_replace
;
110 const struct cds_lfht_mm_type
*memory_backend
;
112 unsigned long init_pool_offset
, lookup_pool_offset
, write_pool_offset
;
113 unsigned long init_pool_size
= DEFAULT_RAND_POOL
,
114 lookup_pool_size
= DEFAULT_RAND_POOL
,
115 write_pool_size
= DEFAULT_RAND_POOL
;
117 unsigned long nr_hash_chains
; /* 0: normal table, other: number of hash chains */
123 unsigned int cpu_affinities
[NR_CPUS
];
124 unsigned int next_aff
= 0;
125 int use_affinity
= 0;
127 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
129 DEFINE_URCU_TLS(unsigned long long, nr_writes
);
130 DEFINE_URCU_TLS(unsigned long long, nr_reads
);
132 unsigned int nr_readers
;
133 unsigned int nr_writers
;
135 static pthread_mutex_t rcu_copy_mutex
= PTHREAD_MUTEX_INITIALIZER
;
137 void set_affinity(void)
139 #if HAVE_SCHED_SETAFFINITY
142 #endif /* HAVE_SCHED_SETAFFINITY */
147 #if HAVE_SCHED_SETAFFINITY
148 ret
= pthread_mutex_lock(&affinity_mutex
);
150 perror("Error in pthread mutex lock");
153 cpu
= cpu_affinities
[next_aff
++];
154 ret
= pthread_mutex_unlock(&affinity_mutex
);
156 perror("Error in pthread mutex unlock");
161 #if SCHED_SETAFFINITY_ARGS == 2
162 sched_setaffinity(0, &mask
);
164 sched_setaffinity(0, sizeof(mask
), &mask
);
166 #endif /* HAVE_SCHED_SETAFFINITY */
169 void rcu_copy_mutex_lock(void)
172 ret
= pthread_mutex_lock(&rcu_copy_mutex
);
174 perror("Error in pthread mutex lock");
179 void rcu_copy_mutex_unlock(void)
183 ret
= pthread_mutex_unlock(&rcu_copy_mutex
);
185 perror("Error in pthread mutex unlock");
190 unsigned long test_compare(const void *key1
, size_t key1_len
,
191 const void *key2
, size_t key2_len
)
193 if (caa_unlikely(key1_len
!= key2_len
))
195 assert(key1_len
== sizeof(unsigned long));
202 void *thr_count(void *arg
)
204 printf_verbose("thread_begin %s, tid %lu\n",
205 "counter", urcu_get_thread_id());
207 rcu_register_thread();
211 long approx_before
, approx_after
;
215 rcu_thread_offline();
216 len
= read(count_pipe
[0], buf
, 1);
218 if (caa_unlikely(!test_duration_read()))
223 printf("Counting nodes... ");
226 cds_lfht_count_nodes(test_ht
, &approx_before
, &count
,
230 printf("Approximation before node accounting: %ld nodes.\n",
232 printf("Accounting of nodes in the hash table: "
235 printf("Approximation after node accounting: %ld nodes.\n",
238 rcu_unregister_thread();
242 void free_node_cb(struct rcu_head
*head
)
244 struct lfht_test_node
*node
=
245 caa_container_of(head
, struct lfht_test_node
, head
);
250 void test_delete_all_nodes(struct cds_lfht
*ht
)
252 struct cds_lfht_iter iter
;
253 struct lfht_test_node
*node
;
254 unsigned long count
= 0;
256 cds_lfht_for_each_entry(ht
, &iter
, node
, node
) {
259 ret
= cds_lfht_del(test_ht
, cds_lfht_iter_get_node(&iter
));
261 call_rcu(&node
->head
, free_node_cb
);
264 printf("deleted %lu nodes.\n", count
);
267 void show_usage(int argc
, char **argv
)
269 printf("Usage : %s nr_readers nr_writers duration (s) <OPTIONS>\n",
271 printf("OPTIONS:\n");
272 printf(" [-r] [-w] (yield reader and/or writer)\n");
273 printf(" [-d delay] (writer period (us))\n");
274 printf(" [-c duration] (reader C.S. duration (in loops))\n");
275 printf(" [-v] (verbose output)\n");
276 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
277 printf(" [-h size] (initial number of buckets)\n");
278 printf(" [-m size] (minimum number of allocated buckets)\n");
279 printf(" [-n size] (maximum number of buckets)\n");
280 printf(" [not -u nor -s] Add entries (supports redundant keys).\n");
281 printf(" [-u] Uniquify add (no redundant keys).\n");
282 printf(" [-s] Replace (swap) entries.\n");
283 printf(" [-i] Add only (no removal).\n");
284 printf(" [-k nr_nodes] Number of nodes to insert initially.\n");
285 printf(" [-A] Automatically resize hash table.\n");
286 printf(" [-B order|chunk|mmap] Specify the memory backend.\n");
287 printf(" [-R offset] Lookup pool offset.\n");
288 printf(" [-S offset] Write pool offset.\n");
289 printf(" [-T offset] Init pool offset.\n");
290 printf(" [-M size] Lookup pool size.\n");
291 printf(" [-N size] Write pool size.\n");
292 printf(" [-O size] Init pool size.\n");
293 printf(" [-V] Validate lookups of init values.\n");
294 printf(" (use with filled init pool, same lookup range,\n");
295 printf(" with different write range)\n");
296 printf(" [-U] Uniqueness test.\n");
297 printf(" [-C] Number of hash chains.\n");
301 int main(int argc
, char **argv
)
303 pthread_t
*tid_reader
, *tid_writer
;
306 unsigned long long *count_reader
;
307 struct wr_count
*count_writer
;
308 unsigned long long tot_reads
= 0, tot_writes
= 0,
309 tot_add
= 0, tot_add_exist
= 0, tot_remove
= 0;
311 long approx_before
, approx_after
;
312 int i
, a
, ret
, err
, mainret
= 0;
313 struct sigaction act
;
315 unsigned int nr_readers_created
= 0, nr_writers_created
= 0;
319 show_usage(argc
, argv
);
324 err
= sscanf(argv
[1], "%u", &nr_readers
);
326 show_usage(argc
, argv
);
331 err
= sscanf(argv
[2], "%u", &nr_writers
);
333 show_usage(argc
, argv
);
338 err
= sscanf(argv
[3], "%lu", &duration
);
340 show_usage(argc
, argv
);
345 for (i
= 4; i
< argc
; i
++) {
346 if (argv
[i
][0] != '-')
348 switch (argv
[i
][1]) {
350 rcu_debug_yield_enable(RCU_YIELD_READ
);
353 rcu_debug_yield_enable(RCU_YIELD_WRITE
);
357 show_usage(argc
, argv
);
362 cpu_affinities
[next_aff
++] = a
;
364 printf_verbose("Adding CPU %d affinity\n", a
);
368 show_usage(argc
, argv
);
372 rduration
= atol(argv
[++i
]);
376 show_usage(argc
, argv
);
380 wdelay
= atol(argv
[++i
]);
387 show_usage(argc
, argv
);
391 init_hash_size
= atol(argv
[++i
]);
395 show_usage(argc
, argv
);
399 min_hash_alloc_size
= atol(argv
[++i
]);
403 show_usage(argc
, argv
);
407 max_hash_buckets_size
= atol(argv
[++i
]);
411 printf("Please specify at most one of -s or -u.\n");
418 printf("Please specify at most one of -s or -u.\n");
427 init_populate
= atol(argv
[++i
]);
434 show_usage(argc
, argv
);
439 if (!strcmp("order", argv
[i
]))
440 memory_backend
= &cds_lfht_mm_order
;
441 else if (!strcmp("chunk", argv
[i
]))
442 memory_backend
= &cds_lfht_mm_chunk
;
443 else if (!strcmp("mmap", argv
[i
]))
444 memory_backend
= &cds_lfht_mm_mmap
;
446 printf("Please specify memory backend with order|chunk|mmap.\n");
452 lookup_pool_offset
= atol(argv
[++i
]);
455 write_pool_offset
= atol(argv
[++i
]);
458 init_pool_offset
= atol(argv
[++i
]);
461 lookup_pool_size
= atol(argv
[++i
]);
464 write_pool_size
= atol(argv
[++i
]);
467 init_pool_size
= atol(argv
[++i
]);
473 test_choice
= TEST_HASH_UNIQUE
;
476 nr_hash_chains
= atol(argv
[++i
]);
481 /* Check if hash size is power of 2 */
482 if (init_hash_size
&& init_hash_size
& (init_hash_size
- 1)) {
483 printf("Error: Initial number of buckets (%lu) is not a power of 2.\n",
489 if (min_hash_alloc_size
&& min_hash_alloc_size
& (min_hash_alloc_size
- 1)) {
490 printf("Error: Minimum number of allocated buckets (%lu) is not a power of 2.\n",
491 min_hash_alloc_size
);
496 if (max_hash_buckets_size
&& max_hash_buckets_size
& (max_hash_buckets_size
- 1)) {
497 printf("Error: Maximum number of buckets (%lu) is not a power of 2.\n",
498 max_hash_buckets_size
);
503 memset(&act
, 0, sizeof(act
));
504 ret
= sigemptyset(&act
.sa_mask
);
506 perror("sigemptyset");
510 act
.sa_handler
= get_sigusr1_cb();
511 act
.sa_flags
= SA_RESTART
;
512 ret
= sigaction(SIGUSR1
, &act
, NULL
);
519 act
.sa_handler
= get_sigusr2_cb();
520 act
.sa_flags
= SA_RESTART
;
521 ret
= sigaction(SIGUSR2
, &act
, NULL
);
528 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
529 duration
, nr_readers
, nr_writers
);
530 printf_verbose("Writer delay : %lu loops.\n", wdelay
);
531 printf_verbose("Reader duration : %lu loops.\n", rduration
);
532 printf_verbose("Mode:%s%s.\n",
533 add_only
? " add only" : " add/remove",
534 add_unique
? " uniquify" : ( add_replace
? " replace" : " insert"));
535 printf_verbose("Initial number of buckets: %lu buckets.\n", init_hash_size
);
536 printf_verbose("Minimum number of allocated buckets: %lu buckets.\n", min_hash_alloc_size
);
537 printf_verbose("Maximum number of buckets: %lu buckets.\n", max_hash_buckets_size
);
538 printf_verbose("Init pool size offset %lu size %lu.\n",
539 init_pool_offset
, init_pool_size
);
540 printf_verbose("Lookup pool size offset %lu size %lu.\n",
541 lookup_pool_offset
, lookup_pool_size
);
542 printf_verbose("Update pool size offset %lu size %lu.\n",
543 write_pool_offset
, write_pool_size
);
544 printf_verbose("Number of hash chains: %lu.\n",
546 printf_verbose("thread %-6s, tid %lu\n",
547 "main", urcu_get_thread_id());
549 tid_reader
= calloc(nr_readers
, sizeof(*tid_reader
));
554 tid_writer
= calloc(nr_writers
, sizeof(*tid_writer
));
557 goto end_free_tid_reader
;
559 count_reader
= calloc(nr_readers
, sizeof(*count_reader
));
562 goto end_free_tid_writer
;
564 count_writer
= calloc(nr_writers
, sizeof(*count_writer
));
567 goto end_free_count_reader
;
570 err
= create_all_cpu_call_rcu_data(0);
572 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
575 if (memory_backend
) {
576 test_ht
= _cds_lfht_new(init_hash_size
, min_hash_alloc_size
,
577 max_hash_buckets_size
,
578 (opt_auto_resize
? CDS_LFHT_AUTO_RESIZE
: 0) |
579 CDS_LFHT_ACCOUNTING
, memory_backend
,
582 test_ht
= cds_lfht_new(init_hash_size
, min_hash_alloc_size
,
583 max_hash_buckets_size
,
584 (opt_auto_resize
? CDS_LFHT_AUTO_RESIZE
: 0) |
585 CDS_LFHT_ACCOUNTING
, NULL
);
588 printf("Error allocating hash table.\n");
590 goto end_free_call_rcu_data
;
594 * Hash Population needs to be seen as a RCU reader
595 * thread from the point of view of resize.
597 rcu_register_thread();
598 ret
= (get_populate_hash_cb())();
601 rcu_thread_offline();
605 ret
= pipe(count_pipe
);
612 /* spawn counter thread */
613 err
= pthread_create(&tid_count
, NULL
, thr_count
,
618 perror("pthread_create");
622 for (i
= 0; i
< nr_readers
; i
++) {
623 err
= pthread_create(&tid_reader
[i
],
624 NULL
, get_thr_reader_cb(),
629 perror("pthread_create");
630 goto end_pthread_join
;
632 nr_readers_created
++;
634 for (i
= 0; i
< nr_writers
; i
++) {
635 err
= pthread_create(&tid_writer
[i
],
636 NULL
, get_thr_writer_cb(),
641 perror("pthread_create");
642 goto end_pthread_join
;
644 nr_writers_created
++;
653 remain
= sleep(remain
);
654 } while (remain
> 0);
659 for (i
= 0; i
< nr_readers_created
; i
++) {
660 err
= pthread_join(tid_reader
[i
], &tret
);
664 perror("pthread_join");
666 tot_reads
+= count_reader
[i
];
668 for (i
= 0; i
< nr_writers_created
; i
++) {
669 err
= pthread_join(tid_writer
[i
], &tret
);
673 perror("pthread_join");
675 tot_writes
+= count_writer
[i
].update_ops
;
676 tot_add
+= count_writer
[i
].add
;
677 tot_add_exist
+= count_writer
[i
].add_exist
;
678 tot_remove
+= count_writer
[i
].remove
;
681 /* teardown counter thread */
682 act
.sa_handler
= SIG_IGN
;
683 act
.sa_flags
= SA_RESTART
;
684 ret
= sigaction(SIGUSR2
, &act
, NULL
);
690 char msg
[1] = { 0x42 };
694 ret
= write(count_pipe
[1], msg
, 1); /* wakeup thread */
695 } while (ret
== -1L && errno
== EINTR
);
697 err
= pthread_join(tid_count
, &tret
);
701 perror("pthread_join");
705 for (i
= 0; i
< 2; i
++) {
706 err
= close(count_pipe
[i
]);
709 perror("close pipe");
716 printf("Counting nodes... ");
717 cds_lfht_count_nodes(test_ht
, &approx_before
, &count
, &approx_after
);
719 test_delete_all_nodes(test_ht
);
721 rcu_thread_offline();
723 printf("Approximation before node accounting: %ld nodes.\n",
725 printf("Nodes deleted from hash table before destroy: "
728 printf("Approximation after node accounting: %ld nodes.\n",
732 ret
= cds_lfht_destroy(test_ht
, NULL
);
734 printf_verbose("final delete aborted\n");
737 printf_verbose("final delete success\n");
739 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads
,
741 nr_leaked
= (long long) tot_add
+ init_populate
- tot_remove
- count
;
742 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
744 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu "
745 "nr_add %12llu nr_add_fail %12llu nr_remove %12llu nr_leaked %12lld\n",
746 argv
[0], duration
, nr_readers
, rduration
,
747 nr_writers
, wdelay
, tot_reads
, tot_writes
,
748 tot_reads
+ tot_writes
, tot_add
, tot_add_exist
, tot_remove
,
750 if (nr_leaked
!= 0) {
752 printf("WARNING: %lld nodes were leaked!\n", nr_leaked
);
755 rcu_unregister_thread();
756 end_free_call_rcu_data
:
757 free_all_cpu_call_rcu_data();
759 end_free_count_reader
: