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>
34 #include <sys/syscall.h>
38 #include <urcu/arch.h>
40 /* hardcoded number of CPUs */
43 #if defined(_syscall0)
44 _syscall0(pid_t
, gettid
)
45 #elif defined(__NR_gettid)
46 static inline pid_t
gettid(void)
48 return syscall(__NR_gettid
);
51 #warning "use pid as tid"
52 static inline pid_t
gettid(void)
58 #ifndef DYNAMIC_LINK_TEST
61 #define debug_yield_read()
63 #include "urcu-qsbr.h"
69 static volatile int test_go
, test_stop
;
71 static unsigned long wdelay
;
73 static struct test_array
*test_rcu_pointer
;
75 static unsigned long duration
;
77 /* read-side C.S. duration, in loops */
78 static unsigned long rduration
;
80 /* write-side C.S. duration, in loops */
81 static unsigned long wduration
;
83 static inline void loop_sleep(unsigned long l
)
89 static int verbose_mode
;
91 #define printf_verbose(fmt, args...) \
97 static unsigned int cpu_affinities
[NR_CPUS
];
98 static unsigned int next_aff
= 0;
99 static int use_affinity
= 0;
101 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
103 #ifndef HAVE_CPU_SET_T
104 typedef unsigned long cpu_set_t
;
105 # define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
106 # define CPU_SET(cpu, cpuset) do { *(cpuset) |= (1UL << (cpu)); } while(0)
109 static void set_affinity(void)
118 #if HAVE_SCHED_SETAFFINITY
119 ret
= pthread_mutex_lock(&affinity_mutex
);
121 perror("Error in pthread mutex lock");
124 cpu
= cpu_affinities
[next_aff
++];
125 ret
= pthread_mutex_unlock(&affinity_mutex
);
127 perror("Error in pthread mutex unlock");
132 #if SCHED_SETAFFINITY_ARGS == 2
133 sched_setaffinity(0, &mask
);
135 sched_setaffinity(0, sizeof(mask
), &mask
);
137 #endif /* HAVE_SCHED_SETAFFINITY */
141 * returns 0 if test should end.
143 static int test_duration_write(void)
148 static int test_duration_read(void)
153 static unsigned long long __thread nr_writes
;
154 static unsigned long long __thread nr_reads
;
156 static unsigned int nr_readers
;
157 static unsigned int nr_writers
;
159 pthread_mutex_t rcu_copy_mutex
= PTHREAD_MUTEX_INITIALIZER
;
161 void rcu_copy_mutex_lock(void)
164 ret
= pthread_mutex_lock(&rcu_copy_mutex
);
166 perror("Error in pthread mutex lock");
171 void rcu_copy_mutex_unlock(void)
175 ret
= pthread_mutex_unlock(&rcu_copy_mutex
);
177 perror("Error in pthread mutex unlock");
183 * malloc/free are reusing memory areas too quickly, which does not let us
184 * test races appropriately. Use a large circular array for allocations.
185 * ARRAY_SIZE is larger than nr_writers, which insures we never run over our tail.
187 #define ARRAY_SIZE (1048576 * nr_writers)
188 #define ARRAY_POISON 0xDEADBEEF
189 static int array_index
;
190 static struct test_array
*test_array
;
192 static struct test_array
*test_array_alloc(void)
194 struct test_array
*ret
;
197 rcu_copy_mutex_lock();
198 index
= array_index
% ARRAY_SIZE
;
199 assert(test_array
[index
].a
== ARRAY_POISON
||
200 test_array
[index
].a
== 0);
201 ret
= &test_array
[index
];
203 if (array_index
== ARRAY_SIZE
)
205 rcu_copy_mutex_unlock();
209 static void test_array_free(struct test_array
*ptr
)
213 rcu_copy_mutex_lock();
214 ptr
->a
= ARRAY_POISON
;
215 rcu_copy_mutex_unlock();
218 void *thr_reader(void *_count
)
220 unsigned long long *count
= _count
;
221 struct test_array
*local_ptr
;
223 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
224 "reader", pthread_self(), (unsigned long)gettid());
228 rcu_register_thread();
237 local_ptr
= rcu_dereference(test_rcu_pointer
);
240 assert(local_ptr
->a
== 8);
241 if (unlikely(rduration
))
242 loop_sleep(rduration
);
245 /* QS each 1024 reads */
246 if (unlikely((nr_reads
& ((1 << 10) - 1)) == 0))
247 rcu_quiescent_state();
248 if (unlikely(!test_duration_read()))
252 rcu_unregister_thread();
254 /* test extra thread registration */
255 rcu_register_thread();
256 rcu_unregister_thread();
259 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
260 "reader", pthread_self(), (unsigned long)gettid());
265 void *thr_writer(void *_count
)
267 unsigned long long *count
= _count
;
268 struct test_array
*new, *old
;
270 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
271 "writer", pthread_self(), (unsigned long)gettid());
281 new = test_array_alloc();
283 old
= rcu_xchg_pointer(&test_rcu_pointer
, new);
284 if (unlikely(wduration
))
285 loop_sleep(wduration
);
287 /* can be done after unlock */
290 test_array_free(old
);
292 if (unlikely(!test_duration_write()))
294 if (unlikely(wdelay
))
298 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
299 "writer", pthread_self(), (unsigned long)gettid());
304 void show_usage(int argc
, char **argv
)
306 printf("Usage : %s nr_readers nr_writers duration (s)", argv
[0]);
308 printf(" [-r] [-w] (yield reader and/or writer)");
310 printf(" [-d delay] (writer period (us))");
311 printf(" [-c duration] (reader C.S. duration (in loops))");
312 printf(" [-e duration] (writer C.S. duration (in loops))");
313 printf(" [-v] (verbose output)");
314 printf(" [-a cpu#] [-a cpu#]... (affinity)");
318 int main(int argc
, char **argv
)
321 pthread_t
*tid_reader
, *tid_writer
;
323 unsigned long long *count_reader
, *count_writer
;
324 unsigned long long tot_reads
= 0, tot_writes
= 0;
328 show_usage(argc
, argv
);
332 err
= sscanf(argv
[1], "%u", &nr_readers
);
334 show_usage(argc
, argv
);
338 err
= sscanf(argv
[2], "%u", &nr_writers
);
340 show_usage(argc
, argv
);
344 err
= sscanf(argv
[3], "%lu", &duration
);
346 show_usage(argc
, argv
);
350 for (i
= 4; i
< argc
; i
++) {
351 if (argv
[i
][0] != '-')
353 switch (argv
[i
][1]) {
356 yield_active
|= YIELD_READ
;
359 yield_active
|= YIELD_WRITE
;
364 show_usage(argc
, argv
);
368 cpu_affinities
[next_aff
++] = a
;
370 printf_verbose("Adding CPU %d affinity\n", a
);
374 show_usage(argc
, argv
);
377 rduration
= atol(argv
[++i
]);
381 show_usage(argc
, argv
);
384 wdelay
= atol(argv
[++i
]);
388 show_usage(argc
, argv
);
391 wduration
= atol(argv
[++i
]);
399 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
400 duration
, nr_readers
, nr_writers
);
401 printf_verbose("Writer delay : %lu loops.\n", wdelay
);
402 printf_verbose("Reader duration : %lu loops.\n", rduration
);
403 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
404 "main", pthread_self(), (unsigned long)gettid());
406 test_array
= calloc(1, sizeof(*test_array
) * ARRAY_SIZE
);
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
);
414 for (i
= 0; i
< nr_readers
; i
++) {
415 err
= pthread_create(&tid_reader
[i
], NULL
, thr_reader
,
420 for (i
= 0; i
< nr_writers
; i
++) {
421 err
= pthread_create(&tid_writer
[i
], NULL
, thr_writer
,
435 for (i
= 0; i
< nr_readers
; i
++) {
436 err
= pthread_join(tid_reader
[i
], &tret
);
439 tot_reads
+= count_reader
[i
];
441 for (i
= 0; i
< nr_writers
; i
++) {
442 err
= pthread_join(tid_writer
[i
], &tret
);
445 tot_writes
+= count_writer
[i
];
448 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads
,
450 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
452 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
453 argv
[0], duration
, nr_readers
, rduration
, wduration
,
454 nr_writers
, wdelay
, tot_reads
, tot_writes
,
455 tot_reads
+ tot_writes
);
456 test_array_free(test_rcu_pointer
);