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
, no_mutex
;
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)
181 ret
= pthread_mutex_lock(&rcu_copy_mutex
);
183 perror("Error in pthread mutex lock");
188 void rcu_copy_mutex_unlock(void)
194 ret
= pthread_mutex_unlock(&rcu_copy_mutex
);
196 perror("Error in pthread mutex unlock");
203 * Source: http://burtleburtle.net/bob/c/lookup3.c
204 * Originally Public Domain
207 #define rot(x, k) (((x) << (k)) | ((x) >> (32 - (k))))
209 #define mix(a, b, c) \
211 a -= c; a ^= rot(c, 4); c += b; \
212 b -= a; b ^= rot(a, 6); a += c; \
213 c -= b; c ^= rot(b, 8); b += a; \
214 a -= c; a ^= rot(c, 16); c += b; \
215 b -= a; b ^= rot(a, 19); a += c; \
216 c -= b; c ^= rot(b, 4); b += a; \
219 #define final(a, b, c) \
221 c ^= b; c -= rot(b, 14); \
222 a ^= c; a -= rot(c, 11); \
223 b ^= a; b -= rot(a, 25); \
224 c ^= b; c -= rot(b, 16); \
225 a ^= c; a -= rot(c, 4);\
226 b ^= a; b -= rot(a, 14); \
227 c ^= b; c -= rot(b, 24); \
230 static __attribute__((unused
))
232 const uint32_t *k
, /* the key, an array of uint32_t values */
233 size_t length
, /* the length of the key, in uint32_ts */
234 uint32_t initval
) /* the previous hash, or an arbitrary value */
238 /* Set up the internal state */
239 a
= b
= c
= 0xdeadbeef + (((uint32_t) length
) << 2) + initval
;
241 /*----------------------------------------- handle most of the key */
251 /*----------------------------------- handle the last 3 uint32_t's */
252 switch (length
) { /* all the case statements fall through */
257 case 0: /* case 0: nothing left to add */
260 /*---------------------------------------------- report the result */
266 const uint32_t *k
, /* the key, an array of uint32_t values */
267 size_t length
, /* the length of the key, in uint32_ts */
268 uint32_t *pc
, /* IN: seed OUT: primary hash value */
269 uint32_t *pb
) /* IN: more seed OUT: secondary hash value */
273 /* Set up the internal state */
274 a
= b
= c
= 0xdeadbeef + ((uint32_t) (length
<< 2)) + *pc
;
277 /*----------------------------------------- handle most of the key */
287 /*----------------------------------- handle the last 3 uint32_t's */
288 switch (length
) { /* all the case statements fall through */
293 case 0: /* case 0: nothing left to add */
296 /*---------------------------------------------- report the result */
301 #if (CAA_BITS_PER_LONG == 32)
303 unsigned long test_hash(const void *_key
, size_t length
, unsigned long seed
)
305 unsigned long key
= (unsigned long) _key
;
308 assert(length
== sizeof(unsigned long));
309 return hash_u32(&v
, 1, seed
);
313 unsigned long test_hash(const void *_key
, size_t length
, unsigned long seed
)
324 assert(length
== sizeof(unsigned long));
325 v
.v64
= (uint64_t) seed
;
326 key
.v64
= (uint64_t) _key
;
327 hashword2(key
.v32
, 2, &v
.v32
[0], &v
.v32
[1]);
333 unsigned long test_compare(const void *key1
, size_t key1_len
,
334 const void *key2
, size_t key2_len
)
336 if (unlikely(key1_len
!= key2_len
))
338 assert(key1_len
== sizeof(unsigned long));
346 guint
test_hash_fct(const void *key
)
348 return test_hash(key
, sizeof(void *), 0x42);
352 gboolean
test_compare_fct(const void *a
, const void *b
)
354 return !test_compare(a
, sizeof(void *), b
, sizeof(void *));
357 void *thr_reader(void *_count
)
359 unsigned long long *count
= _count
;
362 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
363 "reader", pthread_self(), (unsigned long)gettid());
367 rcu_register_thread();
375 rcu_copy_mutex_lock();
376 node
= g_hash_table_lookup(test_ht
,
377 (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
));
383 if (unlikely(rduration
))
384 loop_sleep(rduration
);
385 rcu_copy_mutex_unlock();
387 if (unlikely(!test_duration_read()))
391 rcu_unregister_thread();
394 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
395 "reader", pthread_self(), (unsigned long)gettid());
396 printf_verbose("readid : %lx, lookupfail %lu, lookupok %lu\n",
397 pthread_self(), lookup_fail
, lookup_ok
);
402 void *thr_writer(void *_count
)
404 void *node
, *ret_node
, *key
;
405 struct wr_count
*count
= _count
;
408 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
409 "writer", pthread_self(), (unsigned long)gettid());
413 rcu_register_thread();
421 if (add_only
|| rand_r(&rand_lookup
) & 1) {
426 rcu_copy_mutex_lock();
427 /* Glib hash table only supports replacement. */
429 add_unique
= 1; /* force add_unique */
430 printf("glib hash tables only supports "
431 "replacing values (and keys in addition) when the key to insert is already "
432 "present. Make sure you compare with the \"add_unique\" (-u) RCU hash table "
433 "behavior, which is the closest match.\n");
435 /* Uniquify behavior: lookup and add if not found */
436 key
= (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
);
437 lookup_node
= g_hash_table_lookup(test_ht
, key
);
438 if (lookup_node
== NULL
) {
439 g_hash_table_insert(test_ht
, key
, node
);
440 rcu_copy_mutex_unlock();
443 rcu_copy_mutex_unlock();
449 rcu_copy_mutex_lock();
450 ret
= g_hash_table_remove(test_ht
,
451 (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
));
452 rcu_copy_mutex_unlock();
459 //if (nr_writes % 100000 == 0) {
460 if (nr_writes
% 1000 == 0) {
462 if (rand_r(&rand_lookup
) & 1) {
463 ht_resize(test_ht
, 1);
465 ht_resize(test_ht
, -1);
471 if (unlikely(!test_duration_write()))
473 if (unlikely(wdelay
))
477 rcu_unregister_thread();
479 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
480 "writer", pthread_self(), (unsigned long)gettid());
481 printf_verbose("info id %lx: nr_add %lu, nr_addexist %lu, nr_del %lu, "
482 "nr_delnoent %lu\n", pthread_self(), nr_add
,
483 nr_addexist
, nr_del
, nr_delnoent
);
484 count
->update_ops
= nr_writes
;
486 count
->add_exist
= nr_addexist
;
487 count
->remove
= nr_del
;
491 static int populate_hash(void)
493 struct cds_lfht_node
*node
, *lookup_node
;
499 if (add_unique
&& init_populate
* 10 > rand_pool
) {
500 printf("WARNING: required to populate %lu nodes (-k), but random"
501 "pool is quite small (%lu values) and we are in add_unique (-u) mode. Try with a "
502 "larger random pool (-p option).\n", init_populate
, rand_pool
);
506 while (nr_add
< init_populate
) {
509 /* Glib hash table only supports replacement. */
511 add_unique
= 1; /* force add_unique */
512 printf("glib hash tables only supports "
513 "replacing values (and keys in addition) when the key to insert is already "
514 "present. Make sure you compare with the \"add_unique\" (-u) RCU hash table "
515 "behavior, which is the closest match.\n");
517 /* Uniquify behavior: lookup and add if not found */
518 key
= (void *)(unsigned long)(rand_r(&rand_lookup
) % rand_pool
);
519 lookup_node
= g_hash_table_lookup(test_ht
, key
);
520 if (lookup_node
== NULL
) {
521 g_hash_table_insert(test_ht
, key
, node
);
533 void count_nodes(gpointer key
, gpointer value
, gpointer user_data
)
535 unsigned long *count
= user_data
;
539 void show_usage(int argc
, char **argv
)
541 printf("Usage : %s nr_readers nr_writers duration (s)", argv
[0]);
543 printf(" [-r] [-w] (yield reader and/or writer)");
545 printf(" [-d delay] (writer period (us))");
546 printf(" [-c duration] (reader C.S. duration (in loops))");
547 printf(" [-v] (verbose output)");
548 printf(" [-a cpu#] [-a cpu#]... (affinity)");
549 printf(" [-p size] (random key value pool size)");
550 printf(" [-h size] (initial hash table size)");
551 printf(" [-u] Uniquify add.");
552 printf(" [-i] Add only (no removal).");
553 printf(" [-k nr_nodes] Number of nodes to insert initially.");
554 printf(" [-l] No mutex.");
558 int main(int argc
, char **argv
)
561 pthread_t
*tid_reader
, *tid_writer
;
563 unsigned long long *count_reader
;
564 struct wr_count
*count_writer
;
565 unsigned long long tot_reads
= 0, tot_writes
= 0,
566 tot_add
= 0, tot_add_exist
= 0, tot_remove
= 0;
571 show_usage(argc
, argv
);
575 err
= sscanf(argv
[1], "%u", &nr_readers
);
577 show_usage(argc
, argv
);
581 err
= sscanf(argv
[2], "%u", &nr_writers
);
583 show_usage(argc
, argv
);
587 err
= sscanf(argv
[3], "%lu", &duration
);
589 show_usage(argc
, argv
);
593 for (i
= 4; i
< argc
; i
++) {
594 if (argv
[i
][0] != '-')
596 switch (argv
[i
][1]) {
599 yield_active
|= YIELD_READ
;
602 yield_active
|= YIELD_WRITE
;
607 show_usage(argc
, argv
);
611 cpu_affinities
[next_aff
++] = a
;
613 printf_verbose("Adding CPU %d affinity\n", a
);
617 show_usage(argc
, argv
);
620 rduration
= atol(argv
[++i
]);
624 show_usage(argc
, argv
);
627 wdelay
= atol(argv
[++i
]);
634 show_usage(argc
, argv
);
637 rand_pool
= atol(argv
[++i
]);
641 show_usage(argc
, argv
);
644 init_hash_size
= atol(argv
[++i
]);
653 init_populate
= atol(argv
[++i
]);
661 /* Check if hash size is power of 2 */
662 if (init_hash_size
&& init_hash_size
& (init_hash_size
- 1)) {
663 printf("Error: Hash table size %lu is not a power of 2.\n",
668 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
669 duration
, nr_readers
, nr_writers
);
670 printf_verbose("Writer delay : %lu loops.\n", wdelay
);
671 printf_verbose("Reader duration : %lu loops.\n", rduration
);
672 printf_verbose("Random pool size : %lu.\n", rand_pool
);
673 printf_verbose("Mode:%s%s.\n",
674 add_only
? " add only" : " add/remove",
675 add_unique
? " uniquify" : "");
676 printf_verbose("Initial hash table size: %lu buckets.\n", init_hash_size
);
677 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
678 "main", pthread_self(), (unsigned long)gettid());
680 tid_reader
= malloc(sizeof(*tid_reader
) * nr_readers
);
681 tid_writer
= malloc(sizeof(*tid_writer
) * nr_writers
);
682 count_reader
= malloc(sizeof(*count_reader
) * nr_readers
);
683 count_writer
= malloc(sizeof(*count_writer
) * nr_writers
);
684 test_ht
= g_hash_table_new_full(test_hash_fct
, test_compare_fct
,
686 ret
= populate_hash();
688 err
= create_all_cpu_call_rcu_data(0);
693 for (i
= 0; i
< nr_readers
; i
++) {
694 err
= pthread_create(&tid_reader
[i
], NULL
, thr_reader
,
699 for (i
= 0; i
< nr_writers
; i
++) {
700 err
= pthread_create(&tid_writer
[i
], NULL
, thr_writer
,
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
;
729 printf("Counting nodes... ");
732 g_hash_table_foreach(test_ht
, count_nodes
, &count
);
735 printf("WARNING: nodes left in the hash table upon destroy: "
736 "%lu nodes.\n", count
);
737 g_hash_table_destroy(test_ht
);
740 printf_verbose("final delete aborted\n");
742 printf_verbose("final delete success\n");
743 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads
,
745 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
747 "wdelay %6lu rand_pool %12llu nr_reads %12llu nr_writes %12llu nr_ops %12llu "
748 "nr_add %12llu nr_add_fail %12llu nr_remove %12llu nr_leaked %12lld\n",
749 argv
[0], duration
, nr_readers
, rduration
,
750 nr_writers
, wdelay
, rand_pool
, tot_reads
, tot_writes
,
751 tot_reads
+ tot_writes
, tot_add
, tot_add_exist
, tot_remove
,
752 (long long) tot_add
+ init_populate
- tot_remove
- count
);