4 * Userspace RCU library - test program
6 * Copyright February 2009 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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 "../config.h"
29 #include <sys/types.h>
36 #include <urcu/arch.h>
37 #include <urcu/tls-compat.h>
39 #include "thread-id.h"
41 /* hardcoded number of CPUs */
44 #ifndef DYNAMIC_LINK_TEST
47 #define rcu_debug_yield_read()
55 static volatile int test_go
, test_stop
;
57 static unsigned long wdelay
;
59 static struct test_array
*test_rcu_pointer
;
61 static unsigned long duration
;
63 /* read-side C.S. duration, in loops */
64 static unsigned long rduration
;
66 /* write-side C.S. duration, in loops */
67 static unsigned long wduration
;
69 static inline void loop_sleep(unsigned long loops
)
75 static int verbose_mode
;
77 #define printf_verbose(fmt, args...) \
83 static unsigned int cpu_affinities
[NR_CPUS
];
84 static unsigned int next_aff
= 0;
85 static int use_affinity
= 0;
87 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
89 static void set_affinity(void)
91 #if HAVE_SCHED_SETAFFINITY
94 #endif /* HAVE_SCHED_SETAFFINITY */
99 #if HAVE_SCHED_SETAFFINITY
100 ret
= pthread_mutex_lock(&affinity_mutex
);
102 perror("Error in pthread mutex lock");
105 cpu
= cpu_affinities
[next_aff
++];
106 ret
= pthread_mutex_unlock(&affinity_mutex
);
108 perror("Error in pthread mutex unlock");
114 #if SCHED_SETAFFINITY_ARGS == 2
115 sched_setaffinity(0, &mask
);
117 sched_setaffinity(0, sizeof(mask
), &mask
);
119 #endif /* HAVE_SCHED_SETAFFINITY */
123 * returns 0 if test should end.
125 static int test_duration_write(void)
130 static int test_duration_read(void)
135 static DEFINE_URCU_TLS(unsigned long long, nr_writes
);
136 static DEFINE_URCU_TLS(unsigned long long, nr_reads
);
138 static unsigned int nr_readers
;
139 static unsigned int nr_writers
;
141 pthread_mutex_t rcu_copy_mutex
= PTHREAD_MUTEX_INITIALIZER
;
143 void rcu_copy_mutex_lock(void)
146 ret
= pthread_mutex_lock(&rcu_copy_mutex
);
148 perror("Error in pthread mutex lock");
153 void rcu_copy_mutex_unlock(void)
157 ret
= pthread_mutex_unlock(&rcu_copy_mutex
);
159 perror("Error in pthread mutex unlock");
165 * malloc/free are reusing memory areas too quickly, which does not let us
166 * test races appropriately. Use a large circular array for allocations.
167 * ARRAY_SIZE is larger than nr_writers, and we keep the mutex across
168 * both alloc and free, which insures we never run over our tail.
170 #define ARRAY_SIZE (1048576 * nr_writers)
171 #define ARRAY_POISON 0xDEADBEEF
172 static int array_index
;
173 static struct test_array
*test_array
;
175 static struct test_array
*test_array_alloc(void)
177 struct test_array
*ret
;
180 index
= array_index
% ARRAY_SIZE
;
181 assert(test_array
[index
].a
== ARRAY_POISON
||
182 test_array
[index
].a
== 0);
183 ret
= &test_array
[index
];
185 if (array_index
== ARRAY_SIZE
)
190 static void test_array_free(struct test_array
*ptr
)
194 ptr
->a
= ARRAY_POISON
;
197 void *thr_reader(void *_count
)
199 unsigned long long *count
= _count
;
200 struct test_array
*local_ptr
;
202 printf_verbose("thread_begin %s, tid %lu\n",
203 "reader", urcu_get_thread_id());
207 rcu_register_thread();
216 local_ptr
= rcu_dereference(test_rcu_pointer
);
217 rcu_debug_yield_read();
219 assert(local_ptr
->a
== 8);
220 if (caa_unlikely(rduration
))
221 loop_sleep(rduration
);
223 URCU_TLS(nr_reads
)++;
224 if (caa_unlikely(!test_duration_read()))
228 rcu_unregister_thread();
230 *count
= URCU_TLS(nr_reads
);
231 printf_verbose("thread_end %s, tid %lu\n",
232 "reader", urcu_get_thread_id());
237 void *thr_writer(void *_count
)
239 unsigned long long *count
= _count
;
240 struct test_array
*new, *old
;
242 printf_verbose("thread_begin %s, tid %lu\n",
243 "writer", urcu_get_thread_id());
253 rcu_copy_mutex_lock();
254 new = test_array_alloc();
256 old
= test_rcu_pointer
;
257 rcu_assign_pointer(test_rcu_pointer
, new);
258 if (caa_unlikely(wduration
))
259 loop_sleep(wduration
);
263 test_array_free(old
);
264 rcu_copy_mutex_unlock();
265 URCU_TLS(nr_writes
)++;
266 if (caa_unlikely(!test_duration_write()))
268 if (caa_unlikely(wdelay
))
272 printf_verbose("thread_end %s, tid %lu\n",
273 "writer", urcu_get_thread_id());
274 *count
= URCU_TLS(nr_writes
);
278 void show_usage(int argc
, char **argv
)
280 printf("Usage : %s nr_readers nr_writers duration (s) <OPTIONS>\n",
282 printf("OPTIONS:\n");
284 printf(" [-r] [-w] (yield reader and/or writer)\n");
286 printf(" [-d delay] (writer period (us))\n");
287 printf(" [-c duration] (reader C.S. duration (in loops))\n");
288 printf(" [-e duration] (writer C.S. duration (in loops))\n");
289 printf(" [-v] (verbose output)\n");
290 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
294 int main(int argc
, char **argv
)
297 pthread_t
*tid_reader
, *tid_writer
;
299 unsigned long long *count_reader
, *count_writer
;
300 unsigned long long tot_reads
= 0, tot_writes
= 0;
304 show_usage(argc
, argv
);
308 err
= sscanf(argv
[1], "%u", &nr_readers
);
310 show_usage(argc
, argv
);
314 err
= sscanf(argv
[2], "%u", &nr_writers
);
316 show_usage(argc
, argv
);
320 err
= sscanf(argv
[3], "%lu", &duration
);
322 show_usage(argc
, argv
);
326 for (i
= 4; i
< argc
; i
++) {
327 if (argv
[i
][0] != '-')
329 switch (argv
[i
][1]) {
332 rcu_yield_active
|= RCU_YIELD_READ
;
335 rcu_yield_active
|= RCU_YIELD_WRITE
;
340 show_usage(argc
, argv
);
344 cpu_affinities
[next_aff
++] = a
;
346 printf_verbose("Adding CPU %d affinity\n", a
);
350 show_usage(argc
, argv
);
353 rduration
= atol(argv
[++i
]);
357 show_usage(argc
, argv
);
360 wdelay
= atol(argv
[++i
]);
364 show_usage(argc
, argv
);
367 wduration
= atol(argv
[++i
]);
375 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
376 duration
, nr_readers
, nr_writers
);
377 printf_verbose("Writer delay : %lu loops.\n", wdelay
);
378 printf_verbose("Reader duration : %lu loops.\n", rduration
);
379 printf_verbose("thread %-6s, tid %lu\n",
380 "main", urcu_get_thread_id());
382 test_array
= calloc(1, sizeof(*test_array
) * ARRAY_SIZE
);
383 tid_reader
= malloc(sizeof(*tid_reader
) * nr_readers
);
384 tid_writer
= malloc(sizeof(*tid_writer
) * nr_writers
);
385 count_reader
= malloc(sizeof(*count_reader
) * nr_readers
);
386 count_writer
= malloc(sizeof(*count_writer
) * nr_writers
);
390 for (i
= 0; i
< nr_readers
; i
++) {
391 err
= pthread_create(&tid_reader
[i
], NULL
, thr_reader
,
396 for (i
= 0; i
< nr_writers
; i
++) {
397 err
= pthread_create(&tid_writer
[i
], NULL
, thr_writer
,
411 for (i
= 0; i
< nr_readers
; i
++) {
412 err
= pthread_join(tid_reader
[i
], &tret
);
415 tot_reads
+= count_reader
[i
];
417 for (i
= 0; i
< nr_writers
; i
++) {
418 err
= pthread_join(tid_writer
[i
], &tret
);
421 tot_writes
+= count_writer
[i
];
424 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads
,
426 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
428 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
429 argv
[0], duration
, nr_readers
, rduration
, wduration
,
430 nr_writers
, wdelay
, tot_reads
, tot_writes
,
431 tot_reads
+ tot_writes
);
432 test_array_free(test_rcu_pointer
);