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>
33 #include <sys/syscall.h>
37 #include <urcu/arch.h>
39 /* hardcoded number of CPUs */
42 #if defined(_syscall0)
43 _syscall0(pid_t
, gettid
)
44 #elif defined(__NR_gettid)
45 static inline pid_t
gettid(void)
47 return syscall(__NR_gettid
);
50 #warning "use pid as tid"
51 static inline pid_t
gettid(void)
57 #ifndef DYNAMIC_LINK_TEST
60 #define debug_yield_read()
62 #include "urcu-qsbr.h"
68 static volatile int test_go
, test_stop
;
70 static unsigned long wdelay
;
72 static struct test_array
*test_rcu_pointer
;
74 static unsigned long duration
;
76 /* read-side C.S. duration, in loops */
77 static unsigned long rduration
;
79 static inline void loop_sleep(unsigned long l
)
85 static int verbose_mode
;
87 #define printf_verbose(fmt, args...) \
93 static unsigned int cpu_affinities
[NR_CPUS
];
94 static unsigned int next_aff
= 0;
95 static int use_affinity
= 0;
97 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
99 static void set_affinity(void)
108 ret
= pthread_mutex_lock(&affinity_mutex
);
110 perror("Error in pthread mutex lock");
113 cpu
= cpu_affinities
[next_aff
++];
114 ret
= pthread_mutex_unlock(&affinity_mutex
);
116 perror("Error in pthread mutex unlock");
121 sched_setaffinity(0, sizeof(mask
), &mask
);
125 * returns 0 if test should end.
127 static int test_duration_write(void)
132 static int test_duration_read(void)
137 static unsigned long long __thread nr_writes
;
138 static unsigned long long __thread nr_reads
;
140 static unsigned int nr_readers
;
141 static unsigned int nr_writers
;
143 pthread_mutex_t rcu_copy_mutex
= PTHREAD_MUTEX_INITIALIZER
;
145 void rcu_copy_mutex_lock(void)
148 ret
= pthread_mutex_lock(&rcu_copy_mutex
);
150 perror("Error in pthread mutex lock");
155 void rcu_copy_mutex_unlock(void)
159 ret
= pthread_mutex_unlock(&rcu_copy_mutex
);
161 perror("Error in pthread mutex unlock");
167 * malloc/free are reusing memory areas too quickly, which does not let us
168 * test races appropriately. Use a large circular array for allocations.
169 * ARRAY_SIZE is larger than nr_writers, which insures we never run over our tail.
171 #define ARRAY_SIZE (1048576 * nr_writers)
172 #define ARRAY_POISON 0xDEADBEEF
173 static int array_index
;
174 static struct test_array
*test_array
;
176 static struct test_array
*test_array_alloc(void)
178 struct test_array
*ret
;
181 rcu_copy_mutex_lock();
182 index
= array_index
% ARRAY_SIZE
;
183 assert(test_array
[index
].a
== ARRAY_POISON
||
184 test_array
[index
].a
== 0);
185 ret
= &test_array
[index
];
187 if (array_index
== ARRAY_SIZE
)
189 rcu_copy_mutex_unlock();
193 static void test_array_free(struct test_array
*ptr
)
197 rcu_copy_mutex_lock();
198 ptr
->a
= ARRAY_POISON
;
199 rcu_copy_mutex_unlock();
202 void *thr_reader(void *_count
)
204 unsigned long long *count
= _count
;
205 struct test_array
*local_ptr
;
207 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
208 "reader", pthread_self(), (unsigned long)gettid());
212 rcu_register_thread();
221 local_ptr
= rcu_dereference(test_rcu_pointer
);
224 assert(local_ptr
->a
== 8);
225 if (unlikely(rduration
))
226 loop_sleep(rduration
);
229 /* QS each 1024 reads */
230 if (unlikely((nr_reads
& ((1 << 10) - 1)) == 0))
231 rcu_quiescent_state();
232 if (unlikely(!test_duration_read()))
236 rcu_unregister_thread();
239 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
240 "reader", pthread_self(), (unsigned long)gettid());
245 void *thr_writer(void *_count
)
247 unsigned long long *count
= _count
;
248 struct test_array
*new, *old
;
250 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
251 "writer", pthread_self(), (unsigned long)gettid());
261 new = test_array_alloc();
263 old
= rcu_xchg_pointer(&test_rcu_pointer
, new);
265 /* can be done after unlock */
268 test_array_free(old
);
270 if (unlikely(!test_duration_write()))
272 if (unlikely(wdelay
))
276 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
277 "writer", pthread_self(), (unsigned long)gettid());
282 void show_usage(int argc
, char **argv
)
284 printf("Usage : %s nr_readers nr_writers duration (s)", argv
[0]);
286 printf(" [-r] [-w] (yield reader and/or writer)");
288 printf(" [-d delay] (writer period (us))");
289 printf(" [-c duration] (reader C.S. duration (in loops))");
290 printf(" [-v] (verbose output)");
291 printf(" [-a cpu#] [-a cpu#]... (affinity)");
295 int main(int argc
, char **argv
)
298 pthread_t
*tid_reader
, *tid_writer
;
300 unsigned long long *count_reader
, *count_writer
;
301 unsigned long long tot_reads
= 0, tot_writes
= 0;
305 show_usage(argc
, argv
);
309 err
= sscanf(argv
[1], "%u", &nr_readers
);
311 show_usage(argc
, argv
);
315 err
= sscanf(argv
[2], "%u", &nr_writers
);
317 show_usage(argc
, argv
);
321 err
= sscanf(argv
[3], "%lu", &duration
);
323 show_usage(argc
, argv
);
327 for (i
= 4; i
< argc
; i
++) {
328 if (argv
[i
][0] != '-')
330 switch (argv
[i
][1]) {
333 yield_active
|= YIELD_READ
;
336 yield_active
|= YIELD_WRITE
;
341 show_usage(argc
, argv
);
345 cpu_affinities
[next_aff
++] = a
;
347 printf_verbose("Adding CPU %d affinity\n", a
);
351 show_usage(argc
, argv
);
354 rduration
= atol(argv
[++i
]);
358 show_usage(argc
, argv
);
361 wdelay
= atol(argv
[++i
]);
369 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
370 duration
, nr_readers
, nr_writers
);
371 printf_verbose("Writer delay : %lu loops.\n", wdelay
);
372 printf_verbose("Reader duration : %lu loops.\n", rduration
);
373 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
374 "main", pthread_self(), (unsigned long)gettid());
376 test_array
= malloc(sizeof(*test_array
) * ARRAY_SIZE
);
377 tid_reader
= malloc(sizeof(*tid_reader
) * nr_readers
);
378 tid_writer
= malloc(sizeof(*tid_writer
) * nr_writers
);
379 count_reader
= malloc(sizeof(*count_reader
) * nr_readers
);
380 count_writer
= malloc(sizeof(*count_writer
) * nr_writers
);
384 for (i
= 0; i
< nr_readers
; i
++) {
385 err
= pthread_create(&tid_reader
[i
], NULL
, thr_reader
,
390 for (i
= 0; i
< nr_writers
; i
++) {
391 err
= pthread_create(&tid_writer
[i
], NULL
, thr_writer
,
405 for (i
= 0; i
< nr_readers
; i
++) {
406 err
= pthread_join(tid_reader
[i
], &tret
);
409 tot_reads
+= count_reader
[i
];
411 for (i
= 0; i
< nr_writers
; i
++) {
412 err
= pthread_join(tid_writer
[i
], &tret
);
415 tot_writes
+= count_writer
[i
];
418 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads
,
420 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
422 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
423 argv
[0], duration
, nr_readers
, rduration
,
424 nr_writers
, wdelay
, tot_reads
, tot_writes
,
425 tot_reads
+ tot_writes
);
426 test_array_free(test_rcu_pointer
);