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 */
50 #define poison_free(ptr) \
52 memset(ptr, 0x42, sizeof(*(ptr))); \
56 #define poison_free(ptr) free(ptr)
61 #if defined(_syscall0)
62 _syscall0(pid_t
, gettid
)
63 #elif defined(__NR_gettid)
64 static inline pid_t
gettid(void)
66 return syscall(__NR_gettid
);
69 #warning "use pid as tid"
70 static inline pid_t
gettid(void)
76 #ifndef DYNAMIC_LINK_TEST
79 #define debug_yield_read()
81 #include <urcu-qsbr.h>
82 #include <urcu/rculfhash.h>
83 #include <urcu-call-rcu.h>
86 unsigned long update_ops
;
88 unsigned long add_exist
;
92 static unsigned int __thread rand_lookup
;
93 static unsigned long __thread nr_add
;
94 static unsigned long __thread nr_addexist
;
95 static unsigned long __thread nr_del
;
96 static unsigned long __thread nr_delnoent
;
97 static unsigned long __thread lookup_fail
;
98 static unsigned long __thread lookup_ok
;
100 static struct cds_lfht
*test_ht
;
107 static volatile int test_go
, test_stop
;
109 static unsigned long wdelay
;
111 static unsigned long duration
;
113 /* read-side C.S. duration, in loops */
114 static unsigned long rduration
;
116 static unsigned long init_hash_size
= DEFAULT_HASH_SIZE
;
117 static unsigned long init_populate
;
118 static unsigned long rand_pool
= DEFAULT_RAND_POOL
;
119 static int opt_auto_resize
;
120 static int add_only
, add_unique
;
122 static inline void loop_sleep(unsigned long l
)
128 static int verbose_mode
;
130 #define printf_verbose(fmt, args...) \
133 printf(fmt, ## args); \
136 static unsigned int cpu_affinities
[NR_CPUS
];
137 static unsigned int next_aff
= 0;
138 static int use_affinity
= 0;
140 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
142 static void set_affinity(void)
151 ret
= pthread_mutex_lock(&affinity_mutex
);
153 perror("Error in pthread mutex lock");
156 cpu
= cpu_affinities
[next_aff
++];
157 ret
= pthread_mutex_unlock(&affinity_mutex
);
159 perror("Error in pthread mutex unlock");
164 sched_setaffinity(0, sizeof(mask
), &mask
);
171 } addremove
; /* 1: add, -1 remove, 0: random */
174 void sigusr1_handler(int signo
)
178 printf("Add/Remove: random.\n");
179 addremove
= AR_RANDOM
;
182 printf("Add/Remove: remove only.\n");
183 addremove
= AR_REMOVE
;
186 printf("Add/Remove: add only.\n");
193 * returns 0 if test should end.
195 static int test_duration_write(void)
200 static int test_duration_read(void)
205 static unsigned long long __thread nr_writes
;
206 static unsigned long long __thread nr_reads
;
208 static unsigned int nr_readers
;
209 static unsigned int nr_writers
;
211 pthread_mutex_t rcu_copy_mutex
= PTHREAD_MUTEX_INITIALIZER
;
213 void rcu_copy_mutex_lock(void)
216 ret
= pthread_mutex_lock(&rcu_copy_mutex
);
218 perror("Error in pthread mutex lock");
223 void rcu_copy_mutex_unlock(void)
227 ret
= pthread_mutex_unlock(&rcu_copy_mutex
);
229 perror("Error in pthread mutex unlock");
236 * Source: http://burtleburtle.net/bob/c/lookup3.c
237 * Originally Public Domain
240 #define rot(x, k) (((x) << (k)) | ((x) >> (32 - (k))))
242 #define mix(a, b, c) \
244 a -= c; a ^= rot(c, 4); c += b; \
245 b -= a; b ^= rot(a, 6); a += c; \
246 c -= b; c ^= rot(b, 8); b += a; \
247 a -= c; a ^= rot(c, 16); c += b; \
248 b -= a; b ^= rot(a, 19); a += c; \
249 c -= b; c ^= rot(b, 4); b += a; \
252 #define final(a, b, c) \
254 c ^= b; c -= rot(b, 14); \
255 a ^= c; a -= rot(c, 11); \
256 b ^= a; b -= rot(a, 25); \
257 c ^= b; c -= rot(b, 16); \
258 a ^= c; a -= rot(c, 4);\
259 b ^= a; b -= rot(a, 14); \
260 c ^= b; c -= rot(b, 24); \
263 static __attribute__((unused
))
265 const uint32_t *k
, /* the key, an array of uint32_t values */
266 size_t length
, /* the length of the key, in uint32_ts */
267 uint32_t initval
) /* the previous hash, or an arbitrary value */
271 /* Set up the internal state */
272 a
= b
= c
= 0xdeadbeef + (((uint32_t) length
) << 2) + initval
;
274 /*----------------------------------------- handle most of the key */
284 /*----------------------------------- handle the last 3 uint32_t's */
285 switch (length
) { /* all the case statements fall through */
290 case 0: /* case 0: nothing left to add */
293 /*---------------------------------------------- report the result */
299 const uint32_t *k
, /* the key, an array of uint32_t values */
300 size_t length
, /* the length of the key, in uint32_ts */
301 uint32_t *pc
, /* IN: seed OUT: primary hash value */
302 uint32_t *pb
) /* IN: more seed OUT: secondary hash value */
306 /* Set up the internal state */
307 a
= b
= c
= 0xdeadbeef + ((uint32_t) (length
<< 2)) + *pc
;
310 /*----------------------------------------- handle most of the key */
320 /*----------------------------------- handle the last 3 uint32_t's */
321 switch (length
) { /* all the case statements fall through */
326 case 0: /* case 0: nothing left to add */
329 /*---------------------------------------------- report the result */
334 #if (CAA_BITS_PER_LONG == 32)
336 unsigned long test_hash(void *_key
, size_t length
, unsigned long seed
)
338 unsigned long key
= (unsigned long) _key
;
341 assert(length
== sizeof(unsigned long));
342 return hash_u32(&v
, 1, seed
);
346 unsigned long test_hash(void *_key
, size_t length
, unsigned long seed
)
357 assert(length
== sizeof(unsigned long));
358 v
.v64
= (uint64_t) seed
;
359 key
.v64
= (uint64_t) _key
;
360 hashword2(key
.v32
, 2, &v
.v32
[0], &v
.v32
[1]);
366 unsigned long test_compare(void *key1
, size_t key1_len
,
367 void *key2
, size_t key2_len
)
369 if (unlikely(key1_len
!= key2_len
))
371 assert(key1_len
== sizeof(unsigned long));
378 void *thr_reader(void *_count
)
380 unsigned long long *count
= _count
;
381 struct cds_lfht_node
*node
;
383 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
384 "reader", pthread_self(), (unsigned long)gettid());
388 rcu_register_thread();
397 node
= cds_lfht_lookup(test_ht
,
398 (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
),
405 if (unlikely(rduration
))
406 loop_sleep(rduration
);
409 if (unlikely(!test_duration_read()))
411 if (unlikely((nr_reads
& ((1 << 10) - 1)) == 0))
412 rcu_quiescent_state();
415 rcu_unregister_thread();
418 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
419 "reader", pthread_self(), (unsigned long)gettid());
420 printf_verbose("readid : %lx, lookupfail %lu, lookupok %lu\n",
421 pthread_self(), lookup_fail
, lookup_ok
);
427 void free_node_cb(struct rcu_head
*head
)
429 struct cds_lfht_node
*node
=
430 caa_container_of(head
, struct cds_lfht_node
, head
);
434 void *thr_writer(void *_count
)
436 struct cds_lfht_node
*node
, *ret_node
;
437 struct wr_count
*count
= _count
;
440 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
441 "writer", pthread_self(), (unsigned long)gettid());
445 rcu_register_thread();
453 if ((addremove
== AR_ADD
|| add_only
)
454 || (addremove
== AR_RANDOM
&& rand_r(&rand_lookup
) & 1)) {
455 node
= malloc(sizeof(struct cds_lfht_node
));
457 cds_lfht_node_init(node
,
458 (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
),
461 ret_node
= cds_lfht_add_unique(test_ht
, node
);
463 cds_lfht_add(test_ht
, node
);
465 if (add_unique
&& ret_node
!= node
) {
473 node
= cds_lfht_lookup(test_ht
,
474 (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
),
477 ret
= cds_lfht_remove(test_ht
, node
);
482 call_rcu(&node
->head
, free_node_cb
);
488 //if (nr_writes % 100000 == 0) {
489 if (nr_writes
% 1000 == 0) {
491 if (rand_r(&rand_lookup
) & 1) {
492 ht_resize(test_ht
, 1);
494 ht_resize(test_ht
, -1);
500 if (unlikely(!test_duration_write()))
502 if (unlikely(wdelay
))
504 if (unlikely((nr_writes
& ((1 << 10) - 1)) == 0))
505 rcu_quiescent_state();
508 rcu_unregister_thread();
510 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
511 "writer", pthread_self(), (unsigned long)gettid());
512 printf_verbose("info id %lx: nr_add %lu, nr_addexist %lu, nr_del %lu, "
513 "nr_delnoent %lu\n", pthread_self(), nr_add
,
514 nr_addexist
, nr_del
, nr_delnoent
);
515 count
->update_ops
= nr_writes
;
517 count
->add_exist
= nr_addexist
;
518 count
->remove
= nr_del
;
522 static int populate_hash(void)
524 struct cds_lfht_node
*node
, *ret_node
;
529 if (add_unique
&& init_populate
* 10 > rand_pool
) {
530 printf("WARNING: required to populate %lu nodes (-k), but random "
531 "pool is quite small (%lu values) and we are in add_unique (-u) mode. Try with a "
532 "larger random pool (-p option).\n", init_populate
, rand_pool
);
536 while (nr_add
< init_populate
) {
537 node
= malloc(sizeof(struct cds_lfht_node
));
538 cds_lfht_node_init(node
,
539 (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
),
542 ret_node
= cds_lfht_add_unique(test_ht
, node
);
544 cds_lfht_add(test_ht
, node
);
545 if (add_unique
&& ret_node
!= node
) {
555 void show_usage(int argc
, char **argv
)
557 printf("Usage : %s nr_readers nr_writers duration (s)", argv
[0]);
559 printf(" [-r] [-w] (yield reader and/or writer)");
561 printf(" [-d delay] (writer period (us))");
562 printf(" [-c duration] (reader C.S. duration (in loops))");
563 printf(" [-v] (verbose output)");
564 printf(" [-a cpu#] [-a cpu#]... (affinity)");
565 printf(" [-p size] (random key value pool size)");
566 printf(" [-h size] (initial hash table size)");
567 printf(" [-u] Uniquify add.");
568 printf(" [-i] Add only (no removal).");
569 printf(" [-k nr_nodes] Number of nodes to insert initially.");
570 printf(" [-A] Automatically resize hash table.");
574 int main(int argc
, char **argv
)
577 pthread_t
*tid_reader
, *tid_writer
;
579 unsigned long long *count_reader
;
580 struct wr_count
*count_writer
;
581 unsigned long long tot_reads
= 0, tot_writes
= 0,
582 tot_add
= 0, tot_add_exist
= 0, tot_remove
= 0;
583 unsigned long count
, removed
;
585 struct sigaction act
;
589 show_usage(argc
, argv
);
593 err
= sscanf(argv
[1], "%u", &nr_readers
);
595 show_usage(argc
, argv
);
599 err
= sscanf(argv
[2], "%u", &nr_writers
);
601 show_usage(argc
, argv
);
605 err
= sscanf(argv
[3], "%lu", &duration
);
607 show_usage(argc
, argv
);
611 for (i
= 4; i
< argc
; i
++) {
612 if (argv
[i
][0] != '-')
614 switch (argv
[i
][1]) {
617 yield_active
|= YIELD_READ
;
620 yield_active
|= YIELD_WRITE
;
625 show_usage(argc
, argv
);
629 cpu_affinities
[next_aff
++] = a
;
631 printf_verbose("Adding CPU %d affinity\n", a
);
635 show_usage(argc
, argv
);
638 rduration
= atol(argv
[++i
]);
642 show_usage(argc
, argv
);
645 wdelay
= atol(argv
[++i
]);
652 show_usage(argc
, argv
);
655 rand_pool
= atol(argv
[++i
]);
659 show_usage(argc
, argv
);
662 init_hash_size
= atol(argv
[++i
]);
671 init_populate
= atol(argv
[++i
]);
679 /* Check if hash size is power of 2 */
680 if (init_hash_size
&& init_hash_size
& (init_hash_size
- 1)) {
681 printf("Error: Hash table size %lu is not a power of 2.\n",
686 memset(&act
, 0, sizeof(act
));
687 ret
= sigemptyset(&act
.sa_mask
);
689 perror("sigemptyset");
692 act
.sa_handler
= sigusr1_handler
;
693 act
.sa_flags
= SA_RESTART
;
694 ret
= sigaction(SIGUSR1
, &act
, NULL
);
700 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
701 duration
, nr_readers
, nr_writers
);
702 printf_verbose("Writer delay : %lu loops.\n", wdelay
);
703 printf_verbose("Reader duration : %lu loops.\n", rduration
);
704 printf_verbose("Random pool size : %lu.\n", rand_pool
);
705 printf_verbose("Mode:%s%s.\n",
706 add_only
? " add only" : " add/remove",
707 add_unique
? " uniquify" : "");
708 printf_verbose("Initial hash table size: %lu buckets.\n", init_hash_size
);
709 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
710 "main", pthread_self(), (unsigned long)gettid());
712 tid_reader
= malloc(sizeof(*tid_reader
) * nr_readers
);
713 tid_writer
= malloc(sizeof(*tid_writer
) * nr_writers
);
714 count_reader
= malloc(sizeof(*count_reader
) * nr_readers
);
715 count_writer
= malloc(sizeof(*count_writer
) * nr_writers
);
716 test_ht
= cds_lfht_new(test_hash
, test_compare
, 0x42UL
,
718 opt_auto_resize
? CDS_LFHT_AUTO_RESIZE
: 0,
719 call_rcu
, synchronize_rcu
, rcu_read_lock
,
720 rcu_read_unlock
, rcu_thread_offline
,
722 ret
= populate_hash();
724 err
= create_all_cpu_call_rcu_data(0);
729 for (i
= 0; i
< nr_readers
; i
++) {
730 err
= pthread_create(&tid_reader
[i
], NULL
, thr_reader
,
735 for (i
= 0; i
< nr_writers
; i
++) {
736 err
= pthread_create(&tid_writer
[i
], NULL
, thr_writer
,
748 remain
= sleep(remain
);
749 } while (remain
> 0);
753 for (i
= 0; i
< nr_readers
; i
++) {
754 err
= pthread_join(tid_reader
[i
], &tret
);
757 tot_reads
+= count_reader
[i
];
759 for (i
= 0; i
< nr_writers
; i
++) {
760 err
= pthread_join(tid_writer
[i
], &tret
);
763 tot_writes
+= count_writer
[i
].update_ops
;
764 tot_add
+= count_writer
[i
].add
;
765 tot_add_exist
+= count_writer
[i
].add_exist
;
766 tot_remove
+= count_writer
[i
].remove
;
768 printf("Counting nodes... ");
770 cds_lfht_count_nodes(test_ht
, &count
, &removed
);
772 if (count
|| removed
)
773 printf("WARNING: nodes left in the hash table upon destroy: "
774 "%lu nodes + %lu logically removed.\n", count
, removed
);
775 ret
= cds_lfht_destroy(test_ht
);
778 printf_verbose("final delete aborted\n");
780 printf_verbose("final delete success\n");
781 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads
,
783 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
785 "wdelay %6lu rand_pool %12llu nr_reads %12llu nr_writes %12llu nr_ops %12llu "
786 "nr_add %12llu nr_add_fail %12llu nr_remove %12llu nr_leaked %12lld\n",
787 argv
[0], duration
, nr_readers
, rduration
,
788 nr_writers
, wdelay
, rand_pool
, tot_reads
, tot_writes
,
789 tot_reads
+ tot_writes
, tot_add
, tot_add_exist
, tot_remove
,
790 (long long) tot_add
+ init_populate
- tot_remove
- count
);
791 free_all_cpu_call_rcu_data();