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 queue
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
36 static volatile int test_go
, test_stop
;
38 static unsigned long rduration
;
40 static unsigned long duration
;
42 /* read-side C.S. duration, in loops */
43 static unsigned long wdelay
;
45 static inline void loop_sleep(unsigned long loops
)
51 static int verbose_mode
;
53 #define printf_verbose(fmt, args...) \
59 static unsigned int cpu_affinities
[NR_CPUS
];
60 static unsigned int next_aff
= 0;
61 static int use_affinity
= 0;
63 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
65 static void set_affinity(void)
67 #ifdef HAVE_SCHED_SETAFFINITY
70 #endif /* HAVE_SCHED_SETAFFINITY */
75 #ifdef HAVE_SCHED_SETAFFINITY
76 ret
= pthread_mutex_lock(&affinity_mutex
);
78 perror("Error in pthread mutex lock");
81 cpu
= cpu_affinities
[next_aff
++];
82 ret
= pthread_mutex_unlock(&affinity_mutex
);
84 perror("Error in pthread mutex unlock");
90 sched_setaffinity(0, sizeof(mask
), &mask
);
91 #endif /* HAVE_SCHED_SETAFFINITY */
95 * returns 0 if test should end.
97 static int test_duration_dequeue(void)
102 static int test_duration_enqueue(void)
107 static DEFINE_URCU_TLS(unsigned long long, nr_dequeues
);
108 static DEFINE_URCU_TLS(unsigned long long, nr_enqueues
);
110 static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues
);
111 static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues
);
113 static unsigned int nr_enqueuers
;
114 static unsigned int nr_dequeuers
;
117 struct cds_lfq_node_rcu list
;
121 static struct cds_lfq_queue_rcu q
;
124 void *thr_enqueuer(void *_count
)
126 unsigned long long *count
= _count
;
128 printf_verbose("thread_begin %s, tid %lu\n",
129 "enqueuer", urcu_get_thread_id());
133 rcu_register_thread();
141 struct test
*node
= malloc(sizeof(*node
));
144 cds_lfq_node_init_rcu(&node
->list
);
146 cds_lfq_enqueue_rcu(&q
, &node
->list
);
148 URCU_TLS(nr_successful_enqueues
)++;
150 if (caa_unlikely(wdelay
))
153 URCU_TLS(nr_enqueues
)++;
154 if (caa_unlikely(!test_duration_enqueue()))
158 rcu_unregister_thread();
160 count
[0] = URCU_TLS(nr_enqueues
);
161 count
[1] = URCU_TLS(nr_successful_enqueues
);
162 printf_verbose("enqueuer thread_end, tid %lu, "
163 "enqueues %llu successful_enqueues %llu\n",
164 urcu_get_thread_id(),
165 URCU_TLS(nr_enqueues
),
166 URCU_TLS(nr_successful_enqueues
));
172 void free_node_cb(struct rcu_head
*head
)
175 caa_container_of(head
, struct test
, rcu
);
180 void *thr_dequeuer(void *_count
)
182 unsigned long long *count
= _count
;
184 printf_verbose("thread_begin %s, tid %lu\n",
185 "dequeuer", urcu_get_thread_id());
189 rcu_register_thread();
197 struct cds_lfq_node_rcu
*qnode
;
200 qnode
= cds_lfq_dequeue_rcu(&q
);
206 node
= caa_container_of(qnode
, struct test
, list
);
207 call_rcu(&node
->rcu
, free_node_cb
);
208 URCU_TLS(nr_successful_dequeues
)++;
211 URCU_TLS(nr_dequeues
)++;
212 if (caa_unlikely(!test_duration_dequeue()))
214 if (caa_unlikely(rduration
))
215 loop_sleep(rduration
);
218 rcu_unregister_thread();
219 printf_verbose("dequeuer thread_end, tid %lu, "
220 "dequeues %llu, successful_dequeues %llu\n",
221 urcu_get_thread_id(),
222 URCU_TLS(nr_dequeues
),
223 URCU_TLS(nr_successful_dequeues
));
224 count
[0] = URCU_TLS(nr_dequeues
);
225 count
[1] = URCU_TLS(nr_successful_dequeues
);
230 void test_end(unsigned long long *nr_dequeues_l
)
232 struct cds_lfq_node_rcu
*snode
;
235 snode
= cds_lfq_dequeue_rcu(&q
);
239 node
= caa_container_of(snode
, struct test
, list
);
240 free(node
); /* no more concurrent access */
247 void show_usage(char **argv
)
249 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
251 printf("OPTIONS:\n");
252 printf(" [-d delay] (enqueuer period (in loops))\n");
253 printf(" [-c duration] (dequeuer period (in loops))\n");
254 printf(" [-v] (verbose output)\n");
255 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
259 int main(int argc
, char **argv
)
262 pthread_t
*tid_enqueuer
, *tid_dequeuer
;
264 unsigned long long *count_enqueuer
, *count_dequeuer
;
265 unsigned long long tot_enqueues
= 0, tot_dequeues
= 0;
266 unsigned long long tot_successful_enqueues
= 0,
267 tot_successful_dequeues
= 0;
268 unsigned long long end_dequeues
= 0;
277 err
= sscanf(argv
[1], "%u", &nr_dequeuers
);
283 err
= sscanf(argv
[2], "%u", &nr_enqueuers
);
289 err
= sscanf(argv
[3], "%lu", &duration
);
295 for (i
= 4; i
< argc
; i
++) {
296 if (argv
[i
][0] != '-')
298 switch (argv
[i
][1]) {
305 cpu_affinities
[next_aff
++] = a
;
307 printf_verbose("Adding CPU %d affinity\n", a
);
314 rduration
= atol(argv
[++i
]);
321 wdelay
= atol(argv
[++i
]);
329 printf_verbose("running test for %lu seconds, %u enqueuers, "
331 duration
, nr_enqueuers
, nr_dequeuers
);
332 printf_verbose("Writer delay : %lu loops.\n", rduration
);
333 printf_verbose("Reader duration : %lu loops.\n", wdelay
);
334 printf_verbose("thread %-6s, tid %lu\n",
335 "main", urcu_get_thread_id());
337 tid_enqueuer
= calloc(nr_enqueuers
, sizeof(*tid_enqueuer
));
338 tid_dequeuer
= calloc(nr_dequeuers
, sizeof(*tid_dequeuer
));
339 count_enqueuer
= calloc(nr_enqueuers
, 2 * sizeof(*count_enqueuer
));
340 count_dequeuer
= calloc(nr_dequeuers
, 2 * sizeof(*count_dequeuer
));
341 cds_lfq_init_rcu(&q
, call_rcu
);
342 err
= create_all_cpu_call_rcu_data(0);
344 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
349 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
350 err
= pthread_create(&tid_enqueuer
[i_thr
], NULL
, thr_enqueuer
,
351 &count_enqueuer
[2 * i_thr
]);
355 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
356 err
= pthread_create(&tid_dequeuer
[i_thr
], NULL
, thr_dequeuer
,
357 &count_dequeuer
[2 * i_thr
]);
366 for (i_thr
= 0; i_thr
< duration
; i_thr
++) {
369 fwrite(".", sizeof(char), 1, stdout
);
376 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
377 err
= pthread_join(tid_enqueuer
[i_thr
], &tret
);
380 tot_enqueues
+= count_enqueuer
[2 * i_thr
];
381 tot_successful_enqueues
+= count_enqueuer
[2 * i_thr
+ 1];
383 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
384 err
= pthread_join(tid_dequeuer
[i_thr
], &tret
);
387 tot_dequeues
+= count_dequeuer
[2 * i_thr
];
388 tot_successful_dequeues
+= count_dequeuer
[2 * i_thr
+ 1];
391 test_end(&end_dequeues
);
392 err
= cds_lfq_destroy_rcu(&q
);
393 urcu_posix_assert(!err
);
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
);