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 unsigned int __thread rand_lookup
;
86 unsigned long __thread nr_add
;
87 unsigned long __thread nr_addexist
;
88 unsigned long __thread nr_del
;
89 unsigned long __thread nr_delnoent
;
90 unsigned long __thread lookup_fail
;
91 unsigned long __thread 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
;
122 unsigned int cpu_affinities
[NR_CPUS
];
123 unsigned int next_aff
= 0;
124 int use_affinity
= 0;
126 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
128 unsigned long long __thread nr_writes
;
129 unsigned long long __thread nr_reads
;
131 unsigned int nr_readers
;
132 unsigned int nr_writers
;
134 static pthread_mutex_t rcu_copy_mutex
= PTHREAD_MUTEX_INITIALIZER
;
136 void set_affinity(void)
145 #if HAVE_SCHED_SETAFFINITY
146 ret
= pthread_mutex_lock(&affinity_mutex
);
148 perror("Error in pthread mutex lock");
151 cpu
= cpu_affinities
[next_aff
++];
152 ret
= pthread_mutex_unlock(&affinity_mutex
);
154 perror("Error in pthread mutex unlock");
159 #if SCHED_SETAFFINITY_ARGS == 2
160 sched_setaffinity(0, &mask
);
162 sched_setaffinity(0, sizeof(mask
), &mask
);
164 #endif /* HAVE_SCHED_SETAFFINITY */
167 void rcu_copy_mutex_lock(void)
170 ret
= pthread_mutex_lock(&rcu_copy_mutex
);
172 perror("Error in pthread mutex lock");
177 void rcu_copy_mutex_unlock(void)
181 ret
= pthread_mutex_unlock(&rcu_copy_mutex
);
183 perror("Error in pthread mutex unlock");
188 unsigned long test_compare(const void *key1
, size_t key1_len
,
189 const void *key2
, size_t key2_len
)
191 if (caa_unlikely(key1_len
!= key2_len
))
193 assert(key1_len
== sizeof(unsigned long));
200 void *thr_count(void *arg
)
202 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
203 "counter", pthread_self(), (unsigned long)gettid());
205 rcu_register_thread();
209 long approx_before
, approx_after
;
213 rcu_thread_offline();
214 len
= read(count_pipe
[0], buf
, 1);
216 if (caa_unlikely(!test_duration_read()))
221 printf("Counting nodes... ");
224 cds_lfht_count_nodes(test_ht
, &approx_before
, &count
,
228 printf("Approximation before node accounting: %ld nodes.\n",
230 printf("Accounting of nodes in the hash table: "
233 printf("Approximation after node accounting: %ld nodes.\n",
236 rcu_unregister_thread();
240 void free_node_cb(struct rcu_head
*head
)
242 struct lfht_test_node
*node
=
243 caa_container_of(head
, struct lfht_test_node
, head
);
248 void test_delete_all_nodes(struct cds_lfht
*ht
)
250 struct cds_lfht_iter iter
;
251 struct lfht_test_node
*node
;
252 unsigned long count
= 0;
254 cds_lfht_for_each_entry(ht
, &iter
, node
, node
) {
257 ret
= cds_lfht_del(test_ht
, cds_lfht_iter_get_node(&iter
));
259 call_rcu(&node
->head
, free_node_cb
);
262 printf("deleted %lu nodes.\n", count
);
265 void show_usage(int argc
, char **argv
)
267 printf("Usage : %s nr_readers nr_writers duration (s)\n", argv
[0]);
269 printf(" [-r] [-w] (yield reader and/or writer)\n");
271 printf(" [-d delay] (writer period (us))\n");
272 printf(" [-c duration] (reader C.S. duration (in loops))\n");
273 printf(" [-v] (verbose output)\n");
274 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
275 printf(" [-h size] (initial number of buckets)\n");
276 printf(" [-m size] (minimum number of allocated buckets)\n");
277 printf(" [-n size] (maximum number of buckets)\n");
278 printf(" [not -u nor -s] Add entries (supports redundant keys).\n");
279 printf(" [-u] Uniquify add (no redundant keys).\n");
280 printf(" [-s] Replace (swap) entries.\n");
281 printf(" [-i] Add only (no removal).\n");
282 printf(" [-k nr_nodes] Number of nodes to insert initially.\n");
283 printf(" [-A] Automatically resize hash table.\n");
284 printf(" [-B order|chunk|mmap] Specify the memory backend.\n");
285 printf(" [-R offset] Lookup pool offset.\n");
286 printf(" [-S offset] Write pool offset.\n");
287 printf(" [-T offset] Init pool offset.\n");
288 printf(" [-M size] Lookup pool size.\n");
289 printf(" [-N size] Write pool size.\n");
290 printf(" [-O size] Init pool size.\n");
291 printf(" [-V] Validate lookups of init values (use with filled init pool, same lookup range, with different write range).\n");
292 printf(" [-U] Uniqueness test.\n");
296 int main(int argc
, char **argv
)
299 pthread_t
*tid_reader
, *tid_writer
;
302 unsigned long long *count_reader
;
303 struct wr_count
*count_writer
;
304 unsigned long long tot_reads
= 0, tot_writes
= 0,
305 tot_add
= 0, tot_add_exist
= 0, tot_remove
= 0;
307 long approx_before
, approx_after
;
309 struct sigaction act
;
313 show_usage(argc
, argv
);
317 err
= sscanf(argv
[1], "%u", &nr_readers
);
319 show_usage(argc
, argv
);
323 err
= sscanf(argv
[2], "%u", &nr_writers
);
325 show_usage(argc
, argv
);
329 err
= sscanf(argv
[3], "%lu", &duration
);
331 show_usage(argc
, argv
);
335 for (i
= 4; i
< argc
; i
++) {
336 if (argv
[i
][0] != '-')
338 switch (argv
[i
][1]) {
341 yield_active
|= YIELD_READ
;
344 yield_active
|= YIELD_WRITE
;
349 show_usage(argc
, argv
);
353 cpu_affinities
[next_aff
++] = a
;
355 printf_verbose("Adding CPU %d affinity\n", a
);
359 show_usage(argc
, argv
);
362 rduration
= atol(argv
[++i
]);
366 show_usage(argc
, argv
);
369 wdelay
= atol(argv
[++i
]);
376 show_usage(argc
, argv
);
379 init_hash_size
= atol(argv
[++i
]);
383 show_usage(argc
, argv
);
386 min_hash_alloc_size
= atol(argv
[++i
]);
390 show_usage(argc
, argv
);
393 max_hash_buckets_size
= atol(argv
[++i
]);
397 printf("Please specify at most one of -s or -u.\n");
404 printf("Please specify at most one of -s or -u.\n");
413 init_populate
= atol(argv
[++i
]);
420 show_usage(argc
, argv
);
424 if (!strcmp("order", argv
[i
]))
425 memory_backend
= &cds_lfht_mm_order
;
426 else if (!strcmp("chunk", argv
[i
]))
427 memory_backend
= &cds_lfht_mm_chunk
;
428 else if (!strcmp("mmap", argv
[i
]))
429 memory_backend
= &cds_lfht_mm_mmap
;
431 printf("Please specify memory backend with order|chunk|mmap.\n");
436 lookup_pool_offset
= atol(argv
[++i
]);
439 write_pool_offset
= atol(argv
[++i
]);
442 init_pool_offset
= atol(argv
[++i
]);
445 lookup_pool_size
= atol(argv
[++i
]);
448 write_pool_size
= atol(argv
[++i
]);
451 init_pool_size
= atol(argv
[++i
]);
457 test_choice
= TEST_HASH_UNIQUE
;
462 /* Check if hash size is power of 2 */
463 if (init_hash_size
&& init_hash_size
& (init_hash_size
- 1)) {
464 printf("Error: Initial number of buckets (%lu) is not a power of 2.\n",
469 if (min_hash_alloc_size
&& min_hash_alloc_size
& (min_hash_alloc_size
- 1)) {
470 printf("Error: Minimum number of allocated buckets (%lu) is not a power of 2.\n",
471 min_hash_alloc_size
);
475 if (max_hash_buckets_size
&& max_hash_buckets_size
& (max_hash_buckets_size
- 1)) {
476 printf("Error: Maximum number of buckets (%lu) is not a power of 2.\n",
477 max_hash_buckets_size
);
481 memset(&act
, 0, sizeof(act
));
482 ret
= sigemptyset(&act
.sa_mask
);
484 perror("sigemptyset");
487 act
.sa_handler
= get_sigusr1_cb();
488 act
.sa_flags
= SA_RESTART
;
489 ret
= sigaction(SIGUSR1
, &act
, NULL
);
495 ret
= pipe(count_pipe
);
501 /* spawn counter thread */
502 err
= pthread_create(&tid_count
, NULL
, thr_count
,
507 act
.sa_handler
= get_sigusr2_cb();
508 act
.sa_flags
= SA_RESTART
;
509 ret
= sigaction(SIGUSR2
, &act
, NULL
);
515 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
516 duration
, nr_readers
, nr_writers
);
517 printf_verbose("Writer delay : %lu loops.\n", wdelay
);
518 printf_verbose("Reader duration : %lu loops.\n", rduration
);
519 printf_verbose("Mode:%s%s.\n",
520 add_only
? " add only" : " add/remove",
521 add_unique
? " uniquify" : ( add_replace
? " replace" : " insert"));
522 printf_verbose("Initial number of buckets: %lu buckets.\n", init_hash_size
);
523 printf_verbose("Minimum number of allocated buckets: %lu buckets.\n", min_hash_alloc_size
);
524 printf_verbose("Maximum number of buckets: %lu buckets.\n", max_hash_buckets_size
);
525 printf_verbose("Init pool size offset %lu size %lu.\n",
526 init_pool_offset
, init_pool_size
);
527 printf_verbose("Lookup pool size offset %lu size %lu.\n",
528 lookup_pool_offset
, lookup_pool_size
);
529 printf_verbose("Update pool size offset %lu size %lu.\n",
530 write_pool_offset
, write_pool_size
);
531 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
532 "main", pthread_self(), (unsigned long)gettid());
534 tid_reader
= malloc(sizeof(*tid_reader
) * nr_readers
);
535 tid_writer
= malloc(sizeof(*tid_writer
) * nr_writers
);
536 count_reader
= malloc(sizeof(*count_reader
) * nr_readers
);
537 count_writer
= malloc(sizeof(*count_writer
) * nr_writers
);
539 err
= create_all_cpu_call_rcu_data(0);
541 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
544 if (memory_backend
) {
545 test_ht
= _cds_lfht_new(init_hash_size
, min_hash_alloc_size
,
546 max_hash_buckets_size
,
547 (opt_auto_resize
? CDS_LFHT_AUTO_RESIZE
: 0) |
548 CDS_LFHT_ACCOUNTING
, memory_backend
,
551 test_ht
= cds_lfht_new(init_hash_size
, min_hash_alloc_size
,
552 max_hash_buckets_size
,
553 (opt_auto_resize
? CDS_LFHT_AUTO_RESIZE
: 0) |
554 CDS_LFHT_ACCOUNTING
, NULL
);
558 * Hash Population needs to be seen as a RCU reader
559 * thread from the point of view of resize.
561 rcu_register_thread();
562 ret
= (get_populate_hash_cb())();
565 rcu_thread_offline();
569 for (i
= 0; i
< nr_readers
; i
++) {
570 err
= pthread_create(&tid_reader
[i
],
571 NULL
, get_thr_reader_cb(),
576 for (i
= 0; i
< nr_writers
; i
++) {
577 err
= pthread_create(&tid_writer
[i
],
578 NULL
, get_thr_writer_cb(),
590 remain
= sleep(remain
);
591 } while (remain
> 0);
595 for (i
= 0; i
< nr_readers
; i
++) {
596 err
= pthread_join(tid_reader
[i
], &tret
);
599 tot_reads
+= count_reader
[i
];
601 for (i
= 0; i
< nr_writers
; i
++) {
602 err
= pthread_join(tid_writer
[i
], &tret
);
605 tot_writes
+= count_writer
[i
].update_ops
;
606 tot_add
+= count_writer
[i
].add
;
607 tot_add_exist
+= count_writer
[i
].add_exist
;
608 tot_remove
+= count_writer
[i
].remove
;
611 /* teardown counter thread */
612 act
.sa_handler
= SIG_IGN
;
613 act
.sa_flags
= SA_RESTART
;
614 ret
= sigaction(SIGUSR2
, &act
, NULL
);
620 char msg
[1] = { 0x42 };
624 ret
= write(count_pipe
[1], msg
, 1); /* wakeup thread */
625 } while (ret
== -1L && errno
== EINTR
);
627 err
= pthread_join(tid_count
, &tret
);
634 printf("Counting nodes... ");
635 cds_lfht_count_nodes(test_ht
, &approx_before
, &count
, &approx_after
);
637 test_delete_all_nodes(test_ht
);
639 rcu_thread_offline();
641 printf("Approximation before node accounting: %ld nodes.\n",
643 printf("Nodes deleted from hash table before destroy: "
646 printf("Approximation after node accounting: %ld nodes.\n",
649 ret
= cds_lfht_destroy(test_ht
, NULL
);
651 printf_verbose("final delete aborted\n");
653 printf_verbose("final delete success\n");
654 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads
,
656 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
658 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu "
659 "nr_add %12llu nr_add_fail %12llu nr_remove %12llu nr_leaked %12lld\n",
660 argv
[0], duration
, nr_readers
, rduration
,
661 nr_writers
, wdelay
, tot_reads
, tot_writes
,
662 tot_reads
+ tot_writes
, tot_add
, tot_add_exist
, tot_remove
,
663 (long long) tot_add
+ init_populate
- tot_remove
- count
);
664 rcu_unregister_thread();
665 free_all_cpu_call_rcu_data();