1 // SPDX-FileCopyrightText: 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
3 // SPDX-License-Identifier: GPL-2.0-or-later
6 * Userspace RCU library - test program (with batch reclamation)
13 #include <sys/types.h>
19 #include <urcu/arch.h>
20 #include <urcu/assert.h>
21 #include <urcu/tls-compat.h>
22 #include "thread-id.h"
23 #include "../common/debug-yield.h"
25 /* hardcoded number of CPUs */
28 #ifndef DYNAMIC_LINK_TEST
37 static volatile int test_go
, test_stop
;
39 static unsigned long wdelay
;
41 static struct test_array
*test_rcu_pointer
;
43 static long reclaim_batch
= 1;
45 struct reclaim_queue
{
46 void **queue
; /* Beginning of queue */
47 void **head
; /* Insert position */
50 static struct reclaim_queue
*pending_reclaims
;
52 static unsigned long duration
;
54 /* read-side C.S. duration, in loops */
55 static unsigned long rduration
;
57 /* write-side C.S. duration, in loops */
58 static unsigned long wduration
;
60 static inline void loop_sleep(unsigned long loops
)
66 static int verbose_mode
;
68 #define printf_verbose(fmt, args...) \
74 static unsigned int cpu_affinities
[NR_CPUS
];
75 static unsigned int next_aff
= 0;
76 static int use_affinity
= 0;
78 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
80 static void set_affinity(void)
82 #ifdef HAVE_SCHED_SETAFFINITY
85 #endif /* HAVE_SCHED_SETAFFINITY */
90 #ifdef HAVE_SCHED_SETAFFINITY
91 ret
= pthread_mutex_lock(&affinity_mutex
);
93 perror("Error in pthread mutex lock");
96 cpu
= cpu_affinities
[next_aff
++];
97 ret
= pthread_mutex_unlock(&affinity_mutex
);
99 perror("Error in pthread mutex unlock");
105 sched_setaffinity(0, sizeof(mask
), &mask
);
106 #endif /* HAVE_SCHED_SETAFFINITY */
110 * returns 0 if test should end.
112 static int test_duration_write(void)
117 static int test_duration_read(void)
122 static DEFINE_URCU_TLS(unsigned long long, nr_writes
);
123 static DEFINE_URCU_TLS(unsigned long long, nr_reads
);
126 unsigned long long __attribute__((aligned(CAA_CACHE_LINE_SIZE
))) *tot_nr_writes
;
128 static unsigned int nr_readers
;
129 static unsigned int nr_writers
;
131 pthread_mutex_t rcu_copy_mutex
= PTHREAD_MUTEX_INITIALIZER
;
134 void *thr_reader(void *_count
)
136 unsigned long long *count
= _count
;
137 struct test_array
*local_ptr
;
139 printf_verbose("thread_begin %s, tid %lu\n",
140 "reader", urcu_get_thread_id());
144 rcu_register_thread();
153 local_ptr
= rcu_dereference(test_rcu_pointer
);
154 rcu_debug_yield_read();
156 urcu_posix_assert(local_ptr
->a
== 8);
157 if (caa_unlikely(rduration
))
158 loop_sleep(rduration
);
160 URCU_TLS(nr_reads
)++;
161 if (caa_unlikely(!test_duration_read()))
165 rcu_unregister_thread();
167 *count
= URCU_TLS(nr_reads
);
168 printf_verbose("thread_end %s, tid %lu\n",
169 "reader", urcu_get_thread_id());
174 static void rcu_gc_clear_queue(unsigned long wtidx
)
178 /* Wait for Q.S and empty queue */
181 for (p
= pending_reclaims
[wtidx
].queue
;
182 p
< pending_reclaims
[wtidx
].head
; p
++) {
185 ((struct test_array
*)*p
)->a
= 0;
188 pending_reclaims
[wtidx
].head
= pending_reclaims
[wtidx
].queue
;
191 /* Using per-thread queue */
192 static void rcu_gc_reclaim(unsigned long wtidx
, void *old
)
195 *pending_reclaims
[wtidx
].head
= old
;
196 pending_reclaims
[wtidx
].head
++;
198 if (caa_likely(pending_reclaims
[wtidx
].head
- pending_reclaims
[wtidx
].queue
202 rcu_gc_clear_queue(wtidx
);
206 void *thr_writer(void *data
)
208 unsigned long wtidx
= (unsigned long)data
;
210 struct test_array
*old
= NULL
;
212 struct test_array
*new, *old
;
215 printf_verbose("thread_begin %s, tid %lu\n",
216 "writer", urcu_get_thread_id());
226 #ifndef TEST_LOCAL_GC
227 new = malloc(sizeof(*new));
229 old
= rcu_xchg_pointer(&test_rcu_pointer
, new);
231 if (caa_unlikely(wduration
))
232 loop_sleep(wduration
);
233 rcu_gc_reclaim(wtidx
, old
);
234 URCU_TLS(nr_writes
)++;
235 if (caa_unlikely(!test_duration_write()))
237 if (caa_unlikely(wdelay
))
241 printf_verbose("thread_end %s, tid %lu\n",
242 "writer", urcu_get_thread_id());
243 tot_nr_writes
[wtidx
] = URCU_TLS(nr_writes
);
248 void show_usage(char **argv
)
250 printf("Usage : %s nr_readers nr_writers duration (s) <OPTIONS>\n",
252 printf("OPTIONS:\n");
253 printf(" [-r] [-w] (yield reader and/or writer)\n");
254 printf(" [-d delay] (writer period (us))\n");
255 printf(" [-c duration] (reader C.S. duration (in loops))\n");
256 printf(" [-e duration] (writer C.S. duration (in loops))\n");
257 printf(" [-v] (verbose output)\n");
258 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
262 int main(int argc
, char **argv
)
265 pthread_t
*tid_reader
, *tid_writer
;
267 unsigned long long *count_reader
;
268 unsigned long long tot_reads
= 0, tot_writes
= 0;
277 err
= sscanf(argv
[1], "%u", &nr_readers
);
283 err
= sscanf(argv
[2], "%u", &nr_writers
);
289 err
= sscanf(argv
[3], "%lu", &duration
);
295 for (i
= 4; i
< argc
; i
++) {
296 if (argv
[i
][0] != '-')
298 switch (argv
[i
][1]) {
300 rcu_debug_yield_enable(RCU_YIELD_READ
);
303 rcu_debug_yield_enable(RCU_YIELD_WRITE
);
311 cpu_affinities
[next_aff
++] = a
;
313 printf_verbose("Adding CPU %d affinity\n", a
);
320 reclaim_batch
= atol(argv
[++i
]);
327 rduration
= atol(argv
[++i
]);
334 wdelay
= atol(argv
[++i
]);
341 wduration
= atol(argv
[++i
]);
349 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
350 duration
, nr_readers
, nr_writers
);
351 printf_verbose("Writer delay : %lu loops.\n", wdelay
);
352 printf_verbose("Reader duration : %lu loops.\n", rduration
);
353 printf_verbose("thread %-6s, tid %lu\n",
354 "main", urcu_get_thread_id());
356 tid_reader
= calloc(nr_readers
, sizeof(*tid_reader
));
357 tid_writer
= calloc(nr_writers
, sizeof(*tid_writer
));
358 count_reader
= calloc(nr_readers
, sizeof(*count_reader
));
359 tot_nr_writes
= calloc(nr_writers
, sizeof(*tot_nr_writes
));
360 pending_reclaims
= calloc(nr_writers
, sizeof(*pending_reclaims
));
362 if (reclaim_batch
* sizeof(*pending_reclaims
[0].queue
)
363 < CAA_CACHE_LINE_SIZE
)
364 for (i_thr
= 0; i_thr
< nr_writers
; i_thr
++)
365 pending_reclaims
[i_thr
].queue
= calloc(1, CAA_CACHE_LINE_SIZE
);
367 for (i_thr
= 0; i_thr
< nr_writers
; i_thr
++)
368 pending_reclaims
[i_thr
].queue
= calloc(reclaim_batch
,
369 sizeof(*pending_reclaims
[i_thr
].queue
));
370 for (i_thr
= 0; i_thr
< nr_writers
; i_thr
++)
371 pending_reclaims
[i_thr
].head
= pending_reclaims
[i_thr
].queue
;
375 for (i_thr
= 0; i_thr
< nr_readers
; i_thr
++) {
376 err
= pthread_create(&tid_reader
[i_thr
], NULL
, thr_reader
,
377 &count_reader
[i_thr
]);
381 for (i_thr
= 0; i_thr
< nr_writers
; i_thr
++) {
382 err
= pthread_create(&tid_writer
[i_thr
], NULL
, thr_writer
,
383 (void *)(long)i_thr
);
396 for (i_thr
= 0; i_thr
< nr_readers
; i_thr
++) {
397 err
= pthread_join(tid_reader
[i_thr
], &tret
);
400 tot_reads
+= count_reader
[i_thr
];
402 for (i_thr
= 0; i_thr
< nr_writers
; i_thr
++) {
403 err
= pthread_join(tid_writer
[i_thr
], &tret
);
406 tot_writes
+= tot_nr_writes
[i_thr
];
407 rcu_gc_clear_queue(i_thr
);
410 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads
,
412 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
414 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu "
416 argv
[0], duration
, nr_readers
, rduration
, wduration
,
417 nr_writers
, wdelay
, tot_reads
, tot_writes
,
418 tot_reads
+ tot_writes
, reclaim_batch
);
425 for (i_thr
= 0; i_thr
< nr_writers
; i_thr
++)
426 free(pending_reclaims
[i_thr
].queue
);
427 free(pending_reclaims
);