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_ja.h"
28 DEFINE_URCU_TLS(unsigned int, rand_lookup
);
29 DEFINE_URCU_TLS(unsigned long, nr_add
);
30 DEFINE_URCU_TLS(unsigned long, nr_addexist
);
31 DEFINE_URCU_TLS(unsigned long, nr_del
);
32 DEFINE_URCU_TLS(unsigned long, nr_delnoent
);
33 DEFINE_URCU_TLS(unsigned long, lookup_fail
);
34 DEFINE_URCU_TLS(unsigned long, lookup_ok
);
36 struct cds_ja
*test_ja
;
38 volatile int test_go
, test_stop
;
42 unsigned long duration
;
44 /* read-side C.S. duration, in loops */
45 unsigned long rduration
;
47 unsigned long init_populate
;
50 unsigned long init_pool_offset
, lookup_pool_offset
, write_pool_offset
;
51 unsigned long init_pool_size
= DEFAULT_RAND_POOL
,
52 lookup_pool_size
= DEFAULT_RAND_POOL
,
53 write_pool_size
= DEFAULT_RAND_POOL
;
60 unsigned int cpu_affinities
[NR_CPUS
];
61 unsigned int next_aff
= 0;
64 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
66 DEFINE_URCU_TLS(unsigned long long, nr_writes
);
67 DEFINE_URCU_TLS(unsigned long long, nr_reads
);
69 unsigned int nr_readers
;
70 unsigned int nr_writers
;
72 static pthread_mutex_t rcu_copy_mutex
= PTHREAD_MUTEX_INITIALIZER
;
74 void set_affinity(void)
83 #if HAVE_SCHED_SETAFFINITY
84 ret
= pthread_mutex_lock(&affinity_mutex
);
86 perror("Error in pthread mutex lock");
89 cpu
= cpu_affinities
[next_aff
++];
90 ret
= pthread_mutex_unlock(&affinity_mutex
);
92 perror("Error in pthread mutex unlock");
97 #if SCHED_SETAFFINITY_ARGS == 2
98 sched_setaffinity(0, &mask
);
100 sched_setaffinity(0, sizeof(mask
), &mask
);
102 #endif /* HAVE_SCHED_SETAFFINITY */
105 void rcu_copy_mutex_lock(void)
108 ret
= pthread_mutex_lock(&rcu_copy_mutex
);
110 perror("Error in pthread mutex lock");
115 void rcu_copy_mutex_unlock(void)
119 ret
= pthread_mutex_unlock(&rcu_copy_mutex
);
121 perror("Error in pthread mutex unlock");
126 void free_node_cb(struct rcu_head
*head
)
128 struct ja_test_node
*node
=
129 caa_container_of(head
, struct ja_test_node
, node
.head
);
135 void test_delete_all_nodes(struct cds_lfht
*ht
)
137 struct cds_lfht_iter iter
;
138 struct lfht_test_node
*node
;
139 unsigned long count
= 0;
141 cds_lfht_for_each_entry(ht
, &iter
, node
, node
) {
144 ret
= cds_lfht_del(test_ht
, cds_lfht_iter_get_node(&iter
));
146 call_rcu(&node
->head
, free_node_cb
);
149 printf("deleted %lu nodes.\n", count
);
153 void show_usage(int argc
, char **argv
)
155 printf("Usage : %s nr_readers nr_writers duration (s)\n", argv
[0]);
157 printf(" [-r] [-w] (yield reader and/or writer)\n");
159 printf(" [-d delay] (writer period (us))\n");
160 printf(" [-c duration] (reader C.S. duration (in loops))\n");
161 printf(" [-v] (verbose output)\n");
162 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
163 printf(" [not -u nor -s] Add entries (supports redundant keys).\n");
164 printf(" [-i] Add only (no removal).\n");
165 printf(" [-k nr_nodes] Number of nodes to insert initially.\n");
166 printf(" [-R offset] Lookup pool offset.\n");
167 printf(" [-S offset] Write pool offset.\n");
168 printf(" [-T offset] Init pool offset.\n");
169 printf(" [-M size] Lookup pool size.\n");
170 printf(" [-N size] Write pool size.\n");
171 printf(" [-O size] Init pool size.\n");
172 printf(" [-V] Validate lookups of init values (use with filled init pool, same lookup range, with different write range).\n");
178 int test_8bit_key(void)
183 /* Test with 8-bit key */
184 test_ja
= cds_ja_new(8);
186 printf("Error allocating judy array.\n");
191 printf("Test #1: add keys (8-bit).\n");
192 for (key
= 0; key
< 200; key
++) {
193 struct ja_test_node
*node
=
194 calloc(sizeof(*node
), 1);
196 ja_test_node_init(node
, key
);
198 ret
= cds_ja_add(test_ja
, key
, &node
->node
);
201 fprintf(stderr
, "Error (%d) adding node %" PRIu64
"\n",
208 printf("Test #2: successful key lookup (8-bit).\n");
209 for (key
= 0; key
< 200; key
++) {
210 struct cds_hlist_head head
;
213 head
= cds_ja_lookup(test_ja
, key
);
214 if (cds_hlist_empty(&head
)) {
215 fprintf(stderr
, "Error lookup node %" PRIu64
"\n", key
);
221 printf("Test #3: unsuccessful key lookup (8-bit).\n");
222 for (key
= 200; key
< 240; key
++) {
223 struct cds_hlist_head head
;
226 head
= cds_ja_lookup(test_ja
, key
);
227 if (!cds_hlist_empty(&head
)) {
229 "Error unexpected lookup node %" PRIu64
"\n",
236 printf("Test #4: remove keys (8-bit).\n");
237 for (key
= 0; key
< 200; key
++) {
238 struct cds_hlist_head head
;
239 struct ja_test_node
*node
;
242 head
= cds_ja_lookup(test_ja
, key
);
243 node
= cds_hlist_first_entry_rcu(&head
, struct ja_test_node
, node
.list
);
245 fprintf(stderr
, "Error lookup node %" PRIu64
"\n", key
);
248 ret
= cds_ja_del(test_ja
, key
, &node
->node
);
250 fprintf(stderr
, "Error (%d) removing node %" PRIu64
"\n", ret
, key
);
253 call_rcu(&node
->node
.head
, free_node_cb
);
254 head
= cds_ja_lookup(test_ja
, key
);
255 if (!cds_hlist_empty(&head
)) {
256 fprintf(stderr
, "Error lookup %" PRIu64
": %p (after delete) failed. Node is not expected.\n", key
, head
.next
);
263 ret
= cds_ja_destroy(test_ja
, free_node_cb
);
265 fprintf(stderr
, "Error destroying judy array\n");
272 int test_16bit_key(void)
277 /* Test with 16-bit key */
278 test_ja
= cds_ja_new(16);
280 printf("Error allocating judy array.\n");
285 printf("Test #1: add keys (16-bit).\n");
286 for (key
= 0; key
< 10000; key
++) {
287 //for (key = 0; key < 65536; key+=256) {
288 struct ja_test_node
*node
=
289 calloc(sizeof(*node
), 1);
291 ja_test_node_init(node
, key
);
293 ret
= cds_ja_add(test_ja
, key
, &node
->node
);
296 fprintf(stderr
, "Error (%d) adding node %" PRIu64
"\n",
303 printf("Test #2: successful key lookup (16-bit).\n");
304 for (key
= 0; key
< 10000; key
++) {
305 //for (key = 0; key < 65536; key+=256) {
306 struct cds_hlist_head head
;
309 head
= cds_ja_lookup(test_ja
, key
);
310 if (cds_hlist_empty(&head
)) {
311 fprintf(stderr
, "Error lookup node %" PRIu64
"\n", key
);
317 printf("Test #3: unsuccessful key lookup (16-bit).\n");
318 for (key
= 11000; key
<= 11002; key
++) {
319 struct cds_hlist_head head
;
322 head
= cds_ja_lookup(test_ja
, key
);
323 if (!cds_hlist_empty(&head
)) {
325 "Error unexpected lookup node %" PRIu64
"\n",
332 printf("Test #4: remove keys (16-bit).\n");
333 for (key
= 0; key
< 10000; key
++) {
334 //for (key = 0; key < 65536; key+=256) {
335 struct cds_hlist_head head
;
336 struct ja_test_node
*node
;
339 head
= cds_ja_lookup(test_ja
, key
);
340 node
= cds_hlist_first_entry_rcu(&head
, struct ja_test_node
, node
.list
);
342 fprintf(stderr
, "Error lookup node %" PRIu64
"\n", key
);
345 ret
= cds_ja_del(test_ja
, key
, &node
->node
);
347 fprintf(stderr
, "Error (%d) removing node %" PRIu64
"\n", ret
, key
);
350 call_rcu(&node
->node
.head
, free_node_cb
);
351 head
= cds_ja_lookup(test_ja
, key
);
352 if (!cds_hlist_empty(&head
)) {
353 fprintf(stderr
, "Error lookup %" PRIu64
": %p (after delete) failed. Node is not expected.\n", key
, head
.next
);
360 ret
= cds_ja_destroy(test_ja
, free_node_cb
);
362 fprintf(stderr
, "Error destroying judy array\n");
369 * nr_dup is number of nodes per key.
372 int test_sparse_key(unsigned int bits
, int nr_dup
)
374 uint64_t key
, max_key
;
375 int zerocount
, i
, ret
;
378 max_key
= UINT64_MAX
;
380 max_key
= (1ULL << bits
) - 1;
382 printf("Sparse key test begins for %u-bit keys\n", bits
);
383 /* Test with 16-bit key */
384 test_ja
= cds_ja_new(bits
);
386 printf("Error allocating judy array.\n");
391 printf("Test #1: add keys (%u-bit).\n", bits
);
392 for (i
= 0; i
< nr_dup
; i
++) {
394 for (key
= 0; key
<= max_key
&& (key
!= 0 || zerocount
< 1); key
+= 1ULL << (bits
- 8)) {
395 struct ja_test_node
*node
=
396 calloc(sizeof(*node
), 1);
398 ja_test_node_init(node
, key
);
400 ret
= cds_ja_add(test_ja
, key
, &node
->node
);
403 fprintf(stderr
, "Error (%d) adding node %" PRIu64
"\n",
413 printf("Test #2: successful key lookup (%u-bit).\n", bits
);
415 for (key
= 0; key
<= max_key
&& (key
!= 0 || zerocount
< 1); key
+= 1ULL << (bits
- 8)) {
416 struct cds_hlist_head head
;
417 struct ja_test_node
*node
;
418 struct cds_hlist_node
*pos
;
422 head
= cds_ja_lookup(test_ja
, key
);
423 if (cds_hlist_empty(&head
)) {
424 fprintf(stderr
, "Error lookup node %" PRIu64
"\n", key
);
427 cds_hlist_for_each_entry_rcu(node
, pos
, &head
, node
.list
) {
430 if (count
!= nr_dup
) {
431 fprintf(stderr
, "Unexpected number of match for key %" PRIu64
", expected %d, got %d.\n", key
, nr_dup
, count
);
439 printf("Test #3: unsuccessful key lookup (%u-bit).\n", bits
);
441 for (key
= 0; key
<= max_key
&& (key
!= 0 || zerocount
< 1); key
+= 1ULL << (bits
- 8)) {
442 struct cds_hlist_head head
;
445 head
= cds_ja_lookup(test_ja
, key
+ 42);
446 if (!cds_hlist_empty(&head
)) {
448 "Error unexpected lookup node %" PRIu64
"\n",
458 printf("Test #4: remove keys (16-bit).\n");
460 for (key
= 0; key
<= max_key
&& (key
!= 0 || zerocount
< 1); key
+= 1ULL << (bits
- 8)) {
461 struct cds_hlist_head head
;
462 struct ja_test_node
*node
;
463 struct cds_hlist_node
*pos
;
467 head
= cds_ja_lookup(test_ja
, key
);
470 cds_hlist_for_each_entry_rcu(node
, pos
, &head
, node
.list
) {
471 struct cds_hlist_head testhead
;
475 fprintf(stderr
, "Error lookup node %" PRIu64
"\n", key
);
478 ret
= cds_ja_del(test_ja
, key
, &node
->node
);
480 fprintf(stderr
, "Error (%d) removing node %" PRIu64
"\n", ret
, key
);
483 call_rcu(&node
->node
.head
, free_node_cb
);
484 testhead
= cds_ja_lookup(test_ja
, key
);
485 if (count
< nr_dup
&& cds_hlist_empty(&testhead
)) {
486 fprintf(stderr
, "Error: no node found after deletion of some nodes of a key\n");
490 head
= cds_ja_lookup(test_ja
, key
);
491 if (!cds_hlist_empty(&head
)) {
492 fprintf(stderr
, "Error lookup %" PRIu64
": %p (after delete) failed. Node is not expected.\n", key
, head
.next
);
501 ret
= cds_ja_destroy(test_ja
, free_node_cb
);
503 fprintf(stderr
, "Error destroying judy array\n");
506 printf("Test ends\n");
512 int main(int argc
, char **argv
)
515 pthread_t
*tid_reader
, *tid_writer
;
517 unsigned long long *count_reader
;
518 struct wr_count
*count_writer
;
519 unsigned long long tot_reads
= 0, tot_writes
= 0,
520 tot_add
= 0, tot_add_exist
= 0, tot_remove
= 0;
526 show_usage(argc
, argv
);
530 err
= sscanf(argv
[1], "%u", &nr_readers
);
532 show_usage(argc
, argv
);
536 err
= sscanf(argv
[2], "%u", &nr_writers
);
538 show_usage(argc
, argv
);
542 err
= sscanf(argv
[3], "%lu", &duration
);
544 show_usage(argc
, argv
);
548 for (i
= 4; i
< argc
; i
++) {
549 if (argv
[i
][0] != '-')
551 switch (argv
[i
][1]) {
554 yield_active
|= YIELD_READ
;
557 yield_active
|= YIELD_WRITE
;
562 show_usage(argc
, argv
);
566 cpu_affinities
[next_aff
++] = a
;
568 printf_verbose("Adding CPU %d affinity\n", a
);
572 show_usage(argc
, argv
);
575 rduration
= atol(argv
[++i
]);
579 show_usage(argc
, argv
);
582 wdelay
= atol(argv
[++i
]);
591 init_populate
= atol(argv
[++i
]);
594 lookup_pool_offset
= atol(argv
[++i
]);
597 write_pool_offset
= atol(argv
[++i
]);
600 init_pool_offset
= atol(argv
[++i
]);
603 lookup_pool_size
= atol(argv
[++i
]);
606 write_pool_size
= atol(argv
[++i
]);
609 init_pool_size
= atol(argv
[++i
]);
617 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
618 duration
, nr_readers
, nr_writers
);
619 printf_verbose("Writer delay : %lu loops.\n", wdelay
);
620 printf_verbose("Reader duration : %lu loops.\n", rduration
);
621 printf_verbose("Mode:%s.\n",
622 add_only
? " add only" : " add/delete");
623 printf_verbose("Init pool size offset %lu size %lu.\n",
624 init_pool_offset
, init_pool_size
);
625 printf_verbose("Lookup pool size offset %lu size %lu.\n",
626 lookup_pool_offset
, lookup_pool_size
);
627 printf_verbose("Update pool size offset %lu size %lu.\n",
628 write_pool_offset
, write_pool_size
);
629 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
630 "main", pthread_self(), (unsigned long)gettid());
632 tid_reader
= malloc(sizeof(*tid_reader
) * nr_readers
);
633 tid_writer
= malloc(sizeof(*tid_writer
) * nr_writers
);
634 count_reader
= malloc(sizeof(*count_reader
) * nr_readers
);
635 count_writer
= malloc(sizeof(*count_writer
) * nr_writers
);
637 err
= create_all_cpu_call_rcu_data(0);
639 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
642 rcu_register_thread();
644 printf("Test start.\n");
646 for (i
= 0; i
< 3; i
++) {
647 ret
= test_8bit_key();
651 rcu_quiescent_state();
653 ret
= test_16bit_key();
657 rcu_quiescent_state();
660 for (i
= 8; i
<= 64; i
*= 2) {
661 /* nr of nodes per key */
662 for (j
= 1; j
< 4; j
++) {
663 ret
= test_sparse_key(i
, j
);
667 rcu_quiescent_state();
671 printf("Test end.\n");
672 rcu_unregister_thread();
677 * Hash Population needs to be seen as a RCU reader
678 * thread from the point of view of resize.
680 rcu_register_thread();
681 ret
= (get_populate_hash_cb())();
684 rcu_thread_offline();
688 for (i
= 0; i
< nr_readers
; i
++) {
689 err
= pthread_create(&tid_reader
[i
],
690 NULL
, get_thr_reader_cb(),
695 for (i
= 0; i
< nr_writers
; i
++) {
696 err
= pthread_create(&tid_writer
[i
],
697 NULL
, get_thr_writer_cb(),
709 remain
= sleep(remain
);
710 } while (remain
> 0);
714 for (i
= 0; i
< nr_readers
; i
++) {
715 err
= pthread_join(tid_reader
[i
], &tret
);
718 tot_reads
+= count_reader
[i
];
720 for (i
= 0; i
< nr_writers
; i
++) {
721 err
= pthread_join(tid_writer
[i
], &tret
);
724 tot_writes
+= count_writer
[i
].update_ops
;
725 tot_add
+= count_writer
[i
].add
;
726 tot_add_exist
+= count_writer
[i
].add_exist
;
727 tot_remove
+= count_writer
[i
].remove
;
730 /* teardown counter thread */
731 act
.sa_handler
= SIG_IGN
;
732 act
.sa_flags
= SA_RESTART
;
733 ret
= sigaction(SIGUSR2
, &act
, NULL
);
739 char msg
[1] = { 0x42 };
743 ret
= write(count_pipe
[1], msg
, 1); /* wakeup thread */
744 } while (ret
== -1L && errno
== EINTR
);
750 printf("Counting nodes... ");
751 cds_lfht_count_nodes(test_ht
, &approx_before
, &count
, &approx_after
);
753 test_delete_all_nodes(test_ht
);
755 rcu_thread_offline();
757 printf("Approximation before node accounting: %ld nodes.\n",
759 printf("Nodes deleted from hash table before destroy: "
762 printf("Approximation after node accounting: %ld nodes.\n",
765 ret
= cds_lfht_destroy(test_ht
, NULL
);
767 printf_verbose("final delete aborted\n");
769 printf_verbose("final delete success\n");
770 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads
,
772 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
774 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu "
775 "nr_add %12llu nr_add_fail %12llu nr_remove %12llu nr_leaked %12lld\n",
776 argv
[0], duration
, nr_readers
, rduration
,
777 nr_writers
, wdelay
, tot_reads
, tot_writes
,
778 tot_reads
+ tot_writes
, tot_add
, tot_add_exist
, tot_remove
,
779 (long long) tot_add
+ init_populate
- tot_remove
- count
);
780 rcu_unregister_thread();
781 free_all_cpu_call_rcu_data();