4 * Userspace RCU library - test program
6 * Copyright February 2009 - 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.
28 #include <sys/types.h>
40 #define DEFAULT_HASH_SIZE 32
41 #define DEFAULT_RAND_POOL 1000000
43 /* Make this big enough to include the POWER5+ L3 cacheline size of 256B */
44 #define CACHE_LINE_SIZE 4096
46 /* hardcoded number of CPUs */
49 #if defined(_syscall0)
50 _syscall0(pid_t
, gettid
)
51 #elif defined(__NR_gettid)
52 static inline pid_t
gettid(void)
54 return syscall(__NR_gettid
);
57 #warning "use pid as tid"
58 static inline pid_t
gettid(void)
64 #ifndef DYNAMIC_LINK_TEST
67 #define debug_yield_read()
69 #include <urcu-qsbr.h>
70 #include <urcu/rculfhash.h>
71 #include <urcu-call-rcu.h>
74 unsigned long update_ops
;
76 unsigned long add_exist
;
80 static unsigned int __thread rand_lookup
;
81 static unsigned long __thread nr_add
;
82 static unsigned long __thread nr_addexist
;
83 static unsigned long __thread nr_del
;
84 static unsigned long __thread nr_delnoent
;
85 static unsigned long __thread lookup_fail
;
86 static unsigned long __thread lookup_ok
;
88 static struct cds_lfht
*test_ht
;
95 static volatile int test_go
, test_stop
;
97 static unsigned long wdelay
;
99 static unsigned long duration
;
101 /* read-side C.S. duration, in loops */
102 static unsigned long rduration
;
104 static unsigned long init_hash_size
= DEFAULT_HASH_SIZE
;
105 static unsigned long init_populate
;
106 static unsigned long rand_pool
= DEFAULT_RAND_POOL
;
107 static int add_only
, add_unique
;
109 static inline void loop_sleep(unsigned long l
)
115 static int verbose_mode
;
117 #define printf_verbose(fmt, args...) \
120 printf(fmt, ## args); \
123 static unsigned int cpu_affinities
[NR_CPUS
];
124 static unsigned int next_aff
= 0;
125 static int use_affinity
= 0;
127 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
129 static void set_affinity(void)
138 ret
= pthread_mutex_lock(&affinity_mutex
);
140 perror("Error in pthread mutex lock");
143 cpu
= cpu_affinities
[next_aff
++];
144 ret
= pthread_mutex_unlock(&affinity_mutex
);
146 perror("Error in pthread mutex unlock");
151 sched_setaffinity(0, sizeof(mask
), &mask
);
158 } addremove
; /* 1: add, -1 remove, 0: random */
161 void sigusr1_handler(int signo
)
165 printf("Add/Remove: random.\n");
166 addremove
= AR_RANDOM
;
169 printf("Add/Remove: remove only.\n");
170 addremove
= AR_REMOVE
;
173 printf("Add/Remove: add only.\n");
180 * returns 0 if test should end.
182 static int test_duration_write(void)
187 static int test_duration_read(void)
192 static unsigned long long __thread nr_writes
;
193 static unsigned long long __thread nr_reads
;
195 static unsigned int nr_readers
;
196 static unsigned int nr_writers
;
198 pthread_mutex_t rcu_copy_mutex
= PTHREAD_MUTEX_INITIALIZER
;
200 void rcu_copy_mutex_lock(void)
203 ret
= pthread_mutex_lock(&rcu_copy_mutex
);
205 perror("Error in pthread mutex lock");
210 void rcu_copy_mutex_unlock(void)
214 ret
= pthread_mutex_unlock(&rcu_copy_mutex
);
216 perror("Error in pthread mutex unlock");
223 * Source: http://burtleburtle.net/bob/c/lookup3.c
224 * Originally Public Domain
227 #define rot(x, k) (((x) << (k)) | ((x) >> (32 - (k))))
229 #define mix(a, b, c) \
231 a -= c; a ^= rot(c, 4); c += b; \
232 b -= a; b ^= rot(a, 6); a += c; \
233 c -= b; c ^= rot(b, 8); b += a; \
234 a -= c; a ^= rot(c, 16); c += b; \
235 b -= a; b ^= rot(a, 19); a += c; \
236 c -= b; c ^= rot(b, 4); b += a; \
239 #define final(a, b, c) \
241 c ^= b; c -= rot(b, 14); \
242 a ^= c; a -= rot(c, 11); \
243 b ^= a; b -= rot(a, 25); \
244 c ^= b; c -= rot(b, 16); \
245 a ^= c; a -= rot(c, 4);\
246 b ^= a; b -= rot(a, 14); \
247 c ^= b; c -= rot(b, 24); \
250 static __attribute__((unused
))
252 const uint32_t *k
, /* the key, an array of uint32_t values */
253 size_t length
, /* the length of the key, in uint32_ts */
254 uint32_t initval
) /* the previous hash, or an arbitrary value */
258 /* Set up the internal state */
259 a
= b
= c
= 0xdeadbeef + (((uint32_t) length
) << 2) + initval
;
261 /*----------------------------------------- handle most of the key */
271 /*----------------------------------- handle the last 3 uint32_t's */
272 switch (length
) { /* all the case statements fall through */
277 case 0: /* case 0: nothing left to add */
280 /*---------------------------------------------- report the result */
286 const uint32_t *k
, /* the key, an array of uint32_t values */
287 size_t length
, /* the length of the key, in uint32_ts */
288 uint32_t *pc
, /* IN: seed OUT: primary hash value */
289 uint32_t *pb
) /* IN: more seed OUT: secondary hash value */
293 /* Set up the internal state */
294 a
= b
= c
= 0xdeadbeef + ((uint32_t) (length
<< 2)) + *pc
;
297 /*----------------------------------------- handle most of the key */
307 /*----------------------------------- handle the last 3 uint32_t's */
308 switch (length
) { /* all the case statements fall through */
313 case 0: /* case 0: nothing left to add */
316 /*---------------------------------------------- report the result */
321 #if (CAA_BITS_PER_LONG == 32)
323 unsigned long test_hash(void *_key
, size_t length
, unsigned long seed
)
325 unsigned long key
= (unsigned long) _key
;
328 assert(length
== sizeof(unsigned long));
329 return hash_u32(&v
, 1, seed
);
333 unsigned long test_hash(void *_key
, size_t length
, unsigned long seed
)
344 assert(length
== sizeof(unsigned long));
345 v
.v64
= (uint64_t) seed
;
346 key
.v64
= (uint64_t) _key
;
347 hashword2(key
.v32
, 2, &v
.v32
[0], &v
.v32
[1]);
353 unsigned long test_compare(void *key1
, size_t key1_len
,
354 void *key2
, size_t key2_len
)
356 if (unlikely(key1_len
!= key2_len
))
358 assert(key1_len
== sizeof(unsigned long));
365 void *thr_reader(void *_count
)
367 unsigned long long *count
= _count
;
368 struct cds_lfht_node
*node
;
370 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
371 "reader", pthread_self(), (unsigned long)gettid());
375 rcu_register_thread();
384 node
= cds_lfht_lookup(test_ht
,
385 (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
),
392 if (unlikely(rduration
))
393 loop_sleep(rduration
);
396 if (unlikely(!test_duration_read()))
398 if (unlikely((nr_reads
& ((1 << 10) - 1)) == 0))
399 rcu_quiescent_state();
402 rcu_unregister_thread();
405 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
406 "reader", pthread_self(), (unsigned long)gettid());
407 printf_verbose("readid : %lx, lookupfail %lu, lookupok %lu\n",
408 pthread_self(), lookup_fail
, lookup_ok
);
414 void free_node_cb(struct rcu_head
*head
)
416 struct cds_lfht_node
*node
=
417 caa_container_of(head
, struct cds_lfht_node
, head
);
421 void *thr_writer(void *_count
)
423 struct cds_lfht_node
*node
, *ret_node
;
424 struct wr_count
*count
= _count
;
427 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
428 "writer", pthread_self(), (unsigned long)gettid());
432 rcu_register_thread();
440 if ((addremove
== AR_ADD
|| add_only
)
441 || (addremove
== AR_RANDOM
&& rand_r(&rand_lookup
) & 1)) {
442 node
= malloc(sizeof(struct cds_lfht_node
));
444 cds_lfht_node_init(node
,
445 (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
),
448 ret_node
= cds_lfht_add_unique(test_ht
, node
);
450 cds_lfht_add(test_ht
, node
);
452 if (add_unique
&& ret_node
!= node
) {
460 node
= cds_lfht_lookup(test_ht
,
461 (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
),
464 ret
= cds_lfht_remove(test_ht
, node
);
469 call_rcu(&node
->head
, free_node_cb
);
475 //if (nr_writes % 100000 == 0) {
476 if (nr_writes
% 1000 == 0) {
478 if (rand_r(&rand_lookup
) & 1) {
479 ht_resize(test_ht
, 1);
481 ht_resize(test_ht
, -1);
487 if (unlikely(!test_duration_write()))
489 if (unlikely(wdelay
))
491 if (unlikely((nr_writes
& ((1 << 10) - 1)) == 0))
492 rcu_quiescent_state();
495 rcu_unregister_thread();
497 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
498 "writer", pthread_self(), (unsigned long)gettid());
499 printf_verbose("info id %lx: nr_add %lu, nr_addexist %lu, nr_del %lu, "
500 "nr_delnoent %lu\n", pthread_self(), nr_add
,
501 nr_addexist
, nr_del
, nr_delnoent
);
502 count
->update_ops
= nr_writes
;
504 count
->add_exist
= nr_addexist
;
505 count
->remove
= nr_del
;
509 static int populate_hash(void)
511 struct cds_lfht_node
*node
, *ret_node
;
516 if (add_unique
&& init_populate
* 10 > rand_pool
) {
517 printf("WARNING: required to populate %lu nodes (-k), but random "
518 "pool is quite small (%lu values) and we are in add_unique (-u) mode. Try with a "
519 "larger random pool (-p option).\n", init_populate
, rand_pool
);
523 while (nr_add
< init_populate
) {
524 node
= malloc(sizeof(struct cds_lfht_node
));
525 cds_lfht_node_init(node
,
526 (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
),
529 ret_node
= cds_lfht_add_unique(test_ht
, node
);
531 cds_lfht_add(test_ht
, node
);
532 if (add_unique
&& ret_node
!= node
) {
542 void show_usage(int argc
, char **argv
)
544 printf("Usage : %s nr_readers nr_writers duration (s)", argv
[0]);
546 printf(" [-r] [-w] (yield reader and/or writer)");
548 printf(" [-d delay] (writer period (us))");
549 printf(" [-c duration] (reader C.S. duration (in loops))");
550 printf(" [-v] (verbose output)");
551 printf(" [-a cpu#] [-a cpu#]... (affinity)");
552 printf(" [-p size] (random key value pool size)");
553 printf(" [-h size] (initial hash table size)");
554 printf(" [-u] Uniquify add.");
555 printf(" [-i] Add only (no removal).");
556 printf(" [-k nr_nodes] Number of nodes to insert initially.");
560 int main(int argc
, char **argv
)
563 pthread_t
*tid_reader
, *tid_writer
;
565 unsigned long long *count_reader
;
566 struct wr_count
*count_writer
;
567 unsigned long long tot_reads
= 0, tot_writes
= 0,
568 tot_add
= 0, tot_add_exist
= 0, tot_remove
= 0;
569 unsigned long count
, removed
;
571 struct sigaction act
;
575 show_usage(argc
, argv
);
579 err
= sscanf(argv
[1], "%u", &nr_readers
);
581 show_usage(argc
, argv
);
585 err
= sscanf(argv
[2], "%u", &nr_writers
);
587 show_usage(argc
, argv
);
591 err
= sscanf(argv
[3], "%lu", &duration
);
593 show_usage(argc
, argv
);
597 for (i
= 4; i
< argc
; i
++) {
598 if (argv
[i
][0] != '-')
600 switch (argv
[i
][1]) {
603 yield_active
|= YIELD_READ
;
606 yield_active
|= YIELD_WRITE
;
611 show_usage(argc
, argv
);
615 cpu_affinities
[next_aff
++] = a
;
617 printf_verbose("Adding CPU %d affinity\n", a
);
621 show_usage(argc
, argv
);
624 rduration
= atol(argv
[++i
]);
628 show_usage(argc
, argv
);
631 wdelay
= atol(argv
[++i
]);
638 show_usage(argc
, argv
);
641 rand_pool
= atol(argv
[++i
]);
645 show_usage(argc
, argv
);
648 init_hash_size
= atol(argv
[++i
]);
657 init_populate
= atol(argv
[++i
]);
662 /* Check if hash size is power of 2 */
663 if (init_hash_size
&& init_hash_size
& (init_hash_size
- 1)) {
664 printf("Error: Hash table size %lu is not a power of 2.\n",
669 memset(&act
, 0, sizeof(act
));
670 ret
= sigemptyset(&act
.sa_mask
);
672 perror("sigemptyset");
675 act
.sa_handler
= sigusr1_handler
;
676 act
.sa_flags
= SA_RESTART
;
677 ret
= sigaction(SIGUSR1
, &act
, NULL
);
683 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
684 duration
, nr_readers
, nr_writers
);
685 printf_verbose("Writer delay : %lu loops.\n", wdelay
);
686 printf_verbose("Reader duration : %lu loops.\n", rduration
);
687 printf_verbose("Random pool size : %lu.\n", rand_pool
);
688 printf_verbose("Mode:%s%s.\n",
689 add_only
? " add only" : " add/remove",
690 add_unique
? " uniquify" : "");
691 printf_verbose("Initial hash table size: %lu buckets.\n", init_hash_size
);
692 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
693 "main", pthread_self(), (unsigned long)gettid());
695 tid_reader
= malloc(sizeof(*tid_reader
) * nr_readers
);
696 tid_writer
= malloc(sizeof(*tid_writer
) * nr_writers
);
697 count_reader
= malloc(sizeof(*count_reader
) * nr_readers
);
698 count_writer
= malloc(sizeof(*count_writer
) * nr_writers
);
699 test_ht
= cds_lfht_new(test_hash
, test_compare
, 0x42UL
,
700 init_hash_size
, call_rcu
);
701 ret
= populate_hash();
703 err
= create_all_cpu_call_rcu_data(0);
708 for (i
= 0; i
< nr_readers
; i
++) {
709 err
= pthread_create(&tid_reader
[i
], NULL
, thr_reader
,
714 for (i
= 0; i
< nr_writers
; i
++) {
715 err
= pthread_create(&tid_writer
[i
], NULL
, thr_writer
,
727 remain
= sleep(remain
);
728 } while (remain
> 0);
732 for (i
= 0; i
< nr_readers
; i
++) {
733 err
= pthread_join(tid_reader
[i
], &tret
);
736 tot_reads
+= count_reader
[i
];
738 for (i
= 0; i
< nr_writers
; i
++) {
739 err
= pthread_join(tid_writer
[i
], &tret
);
742 tot_writes
+= count_writer
[i
].update_ops
;
743 tot_add
+= count_writer
[i
].add
;
744 tot_add_exist
+= count_writer
[i
].add_exist
;
745 tot_remove
+= count_writer
[i
].remove
;
747 printf("Counting nodes... ");
749 cds_lfht_count_nodes(test_ht
, &count
, &removed
);
751 if (count
|| removed
)
752 printf("WARNING: nodes left in the hash table upon destroy: "
753 "%lu nodes + %lu logically removed.\n", count
, removed
);
754 ret
= cds_lfht_destroy(test_ht
);
757 printf_verbose("final delete aborted\n");
759 printf_verbose("final delete success\n");
760 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads
,
762 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
764 "wdelay %6lu rand_pool %12llu nr_reads %12llu nr_writes %12llu nr_ops %12llu "
765 "nr_add %12llu nr_add_fail %12llu nr_remove %12llu nr_leaked %12lld\n",
766 argv
[0], duration
, nr_readers
, rduration
,
767 nr_writers
, wdelay
, rand_pool
, tot_reads
, tot_writes
,
768 tot_reads
+ tot_writes
, tot_add
, tot_add_exist
, tot_remove
,
769 (long long) tot_add
+ init_populate
- tot_remove
- count
);