1 // SPDX-FileCopyrightText: 2010 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
2 // SPDX-FileCopyrightText: 2010 Paolo Bonzini <pbonzini@redhat.com>
4 // SPDX-License-Identifier: GPL-2.0-or-later
7 * Userspace RCU library - example RCU-based lock-free stack
16 #include <sys/types.h>
22 #include <urcu/arch.h>
23 #include <urcu/assert.h>
24 #include <urcu/tls-compat.h>
25 #include "thread-id.h"
27 /* hardcoded number of CPUs */
30 #ifndef DYNAMIC_LINK_TEST
35 /* Remove deprecation warnings from test build. */
36 #define CDS_LFS_RCU_DEPRECATED
40 static volatile int test_go
, test_stop
;
42 static unsigned long rduration
;
44 static unsigned long duration
;
46 /* read-side C.S. duration, in loops */
47 static unsigned long wdelay
;
49 static inline void loop_sleep(unsigned long loops
)
55 static int verbose_mode
;
57 #define printf_verbose(fmt, args...) \
63 static unsigned int cpu_affinities
[NR_CPUS
];
64 static unsigned int next_aff
= 0;
65 static int use_affinity
= 0;
67 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
69 static void set_affinity(void)
71 #ifdef HAVE_SCHED_SETAFFINITY
74 #endif /* HAVE_SCHED_SETAFFINITY */
79 #ifdef HAVE_SCHED_SETAFFINITY
80 ret
= pthread_mutex_lock(&affinity_mutex
);
82 perror("Error in pthread mutex lock");
85 cpu
= cpu_affinities
[next_aff
++];
86 ret
= pthread_mutex_unlock(&affinity_mutex
);
88 perror("Error in pthread mutex unlock");
94 sched_setaffinity(0, sizeof(mask
), &mask
);
95 #endif /* HAVE_SCHED_SETAFFINITY */
99 * returns 0 if test should end.
101 static int test_duration_dequeue(void)
106 static int test_duration_enqueue(void)
111 static DEFINE_URCU_TLS(unsigned long long, nr_dequeues
);
112 static DEFINE_URCU_TLS(unsigned long long, nr_enqueues
);
114 static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues
);
115 static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues
);
117 static unsigned int nr_enqueuers
;
118 static unsigned int nr_dequeuers
;
121 struct cds_lfs_node_rcu list
;
125 static struct cds_lfs_stack_rcu s
;
128 void *thr_enqueuer(void *_count
)
130 unsigned long long *count
= _count
;
132 printf_verbose("thread_begin %s, tid %lu\n",
133 "enqueuer", urcu_get_thread_id());
137 rcu_register_thread();
145 struct test
*node
= malloc(sizeof(*node
));
148 cds_lfs_node_init_rcu(&node
->list
);
149 /* No rcu read-side is needed for push */
150 cds_lfs_push_rcu(&s
, &node
->list
);
151 URCU_TLS(nr_successful_enqueues
)++;
153 if (caa_unlikely(wdelay
))
156 URCU_TLS(nr_enqueues
)++;
157 if (caa_unlikely(!test_duration_enqueue()))
161 rcu_unregister_thread();
163 count
[0] = URCU_TLS(nr_enqueues
);
164 count
[1] = URCU_TLS(nr_successful_enqueues
);
165 printf_verbose("enqueuer thread_end, tid %lu, "
166 "enqueues %llu successful_enqueues %llu\n",
167 urcu_get_thread_id(),
168 URCU_TLS(nr_enqueues
),
169 URCU_TLS(nr_successful_enqueues
));
175 void free_node_cb(struct rcu_head
*head
)
178 caa_container_of(head
, struct test
, rcu
);
183 void *thr_dequeuer(void *_count
)
185 unsigned long long *count
= _count
;
187 printf_verbose("thread_begin %s, tid %lu\n",
188 "dequeuer", urcu_get_thread_id());
192 rcu_register_thread();
200 struct cds_lfs_node_rcu
*snode
;
203 snode
= cds_lfs_pop_rcu(&s
);
208 node
= caa_container_of(snode
, struct test
, list
);
209 call_rcu(&node
->rcu
, free_node_cb
);
210 URCU_TLS(nr_successful_dequeues
)++;
212 URCU_TLS(nr_dequeues
)++;
213 if (caa_unlikely(!test_duration_dequeue()))
215 if (caa_unlikely(rduration
))
216 loop_sleep(rduration
);
219 rcu_unregister_thread();
221 printf_verbose("dequeuer thread_end, tid %lu, "
222 "dequeues %llu, successful_dequeues %llu\n",
223 urcu_get_thread_id(),
224 URCU_TLS(nr_dequeues
),
225 URCU_TLS(nr_successful_dequeues
));
226 count
[0] = URCU_TLS(nr_dequeues
);
227 count
[1] = URCU_TLS(nr_successful_dequeues
);
232 void test_end(unsigned long long *nr_dequeues_l
)
234 struct cds_lfs_node_rcu
*snode
;
237 snode
= cds_lfs_pop_rcu(&s
);
241 node
= caa_container_of(snode
, struct test
, list
);
249 void show_usage(char **argv
)
251 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
253 printf("OPTIONS:\n");
254 printf(" [-d delay] (enqueuer period (in loops))\n");
255 printf(" [-c duration] (dequeuer period (in loops))\n");
256 printf(" [-v] (verbose output)\n");
257 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
261 int main(int argc
, char **argv
)
264 pthread_t
*tid_enqueuer
, *tid_dequeuer
;
266 unsigned long long *count_enqueuer
, *count_dequeuer
;
267 unsigned long long tot_enqueues
= 0, tot_dequeues
= 0;
268 unsigned long long tot_successful_enqueues
= 0,
269 tot_successful_dequeues
= 0;
270 unsigned long long end_dequeues
= 0;
279 err
= sscanf(argv
[1], "%u", &nr_dequeuers
);
285 err
= sscanf(argv
[2], "%u", &nr_enqueuers
);
291 err
= sscanf(argv
[3], "%lu", &duration
);
297 for (i
= 4; i
< argc
; i
++) {
298 if (argv
[i
][0] != '-')
300 switch (argv
[i
][1]) {
307 cpu_affinities
[next_aff
++] = a
;
309 printf_verbose("Adding CPU %d affinity\n", a
);
316 rduration
= atol(argv
[++i
]);
323 wdelay
= atol(argv
[++i
]);
331 printf_verbose("running test for %lu seconds, %u enqueuers, "
333 duration
, nr_enqueuers
, nr_dequeuers
);
334 printf_verbose("Writer delay : %lu loops.\n", rduration
);
335 printf_verbose("Reader duration : %lu loops.\n", wdelay
);
336 printf_verbose("thread %-6s, tid %lu\n",
337 "main", urcu_get_thread_id());
339 tid_enqueuer
= calloc(nr_enqueuers
, sizeof(*tid_enqueuer
));
340 tid_dequeuer
= calloc(nr_dequeuers
, sizeof(*tid_dequeuer
));
341 count_enqueuer
= calloc(nr_enqueuers
, 2 * sizeof(*count_enqueuer
));
342 count_dequeuer
= calloc(nr_dequeuers
, 2 * sizeof(*count_dequeuer
));
343 cds_lfs_init_rcu(&s
);
344 err
= create_all_cpu_call_rcu_data(0);
346 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
351 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
352 err
= pthread_create(&tid_enqueuer
[i_thr
], NULL
, thr_enqueuer
,
353 &count_enqueuer
[2 * i_thr
]);
357 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
358 err
= pthread_create(&tid_dequeuer
[i_thr
], NULL
, thr_dequeuer
,
359 &count_dequeuer
[2 * i_thr
]);
368 for (i_thr
= 0; i_thr
< duration
; i_thr
++) {
371 fwrite(".", sizeof(char), 1, stdout
);
378 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
379 err
= pthread_join(tid_enqueuer
[i_thr
], &tret
);
382 tot_enqueues
+= count_enqueuer
[2 * i_thr
];
383 tot_successful_enqueues
+= count_enqueuer
[2 * i_thr
+ 1];
385 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
386 err
= pthread_join(tid_dequeuer
[i_thr
], &tret
);
389 tot_dequeues
+= count_dequeuer
[2 * i_thr
];
390 tot_successful_dequeues
+= count_dequeuer
[2 * i_thr
+ 1];
393 test_end(&end_dequeues
);
395 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
396 tot_enqueues
, tot_dequeues
);
397 printf_verbose("total number of successful enqueues : %llu, "
398 "successful dequeues %llu\n",
399 tot_successful_enqueues
, tot_successful_dequeues
);
400 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
402 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
403 "successful enqueues %12llu successful dequeues %12llu "
404 "end_dequeues %llu nr_ops %12llu\n",
405 argv
[0], duration
, nr_enqueuers
, wdelay
,
406 nr_dequeuers
, rduration
, tot_enqueues
, tot_dequeues
,
407 tot_successful_enqueues
,
408 tot_successful_dequeues
, end_dequeues
,
409 tot_enqueues
+ tot_dequeues
);
410 if (tot_successful_enqueues
!= tot_successful_dequeues
+ end_dequeues
)
411 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
412 "succ. dequeues + end dequeues %llu.\n",
413 tot_successful_enqueues
,
414 tot_successful_dequeues
+ end_dequeues
);
416 free_all_cpu_call_rcu_data();
417 free(count_enqueuer
);
418 free(count_dequeuer
);