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_range.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
;
56 unsigned int key_bits
= 32;
62 unsigned int cpu_affinities
[NR_CPUS
];
63 unsigned int next_aff
= 0;
66 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
68 DEFINE_URCU_TLS(unsigned long long, nr_writes
);
69 DEFINE_URCU_TLS(unsigned long long, nr_reads
);
71 unsigned int nr_readers
;
72 unsigned int nr_writers
;
74 static unsigned int add_ratio
= 50, range_max_len
= 0;
75 static uint64_t key_mul
= 1ULL;
77 static int add_unique
, add_replace
;
79 static pthread_mutex_t rcu_copy_mutex
= PTHREAD_MUTEX_INITIALIZER
;
81 static int leak_detection
;
82 static unsigned long test_nodes_allocated
, test_nodes_freed
;
84 void set_affinity(void)
93 #if HAVE_SCHED_SETAFFINITY
94 ret
= pthread_mutex_lock(&affinity_mutex
);
96 perror("Error in pthread mutex lock");
99 cpu
= cpu_affinities
[next_aff
++];
100 ret
= pthread_mutex_unlock(&affinity_mutex
);
102 perror("Error in pthread mutex unlock");
107 #if SCHED_SETAFFINITY_ARGS == 2
108 sched_setaffinity(0, &mask
);
110 sched_setaffinity(0, sizeof(mask
), &mask
);
112 #endif /* HAVE_SCHED_SETAFFINITY */
115 void rcu_copy_mutex_lock(void)
118 ret
= pthread_mutex_lock(&rcu_copy_mutex
);
120 perror("Error in pthread mutex lock");
125 void rcu_copy_mutex_unlock(void)
129 ret
= pthread_mutex_unlock(&rcu_copy_mutex
);
131 perror("Error in pthread mutex unlock");
136 void show_usage(int argc
, char **argv
)
138 printf("Usage : %s nr_readers nr_writers duration (s)\n", argv
[0]);
140 printf(" [-r] [-w] (yield reader and/or writer)\n");
142 printf(" [-d delay] (writer period (us))\n");
143 printf(" [-c duration] (reader C.S. duration (in loops))\n");
144 printf(" [-v] (verbose output)\n");
145 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
146 printf(" [-u] Add unique keys.\n");
147 printf(" [-s] Replace existing keys.\n");
148 printf(" [not -u nor -s] Add entries (supports redundant keys).\n");
149 printf(" [-r ratio] Add ratio (in %% of add+removal).\n");
150 printf(" [-k] Populate init nodes.\n");
151 printf(" [-R offset] Lookup pool offset.\n");
152 printf(" [-S offset] Write pool offset.\n");
153 printf(" [-T offset] Init pool offset.\n");
154 printf(" [-M size] Lookup pool size.\n");
155 printf(" [-N size] Write pool size.\n");
156 printf(" [-O size] Init pool size.\n");
157 printf(" [-V] Validate lookups of init values (use with filled init pool, same lookup range, with different write range).\n");
158 printf(" [-t] Do sanity test.\n");
159 printf(" [-B] Key bits for multithread test (default: 32).\n");
160 printf(" [-m factor] Key multiplication factor.\n");
161 printf(" [-l] Memory leak detection.\n");
162 printf(" [-L len] Range max len.\n");
166 enum urcu_ja_addremove
{
170 }; /* 1: add, -1 remove, 0: random */
172 static enum urcu_ja_addremove addremove
; /* 1: add, -1 remove, 0: random */
175 void test_ja_rw_sigusr1_handler(int signo
)
179 printf("Add/Remove: random.\n");
180 addremove
= AR_RANDOM
;
183 printf("Add/Remove: remove only.\n");
184 addremove
= AR_REMOVE
;
187 printf("Add/Remove: add only.\n");
194 void *test_ja_rw_thr_reader(void *_count
)
196 unsigned long long *count
= _count
;
197 struct cds_ja_range
*range
;
200 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
201 "reader", pthread_self(), (unsigned long) gettid());
205 rcu_register_thread();
215 /* note: only looking up ulong keys */
216 key
= ((unsigned long) rand_r(&URCU_TLS(rand_lookup
)) % lookup_pool_size
) + lookup_pool_offset
;
218 range
= cds_ja_range_lookup(test_ja
, key
);
220 if (validate_lookup
) {
221 printf("[ERROR] Lookup cannot find initial node.\n");
224 URCU_TLS(lookup_fail
)++;
226 range
= cds_ja_range_lock(range
);
228 if (validate_lookup
) {
229 printf("[ERROR] Lookup cannot find initial node.\n");
233 URCU_TLS(lookup_ok
)++;
234 cds_ja_range_unlock(range
);
237 rcu_debug_yield_read();
238 if (caa_unlikely(rduration
))
239 loop_sleep(rduration
);
241 URCU_TLS(nr_reads
)++;
242 if (caa_unlikely(!test_duration_read()))
244 if (caa_unlikely((URCU_TLS(nr_reads
) & ((1 << 10) - 1)) == 0))
245 rcu_quiescent_state();
248 rcu_unregister_thread();
250 *count
= URCU_TLS(nr_reads
);
251 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
252 "reader", pthread_self(), (unsigned long) gettid());
253 printf_verbose("readid : %lx, lookupfail %lu, lookupok %lu\n",
254 pthread_self(), URCU_TLS(lookup_fail
),
255 URCU_TLS(lookup_ok
));
262 return ((unsigned int) rand_r(&URCU_TLS(rand_lookup
)) % 100) < add_ratio
;
266 void *test_ja_rw_thr_writer(void *_count
)
268 struct wr_count
*count
= _count
;
271 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
272 "writer", pthread_self(), (unsigned long) gettid());
276 rcu_register_thread();
284 if ((addremove
== AR_ADD
)
285 || (addremove
== AR_RANDOM
&& is_add())) {
286 struct cds_ja_range
*range
;
287 uint64_t start
, end
, tmp
;
289 /* note: only inserting ulong keys */
290 start
= ((unsigned long) rand_r(&URCU_TLS(rand_lookup
)) % write_pool_size
) + write_pool_offset
;
291 end
= ((unsigned long) rand_r(&URCU_TLS(rand_lookup
)) % write_pool_size
) + write_pool_offset
;
299 if (end
- start
> range_max_len
) {
300 end
= start
+ range_max_len
;
303 ret
= cds_ja_range_add(test_ja
, start
, end
, NULL
);
305 if (ret
== -EEXIST
) {
306 URCU_TLS(nr_addexist
)++;
315 struct cds_ja_range
*range
;
319 /* note: only deleting ulong keys */
320 key
= ((unsigned long) rand_r(&URCU_TLS(rand_lookup
)) % write_pool_size
) + write_pool_offset
;
325 range
= cds_ja_range_lookup(test_ja
, key
);
327 ret
= cds_ja_range_del(test_ja
, range
);
331 URCU_TLS(nr_delnoent
)++;
334 URCU_TLS(nr_delnoent
)++;
339 URCU_TLS(nr_writes
)++;
340 if (caa_unlikely(!test_duration_write()))
342 if (caa_unlikely(wdelay
))
344 if (caa_unlikely((URCU_TLS(nr_writes
) & ((1 << 10) - 1)) == 0))
345 rcu_quiescent_state();
348 rcu_unregister_thread();
350 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
351 "writer", pthread_self(), (unsigned long) gettid());
352 printf_verbose("info id %lx: nr_add %lu, nr_addexist %lu, nr_del %lu, "
353 "nr_delnoent %lu\n", pthread_self(), URCU_TLS(nr_add
),
354 URCU_TLS(nr_addexist
), URCU_TLS(nr_del
),
355 URCU_TLS(nr_delnoent
));
356 count
->update_ops
= URCU_TLS(nr_writes
);
357 count
->add
= URCU_TLS(nr_add
);
358 count
->add_exist
= URCU_TLS(nr_addexist
);
359 count
->remove
= URCU_TLS(nr_del
);
364 int do_mt_populate_ja(void)
372 printf("Starting rw test\n");
374 for (iter
= init_pool_offset
; iter
< init_pool_offset
+ init_pool_size
; iter
++) {
375 struct cds_ja_range
*range
;
378 /* note: only inserting ulong keys */
379 key
= (unsigned long) iter
;
382 ret
= cds_ja_range_add(test_ja
, key
, key
, NULL
);
384 URCU_TLS(nr_writes
)++;
387 fprintf(stderr
, "Error (%d) adding range %" PRIu64
"\n",
398 pthread_t
*tid_reader
, *tid_writer
;
401 unsigned long long *count_reader
;
402 struct wr_count
*count_writer
;
403 unsigned long long tot_reads
= 0, tot_writes
= 0,
404 tot_add
= 0, tot_add_exist
= 0, tot_remove
= 0;
407 tid_reader
= malloc(sizeof(*tid_reader
) * nr_readers
);
408 tid_writer
= malloc(sizeof(*tid_writer
) * nr_writers
);
409 count_reader
= malloc(sizeof(*count_reader
) * nr_readers
);
410 count_writer
= malloc(sizeof(*count_writer
) * nr_writers
);
412 printf("Allocating %u-bit Judy Array for ranges\n",
414 test_ja
= cds_ja_range_new(key_bits
);
416 printf("Error allocating judy array.\n");
425 for (i
= 0; i
< nr_readers
; i
++) {
426 err
= pthread_create(&tid_reader
[i
],
427 NULL
, test_ja_rw_thr_reader
,
432 for (i
= 0; i
< nr_writers
; i
++) {
433 err
= pthread_create(&tid_writer
[i
],
434 NULL
, test_ja_rw_thr_writer
,
444 rcu_thread_offline_qsbr();
448 remain
= sleep(remain
);
449 } while (remain
> 0);
453 for (i
= 0; i
< nr_readers
; i
++) {
454 err
= pthread_join(tid_reader
[i
], &tret
);
457 tot_reads
+= count_reader
[i
];
459 for (i
= 0; i
< nr_writers
; i
++) {
460 err
= pthread_join(tid_writer
[i
], &tret
);
463 tot_writes
+= count_writer
[i
].update_ops
;
464 tot_add
+= count_writer
[i
].add
;
465 tot_add_exist
+= count_writer
[i
].add_exist
;
466 tot_remove
+= count_writer
[i
].remove
;
468 rcu_thread_online_qsbr();
470 ret
= cds_ja_range_validate(test_ja
);
473 ret
= cds_ja_range_destroy(test_ja
, NULL
);
475 fprintf(stderr
, "Error destroying judy array\n");
488 int main(int argc
, char **argv
)
490 int i
, j
, a
, ret
, err
;
492 struct sigaction act
;
495 show_usage(argc
, argv
);
499 err
= sscanf(argv
[1], "%u", &nr_readers
);
501 show_usage(argc
, argv
);
505 err
= sscanf(argv
[2], "%u", &nr_writers
);
507 show_usage(argc
, argv
);
511 err
= sscanf(argv
[3], "%lu", &duration
);
513 show_usage(argc
, argv
);
517 for (i
= 4; i
< argc
; i
++) {
518 if (argv
[i
][0] != '-')
520 switch (argv
[i
][1]) {
523 yield_active
|= YIELD_READ
;
526 yield_active
|= YIELD_WRITE
;
531 show_usage(argc
, argv
);
535 cpu_affinities
[next_aff
++] = a
;
537 printf_verbose("Adding CPU %d affinity\n", a
);
541 show_usage(argc
, argv
);
544 rduration
= atol(argv
[++i
]);
548 show_usage(argc
, argv
);
551 wdelay
= atol(argv
[++i
]);
557 add_ratio
= atoi(argv
[++i
]);
563 lookup_pool_offset
= atol(argv
[++i
]);
566 write_pool_offset
= atol(argv
[++i
]);
569 init_pool_offset
= atol(argv
[++i
]);
572 lookup_pool_size
= atol(argv
[++i
]);
575 write_pool_size
= atol(argv
[++i
]);
578 init_pool_size
= atol(argv
[++i
]);
587 key_bits
= atol(argv
[++i
]);
590 key_mul
= atoll(argv
[++i
]);
602 range_max_len
= atol(argv
[++i
]);
607 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
608 duration
, nr_readers
, nr_writers
);
609 printf_verbose("Writer delay : %lu loops.\n", wdelay
);
610 printf_verbose("Reader duration : %lu loops.\n", rduration
);
611 printf_verbose("Add ratio: %u%%.\n", add_ratio
);
612 printf_verbose("Mode:%s%s.\n",
614 add_unique
? " uniquify" : ( add_replace
? " replace" : " insert"));
615 printf_verbose("Key multiplication factor: %" PRIu64
".\n", key_mul
);
616 printf_verbose("Init pool size offset %lu size %lu.\n",
617 init_pool_offset
, init_pool_size
);
618 printf_verbose("Lookup pool size offset %lu size %lu.\n",
619 lookup_pool_offset
, lookup_pool_size
);
620 printf_verbose("Update pool size offset %lu size %lu.\n",
621 write_pool_offset
, write_pool_size
);
622 printf_verbose("Range max len: %lu.\n",
625 printf_verbose("Validating lookups.\n");
627 printf_verbose("Memory leak dection activated.\n");
628 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
629 "main", pthread_self(), (unsigned long)gettid());
631 memset(&act
, 0, sizeof(act
));
632 ret
= sigemptyset(&act
.sa_mask
);
634 perror("sigemptyset");
637 act
.sa_handler
= test_ja_rw_sigusr1_handler
;
638 act
.sa_flags
= SA_RESTART
;
639 ret
= sigaction(SIGUSR1
, &act
, NULL
);
645 err
= create_all_cpu_call_rcu_data(0);
647 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
650 rcu_register_thread();
654 /* Wait for in-flight call_rcu free to complete for leak detection */
657 rcu_unregister_thread();
658 free_all_cpu_call_rcu_data();
661 printf("Test ended with error: %d\n", ret
);