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>
41 #define DEFAULT_HASH_SIZE 32
42 #define DEFAULT_RAND_POOL 1000000
44 /* Make this big enough to include the POWER5+ L3 cacheline size of 256B */
45 #define CACHE_LINE_SIZE 4096
47 /* hardcoded number of CPUs */
50 #if defined(_syscall0)
51 _syscall0(pid_t
, gettid
)
52 #elif defined(__NR_gettid)
53 static inline pid_t
gettid(void)
55 return syscall(__NR_gettid
);
58 #warning "use pid as tid"
59 static inline pid_t
gettid(void)
65 #ifndef DYNAMIC_LINK_TEST
68 #define debug_yield_read()
70 #include <urcu-qsbr.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 GHashTable
*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
);
155 * returns 0 if test should end.
157 static int test_duration_write(void)
162 static int test_duration_read(void)
167 static unsigned long long __thread nr_writes
;
168 static unsigned long long __thread nr_reads
;
170 static unsigned int nr_readers
;
171 static unsigned int nr_writers
;
173 pthread_mutex_t rcu_copy_mutex
= PTHREAD_MUTEX_INITIALIZER
;
175 void rcu_copy_mutex_lock(void)
179 ret
= pthread_mutex_lock(&rcu_copy_mutex
);
181 perror("Error in pthread mutex lock");
186 void rcu_copy_mutex_unlock(void)
190 ret
= pthread_mutex_unlock(&rcu_copy_mutex
);
192 perror("Error in pthread mutex unlock");
199 * Source: http://burtleburtle.net/bob/c/lookup3.c
200 * Originally Public Domain
203 #define rot(x, k) (((x) << (k)) | ((x) >> (32 - (k))))
205 #define mix(a, b, c) \
207 a -= c; a ^= rot(c, 4); c += b; \
208 b -= a; b ^= rot(a, 6); a += c; \
209 c -= b; c ^= rot(b, 8); b += a; \
210 a -= c; a ^= rot(c, 16); c += b; \
211 b -= a; b ^= rot(a, 19); a += c; \
212 c -= b; c ^= rot(b, 4); b += a; \
215 #define final(a, b, c) \
217 c ^= b; c -= rot(b, 14); \
218 a ^= c; a -= rot(c, 11); \
219 b ^= a; b -= rot(a, 25); \
220 c ^= b; c -= rot(b, 16); \
221 a ^= c; a -= rot(c, 4);\
222 b ^= a; b -= rot(a, 14); \
223 c ^= b; c -= rot(b, 24); \
226 static __attribute__((unused
))
228 const uint32_t *k
, /* the key, an array of uint32_t values */
229 size_t length
, /* the length of the key, in uint32_ts */
230 uint32_t initval
) /* the previous hash, or an arbitrary value */
234 /* Set up the internal state */
235 a
= b
= c
= 0xdeadbeef + (((uint32_t) length
) << 2) + initval
;
237 /*----------------------------------------- handle most of the key */
247 /*----------------------------------- handle the last 3 uint32_t's */
248 switch (length
) { /* all the case statements fall through */
253 case 0: /* case 0: nothing left to add */
256 /*---------------------------------------------- report the result */
262 const uint32_t *k
, /* the key, an array of uint32_t values */
263 size_t length
, /* the length of the key, in uint32_ts */
264 uint32_t *pc
, /* IN: seed OUT: primary hash value */
265 uint32_t *pb
) /* IN: more seed OUT: secondary hash value */
269 /* Set up the internal state */
270 a
= b
= c
= 0xdeadbeef + ((uint32_t) (length
<< 2)) + *pc
;
273 /*----------------------------------------- handle most of the key */
283 /*----------------------------------- handle the last 3 uint32_t's */
284 switch (length
) { /* all the case statements fall through */
289 case 0: /* case 0: nothing left to add */
292 /*---------------------------------------------- report the result */
297 #if (CAA_BITS_PER_LONG == 32)
299 unsigned long test_hash(const void *_key
, size_t length
, unsigned long seed
)
301 unsigned long key
= (unsigned long) _key
;
304 assert(length
== sizeof(unsigned long));
305 return hash_u32(&v
, 1, seed
);
309 unsigned long test_hash(const void *_key
, size_t length
, unsigned long seed
)
320 assert(length
== sizeof(unsigned long));
321 v
.v64
= (uint64_t) seed
;
322 key
.v64
= (uint64_t) _key
;
323 hashword2(key
.v32
, 2, &v
.v32
[0], &v
.v32
[1]);
329 unsigned long test_compare(const void *key1
, size_t key1_len
,
330 const void *key2
, size_t key2_len
)
332 if (unlikely(key1_len
!= key2_len
))
334 assert(key1_len
== sizeof(unsigned long));
342 guint
test_hash_fct(const void *key
)
344 return test_hash(key
, sizeof(void *), 0x42);
348 gboolean
test_compare_fct(const void *a
, const void *b
)
350 return !test_compare(a
, sizeof(void *), b
, sizeof(void *));
353 void *thr_reader(void *_count
)
355 unsigned long long *count
= _count
;
358 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
359 "reader", pthread_self(), (unsigned long)gettid());
363 rcu_register_thread();
371 rcu_copy_mutex_lock();
372 node
= g_hash_table_lookup(test_ht
,
373 (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
));
379 if (unlikely(rduration
))
380 loop_sleep(rduration
);
381 rcu_copy_mutex_unlock();
383 if (unlikely(!test_duration_read()))
387 rcu_unregister_thread();
390 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
391 "reader", pthread_self(), (unsigned long)gettid());
392 printf_verbose("readid : %lx, lookupfail %lu, lookupok %lu\n",
393 pthread_self(), lookup_fail
, lookup_ok
);
398 void *thr_writer(void *_count
)
400 void *node
, *ret_node
, *key
;
401 struct wr_count
*count
= _count
;
404 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
405 "writer", pthread_self(), (unsigned long)gettid());
409 rcu_register_thread();
417 if (add_only
|| rand_r(&rand_lookup
) & 1) {
422 rcu_copy_mutex_lock();
423 /* Glib hash table only supports replacement. */
425 add_unique
= 1; /* force add_unique */
426 printf("glib hash tables only supports "
427 "replacing values (and keys in addition) when the key to insert is already "
428 "present. Make sure you compare with the \"add_unique\" (-u) RCU hash table "
429 "behavior, which is the closest match.\n");
431 /* Uniquify behavior: lookup and add if not found */
432 key
= (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
);
433 lookup_node
= g_hash_table_lookup(test_ht
, key
);
434 if (lookup_node
== NULL
) {
435 g_hash_table_insert(test_ht
, key
, node
);
436 rcu_copy_mutex_unlock();
439 rcu_copy_mutex_unlock();
445 rcu_copy_mutex_lock();
446 ret
= g_hash_table_remove(test_ht
,
447 (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
));
448 rcu_copy_mutex_unlock();
455 //if (nr_writes % 100000 == 0) {
456 if (nr_writes
% 1000 == 0) {
458 if (rand_r(&rand_lookup
) & 1) {
459 ht_resize(test_ht
, 1);
461 ht_resize(test_ht
, -1);
467 if (unlikely(!test_duration_write()))
469 if (unlikely(wdelay
))
473 rcu_unregister_thread();
475 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
476 "writer", pthread_self(), (unsigned long)gettid());
477 printf_verbose("info id %lx: nr_add %lu, nr_addexist %lu, nr_del %lu, "
478 "nr_delnoent %lu\n", pthread_self(), nr_add
,
479 nr_addexist
, nr_del
, nr_delnoent
);
480 count
->update_ops
= nr_writes
;
482 count
->add_exist
= nr_addexist
;
483 count
->remove
= nr_del
;
487 static int populate_hash(void)
489 struct cds_lfht_node
*node
, *lookup_node
;
495 if (add_unique
&& init_populate
* 10 > rand_pool
) {
496 printf("WARNING: required to populate %lu nodes (-k), but random"
497 "pool is quite small (%lu values) and we are in add_unique (-u) mode. Try with a "
498 "larger random pool (-p option).\n", init_populate
, rand_pool
);
502 while (nr_add
< init_populate
) {
505 /* Glib hash table only supports replacement. */
507 add_unique
= 1; /* force add_unique */
508 printf("glib hash tables only supports "
509 "replacing values (and keys in addition) when the key to insert is already "
510 "present. Make sure you compare with the \"add_unique\" (-u) RCU hash table "
511 "behavior, which is the closest match.\n");
513 /* Uniquify behavior: lookup and add if not found */
514 key
= (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
);
515 lookup_node
= g_hash_table_lookup(test_ht
, key
);
516 if (lookup_node
== NULL
) {
517 g_hash_table_insert(test_ht
, key
, node
);
529 void count_nodes(gpointer key
, gpointer value
, gpointer user_data
)
531 unsigned long *count
= user_data
;
535 void show_usage(int argc
, char **argv
)
537 printf("Usage : %s nr_readers nr_writers duration (s)", argv
[0]);
539 printf(" [-r] [-w] (yield reader and/or writer)");
541 printf(" [-d delay] (writer period (us))");
542 printf(" [-c duration] (reader C.S. duration (in loops))");
543 printf(" [-v] (verbose output)");
544 printf(" [-a cpu#] [-a cpu#]... (affinity)");
545 printf(" [-p size] (random key value pool size)");
546 printf(" [-h size] (initial hash table size)");
547 printf(" [-u] Uniquify add.");
548 printf(" [-i] Add only (no removal).");
549 printf(" [-k nr_nodes] Number of nodes to insert initially.");
553 int main(int argc
, char **argv
)
556 pthread_t
*tid_reader
, *tid_writer
;
558 unsigned long long *count_reader
;
559 struct wr_count
*count_writer
;
560 unsigned long long tot_reads
= 0, tot_writes
= 0,
561 tot_add
= 0, tot_add_exist
= 0, tot_remove
= 0;
566 show_usage(argc
, argv
);
570 err
= sscanf(argv
[1], "%u", &nr_readers
);
572 show_usage(argc
, argv
);
576 err
= sscanf(argv
[2], "%u", &nr_writers
);
578 show_usage(argc
, argv
);
582 err
= sscanf(argv
[3], "%lu", &duration
);
584 show_usage(argc
, argv
);
588 for (i
= 4; i
< argc
; i
++) {
589 if (argv
[i
][0] != '-')
591 switch (argv
[i
][1]) {
594 yield_active
|= YIELD_READ
;
597 yield_active
|= YIELD_WRITE
;
602 show_usage(argc
, argv
);
606 cpu_affinities
[next_aff
++] = a
;
608 printf_verbose("Adding CPU %d affinity\n", a
);
612 show_usage(argc
, argv
);
615 rduration
= atol(argv
[++i
]);
619 show_usage(argc
, argv
);
622 wdelay
= atol(argv
[++i
]);
629 show_usage(argc
, argv
);
632 rand_pool
= atol(argv
[++i
]);
636 show_usage(argc
, argv
);
639 init_hash_size
= atol(argv
[++i
]);
648 init_populate
= atol(argv
[++i
]);
653 /* Check if hash size is power of 2 */
654 if (init_hash_size
&& init_hash_size
& (init_hash_size
- 1)) {
655 printf("Error: Hash table size %lu is not a power of 2.\n",
660 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
661 duration
, nr_readers
, nr_writers
);
662 printf_verbose("Writer delay : %lu loops.\n", wdelay
);
663 printf_verbose("Reader duration : %lu loops.\n", rduration
);
664 printf_verbose("Random pool size : %lu.\n", rand_pool
);
665 printf_verbose("Mode:%s%s.\n",
666 add_only
? " add only" : " add/remove",
667 add_unique
? " uniquify" : "");
668 printf_verbose("Initial hash table size: %lu buckets.\n", init_hash_size
);
669 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
670 "main", pthread_self(), (unsigned long)gettid());
672 tid_reader
= malloc(sizeof(*tid_reader
) * nr_readers
);
673 tid_writer
= malloc(sizeof(*tid_writer
) * nr_writers
);
674 count_reader
= malloc(sizeof(*count_reader
) * nr_readers
);
675 count_writer
= malloc(sizeof(*count_writer
) * nr_writers
);
676 test_ht
= g_hash_table_new_full(test_hash_fct
, test_compare_fct
,
678 ret
= populate_hash();
680 err
= create_all_cpu_call_rcu_data(0);
685 for (i
= 0; i
< nr_readers
; i
++) {
686 err
= pthread_create(&tid_reader
[i
], NULL
, thr_reader
,
691 for (i
= 0; i
< nr_writers
; i
++) {
692 err
= pthread_create(&tid_writer
[i
], NULL
, thr_writer
,
706 for (i
= 0; i
< nr_readers
; i
++) {
707 err
= pthread_join(tid_reader
[i
], &tret
);
710 tot_reads
+= count_reader
[i
];
712 for (i
= 0; i
< nr_writers
; i
++) {
713 err
= pthread_join(tid_writer
[i
], &tret
);
716 tot_writes
+= count_writer
[i
].update_ops
;
717 tot_add
+= count_writer
[i
].add
;
718 tot_add_exist
+= count_writer
[i
].add_exist
;
719 tot_remove
+= count_writer
[i
].remove
;
721 printf("Counting nodes... ");
724 g_hash_table_foreach(test_ht
, count_nodes
, &count
);
727 printf("WARNING: nodes left in the hash table upon destroy: "
728 "%lu nodes.\n", count
);
729 g_hash_table_destroy(test_ht
);
732 printf_verbose("final delete aborted\n");
734 printf_verbose("final delete success\n");
735 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads
,
737 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
739 "wdelay %6lu rand_pool %12llu nr_reads %12llu nr_writes %12llu nr_ops %12llu "
740 "nr_add %12llu nr_add_fail %12llu nr_remove %12llu nr_leaked %12lld\n",
741 argv
[0], duration
, nr_readers
, rduration
,
742 nr_writers
, wdelay
, rand_pool
, tot_reads
, tot_writes
,
743 tot_reads
+ tot_writes
, tot_add
, tot_add_exist
, tot_remove
,
744 (long long) tot_add
+ init_populate
- tot_remove
- count
);