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"
31 void (*sigusr1
)(int signo
);
32 void (*sigusr2
)(int signo
);
33 void *(*thr_reader
)(void *_count
);
34 void *(*thr_writer
)(void *_count
);
35 int (*populate_hash
)(void);
39 struct test_hash_cb test_hash_cb
[] = {
41 test_hash_rw_sigusr1_handler
,
42 test_hash_rw_sigusr2_handler
,
43 test_hash_rw_thr_reader
,
44 test_hash_rw_thr_writer
,
45 test_hash_rw_populate_hash
,
49 static enum test_hash test_choice
= TEST_HASH_RW
;
51 void (*get_sigusr1_cb(void))(int)
53 return test_hash_cb
[test_choice
].sigusr1
;
56 void (*get_sigusr2_cb(void))(int)
58 return test_hash_cb
[test_choice
].sigusr2
;
61 void *(*get_thr_reader_cb(void))(void *)
63 return test_hash_cb
[test_choice
].thr_reader
;
66 void *(*get_thr_writer_cb(void))(void *)
68 return test_hash_cb
[test_choice
].thr_writer
;
71 int (*get_populate_hash_cb(void))(void)
73 return test_hash_cb
[test_choice
].populate_hash
;
76 unsigned int __thread rand_lookup
;
77 unsigned long __thread nr_add
;
78 unsigned long __thread nr_addexist
;
79 unsigned long __thread nr_del
;
80 unsigned long __thread nr_delnoent
;
81 unsigned long __thread lookup_fail
;
82 unsigned long __thread lookup_ok
;
84 struct cds_lfht
*test_ht
;
86 volatile int test_go
, test_stop
;
90 unsigned long duration
;
92 /* read-side C.S. duration, in loops */
93 unsigned long rduration
;
95 unsigned long init_hash_size
= DEFAULT_HASH_SIZE
;
96 unsigned long min_hash_alloc_size
= DEFAULT_MIN_ALLOC_SIZE
;
97 unsigned long max_hash_buckets_size
= (1UL << 20);
98 unsigned long init_populate
;
100 int add_only
, add_unique
, add_replace
;
101 const struct cds_lfht_mm_type
*memory_backend
;
103 unsigned long init_pool_offset
, lookup_pool_offset
, write_pool_offset
;
104 unsigned long init_pool_size
= DEFAULT_RAND_POOL
,
105 lookup_pool_size
= DEFAULT_RAND_POOL
,
106 write_pool_size
= DEFAULT_RAND_POOL
;
113 unsigned int cpu_affinities
[NR_CPUS
];
114 unsigned int next_aff
= 0;
115 int use_affinity
= 0;
117 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
119 unsigned long long __thread nr_writes
;
120 unsigned long long __thread nr_reads
;
122 unsigned int nr_readers
;
123 unsigned int nr_writers
;
125 static pthread_mutex_t rcu_copy_mutex
= PTHREAD_MUTEX_INITIALIZER
;
127 void set_affinity(void)
136 #if HAVE_SCHED_SETAFFINITY
137 ret
= pthread_mutex_lock(&affinity_mutex
);
139 perror("Error in pthread mutex lock");
142 cpu
= cpu_affinities
[next_aff
++];
143 ret
= pthread_mutex_unlock(&affinity_mutex
);
145 perror("Error in pthread mutex unlock");
150 #if SCHED_SETAFFINITY_ARGS == 2
151 sched_setaffinity(0, &mask
);
153 sched_setaffinity(0, sizeof(mask
), &mask
);
155 #endif /* HAVE_SCHED_SETAFFINITY */
158 void rcu_copy_mutex_lock(void)
161 ret
= pthread_mutex_lock(&rcu_copy_mutex
);
163 perror("Error in pthread mutex lock");
168 void rcu_copy_mutex_unlock(void)
172 ret
= pthread_mutex_unlock(&rcu_copy_mutex
);
174 perror("Error in pthread mutex unlock");
179 unsigned long test_compare(const void *key1
, size_t key1_len
,
180 const void *key2
, size_t key2_len
)
182 if (caa_unlikely(key1_len
!= key2_len
))
184 assert(key1_len
== sizeof(unsigned long));
191 void *thr_count(void *arg
)
193 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
194 "counter", pthread_self(), (unsigned long)gettid());
196 rcu_register_thread();
200 long approx_before
, approx_after
;
204 rcu_thread_offline();
205 len
= read(count_pipe
[0], buf
, 1);
207 if (caa_unlikely(!test_duration_read()))
212 printf("Counting nodes... ");
215 cds_lfht_count_nodes(test_ht
, &approx_before
, &count
,
219 printf("Approximation before node accounting: %ld nodes.\n",
221 printf("Accounting of nodes in the hash table: "
224 printf("Approximation after node accounting: %ld nodes.\n",
227 rcu_unregister_thread();
231 void free_node_cb(struct rcu_head
*head
)
233 struct lfht_test_node
*node
=
234 caa_container_of(head
, struct lfht_test_node
, head
);
239 void test_delete_all_nodes(struct cds_lfht
*ht
)
241 struct cds_lfht_iter iter
;
242 struct lfht_test_node
*node
;
243 unsigned long count
= 0;
245 cds_lfht_for_each_entry(ht
, &iter
, node
, node
) {
248 ret
= cds_lfht_del(test_ht
, cds_lfht_iter_get_node(&iter
));
250 call_rcu(&node
->head
, free_node_cb
);
253 printf("deleted %lu nodes.\n", count
);
256 void show_usage(int argc
, char **argv
)
258 printf("Usage : %s nr_readers nr_writers duration (s)\n", argv
[0]);
260 printf(" [-r] [-w] (yield reader and/or writer)\n");
262 printf(" [-d delay] (writer period (us))\n");
263 printf(" [-c duration] (reader C.S. duration (in loops))\n");
264 printf(" [-v] (verbose output)\n");
265 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
266 printf(" [-h size] (initial number of buckets)\n");
267 printf(" [-m size] (minimum number of allocated buckets)\n");
268 printf(" [-n size] (maximum number of buckets)\n");
269 printf(" [not -u nor -s] Add entries (supports redundant keys).\n");
270 printf(" [-u] Uniquify add (no redundant keys).\n");
271 printf(" [-s] Replace (swap) entries.\n");
272 printf(" [-i] Add only (no removal).\n");
273 printf(" [-k nr_nodes] Number of nodes to insert initially.\n");
274 printf(" [-A] Automatically resize hash table.\n");
275 printf(" [-B order|chunk|mmap] Specify the memory backend.\n");
276 printf(" [-R offset] Lookup pool offset.\n");
277 printf(" [-S offset] Write pool offset.\n");
278 printf(" [-T offset] Init pool offset.\n");
279 printf(" [-M size] Lookup pool size.\n");
280 printf(" [-N size] Write pool size.\n");
281 printf(" [-O size] Init pool size.\n");
282 printf(" [-V] Validate lookups of init values (use with filled init pool, same lookup range, with different write range).\n");
286 int main(int argc
, char **argv
)
289 pthread_t
*tid_reader
, *tid_writer
;
292 unsigned long long *count_reader
;
293 struct wr_count
*count_writer
;
294 unsigned long long tot_reads
= 0, tot_writes
= 0,
295 tot_add
= 0, tot_add_exist
= 0, tot_remove
= 0;
297 long approx_before
, approx_after
;
299 struct sigaction act
;
303 show_usage(argc
, argv
);
307 err
= sscanf(argv
[1], "%u", &nr_readers
);
309 show_usage(argc
, argv
);
313 err
= sscanf(argv
[2], "%u", &nr_writers
);
315 show_usage(argc
, argv
);
319 err
= sscanf(argv
[3], "%lu", &duration
);
321 show_usage(argc
, argv
);
325 for (i
= 4; i
< argc
; i
++) {
326 if (argv
[i
][0] != '-')
328 switch (argv
[i
][1]) {
331 yield_active
|= YIELD_READ
;
334 yield_active
|= YIELD_WRITE
;
339 show_usage(argc
, argv
);
343 cpu_affinities
[next_aff
++] = a
;
345 printf_verbose("Adding CPU %d affinity\n", a
);
349 show_usage(argc
, argv
);
352 rduration
= atol(argv
[++i
]);
356 show_usage(argc
, argv
);
359 wdelay
= atol(argv
[++i
]);
366 show_usage(argc
, argv
);
369 init_hash_size
= atol(argv
[++i
]);
373 show_usage(argc
, argv
);
376 min_hash_alloc_size
= atol(argv
[++i
]);
380 show_usage(argc
, argv
);
383 max_hash_buckets_size
= atol(argv
[++i
]);
387 printf("Please specify at most one of -s or -u.\n");
394 printf("Please specify at most one of -s or -u.\n");
403 init_populate
= atol(argv
[++i
]);
410 show_usage(argc
, argv
);
414 if (!strcmp("order", argv
[i
]))
415 memory_backend
= &cds_lfht_mm_order
;
416 else if (!strcmp("chunk", argv
[i
]))
417 memory_backend
= &cds_lfht_mm_chunk
;
418 else if (!strcmp("mmap", argv
[i
]))
419 memory_backend
= &cds_lfht_mm_mmap
;
421 printf("Please specify memory backend with order|chunk|mmap.\n");
426 lookup_pool_offset
= atol(argv
[++i
]);
429 write_pool_offset
= atol(argv
[++i
]);
432 init_pool_offset
= atol(argv
[++i
]);
435 lookup_pool_size
= atol(argv
[++i
]);
438 write_pool_size
= atol(argv
[++i
]);
441 init_pool_size
= atol(argv
[++i
]);
450 /* Check if hash size is power of 2 */
451 if (init_hash_size
&& init_hash_size
& (init_hash_size
- 1)) {
452 printf("Error: Initial number of buckets (%lu) is not a power of 2.\n",
457 if (min_hash_alloc_size
&& min_hash_alloc_size
& (min_hash_alloc_size
- 1)) {
458 printf("Error: Minimum number of allocated buckets (%lu) is not a power of 2.\n",
459 min_hash_alloc_size
);
463 if (max_hash_buckets_size
&& max_hash_buckets_size
& (max_hash_buckets_size
- 1)) {
464 printf("Error: Maximum number of buckets (%lu) is not a power of 2.\n",
465 max_hash_buckets_size
);
469 memset(&act
, 0, sizeof(act
));
470 ret
= sigemptyset(&act
.sa_mask
);
472 perror("sigemptyset");
475 act
.sa_handler
= get_sigusr1_cb();
476 act
.sa_flags
= SA_RESTART
;
477 ret
= sigaction(SIGUSR1
, &act
, NULL
);
483 ret
= pipe(count_pipe
);
489 /* spawn counter thread */
490 err
= pthread_create(&tid_count
, NULL
, thr_count
,
495 act
.sa_handler
= get_sigusr2_cb();
496 act
.sa_flags
= SA_RESTART
;
497 ret
= sigaction(SIGUSR2
, &act
, NULL
);
503 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
504 duration
, nr_readers
, nr_writers
);
505 printf_verbose("Writer delay : %lu loops.\n", wdelay
);
506 printf_verbose("Reader duration : %lu loops.\n", rduration
);
507 printf_verbose("Mode:%s%s.\n",
508 add_only
? " add only" : " add/remove",
509 add_unique
? " uniquify" : ( add_replace
? " replace" : " insert"));
510 printf_verbose("Initial number of buckets: %lu buckets.\n", init_hash_size
);
511 printf_verbose("Minimum number of allocated buckets: %lu buckets.\n", min_hash_alloc_size
);
512 printf_verbose("Maximum number of buckets: %lu buckets.\n", max_hash_buckets_size
);
513 printf_verbose("Init pool size offset %lu size %lu.\n",
514 init_pool_offset
, init_pool_size
);
515 printf_verbose("Lookup pool size offset %lu size %lu.\n",
516 lookup_pool_offset
, lookup_pool_size
);
517 printf_verbose("Update pool size offset %lu size %lu.\n",
518 write_pool_offset
, write_pool_size
);
519 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
520 "main", pthread_self(), (unsigned long)gettid());
522 tid_reader
= malloc(sizeof(*tid_reader
) * nr_readers
);
523 tid_writer
= malloc(sizeof(*tid_writer
) * nr_writers
);
524 count_reader
= malloc(sizeof(*count_reader
) * nr_readers
);
525 count_writer
= malloc(sizeof(*count_writer
) * nr_writers
);
527 err
= create_all_cpu_call_rcu_data(0);
529 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
532 if (memory_backend
) {
533 test_ht
= _cds_lfht_new(init_hash_size
, min_hash_alloc_size
,
534 max_hash_buckets_size
,
535 (opt_auto_resize
? CDS_LFHT_AUTO_RESIZE
: 0) |
536 CDS_LFHT_ACCOUNTING
, memory_backend
,
539 test_ht
= cds_lfht_new(init_hash_size
, min_hash_alloc_size
,
540 max_hash_buckets_size
,
541 (opt_auto_resize
? CDS_LFHT_AUTO_RESIZE
: 0) |
542 CDS_LFHT_ACCOUNTING
, NULL
);
546 * Hash Population needs to be seen as a RCU reader
547 * thread from the point of view of resize.
549 rcu_register_thread();
550 ret
= (get_populate_hash_cb())();
553 rcu_thread_offline();
557 for (i
= 0; i
< nr_readers
; i
++) {
558 err
= pthread_create(&tid_reader
[i
],
559 NULL
, get_thr_reader_cb(),
564 for (i
= 0; i
< nr_writers
; i
++) {
565 err
= pthread_create(&tid_writer
[i
],
566 NULL
, get_thr_writer_cb(),
578 remain
= sleep(remain
);
579 } while (remain
> 0);
583 for (i
= 0; i
< nr_readers
; i
++) {
584 err
= pthread_join(tid_reader
[i
], &tret
);
587 tot_reads
+= count_reader
[i
];
589 for (i
= 0; i
< nr_writers
; i
++) {
590 err
= pthread_join(tid_writer
[i
], &tret
);
593 tot_writes
+= count_writer
[i
].update_ops
;
594 tot_add
+= count_writer
[i
].add
;
595 tot_add_exist
+= count_writer
[i
].add_exist
;
596 tot_remove
+= count_writer
[i
].remove
;
599 /* teardown counter thread */
600 act
.sa_handler
= SIG_IGN
;
601 act
.sa_flags
= SA_RESTART
;
602 ret
= sigaction(SIGUSR2
, &act
, NULL
);
608 char msg
[1] = { 0x42 };
612 ret
= write(count_pipe
[1], msg
, 1); /* wakeup thread */
613 } while (ret
== -1L && errno
== EINTR
);
615 err
= pthread_join(tid_count
, &tret
);
622 printf("Counting nodes... ");
623 cds_lfht_count_nodes(test_ht
, &approx_before
, &count
, &approx_after
);
625 test_delete_all_nodes(test_ht
);
627 rcu_thread_offline();
629 printf("Approximation before node accounting: %ld nodes.\n",
631 printf("Nodes deleted from hash table before destroy: "
634 printf("Approximation after node accounting: %ld nodes.\n",
637 ret
= cds_lfht_destroy(test_ht
, NULL
);
639 printf_verbose("final delete aborted\n");
641 printf_verbose("final delete success\n");
642 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads
,
644 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
646 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu "
647 "nr_add %12llu nr_add_fail %12llu nr_remove %12llu nr_leaked %12lld\n",
648 argv
[0], duration
, nr_readers
, rduration
,
649 nr_writers
, wdelay
, tot_reads
, tot_writes
,
650 tot_reads
+ tot_writes
, tot_add
, tot_add_exist
, tot_remove
,
651 (long long) tot_add
+ init_populate
- tot_remove
- count
);
652 rcu_unregister_thread();
653 free_all_cpu_call_rcu_data();