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
34 /* Remove deprecation warnings from test build. */
35 #define CDS_WFQ_DEPRECATED
38 #include <urcu/wfqueue.h>
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
;
120 static struct cds_wfq_queue q
;
123 void *thr_enqueuer(void *_count
)
125 unsigned long long *count
= _count
;
127 printf_verbose("thread_begin %s, tid %lu\n",
128 "enqueuer", urcu_get_thread_id());
138 struct cds_wfq_node
*node
= malloc(sizeof(*node
));
141 cds_wfq_node_init(node
);
142 cds_wfq_enqueue(&q
, node
);
143 URCU_TLS(nr_successful_enqueues
)++;
145 if (caa_unlikely(wdelay
))
148 URCU_TLS(nr_enqueues
)++;
149 if (caa_unlikely(!test_duration_enqueue()))
153 count
[0] = URCU_TLS(nr_enqueues
);
154 count
[1] = URCU_TLS(nr_successful_enqueues
);
155 printf_verbose("enqueuer thread_end, tid %lu, "
156 "enqueues %llu successful_enqueues %llu\n",
157 urcu_get_thread_id(),
158 URCU_TLS(nr_enqueues
),
159 URCU_TLS(nr_successful_enqueues
));
165 void *thr_dequeuer(void *_count
)
167 unsigned long long *count
= _count
;
169 printf_verbose("thread_begin %s, tid %lu\n",
170 "dequeuer", urcu_get_thread_id());
180 struct cds_wfq_node
*node
= cds_wfq_dequeue_blocking(&q
);
184 URCU_TLS(nr_successful_dequeues
)++;
187 URCU_TLS(nr_dequeues
)++;
188 if (caa_unlikely(!test_duration_dequeue()))
190 if (caa_unlikely(rduration
))
191 loop_sleep(rduration
);
194 printf_verbose("dequeuer thread_end, tid %lu, "
195 "dequeues %llu, successful_dequeues %llu\n",
196 urcu_get_thread_id(),
197 URCU_TLS(nr_dequeues
),
198 URCU_TLS(nr_successful_dequeues
));
199 count
[0] = URCU_TLS(nr_dequeues
);
200 count
[1] = URCU_TLS(nr_successful_dequeues
);
205 void test_end(unsigned long long *nr_dequeues_l
)
207 struct cds_wfq_node
*node
;
210 node
= cds_wfq_dequeue_blocking(&q
);
219 void show_usage(char **argv
)
221 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
223 printf("OPTIONS:\n");
224 printf(" [-d delay] (enqueuer period (in loops))\n");
225 printf(" [-c duration] (dequeuer period (in loops))\n");
226 printf(" [-v] (verbose output)\n");
227 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
231 int main(int argc
, char **argv
)
234 pthread_t
*tid_enqueuer
, *tid_dequeuer
;
236 unsigned long long *count_enqueuer
, *count_dequeuer
;
237 unsigned long long tot_enqueues
= 0, tot_dequeues
= 0;
238 unsigned long long tot_successful_enqueues
= 0,
239 tot_successful_dequeues
= 0;
240 unsigned long long end_dequeues
= 0;
249 err
= sscanf(argv
[1], "%u", &nr_dequeuers
);
255 err
= sscanf(argv
[2], "%u", &nr_enqueuers
);
261 err
= sscanf(argv
[3], "%lu", &duration
);
267 for (i
= 4; i
< argc
; i
++) {
268 if (argv
[i
][0] != '-')
270 switch (argv
[i
][1]) {
277 cpu_affinities
[next_aff
++] = a
;
279 printf_verbose("Adding CPU %d affinity\n", a
);
286 rduration
= atol(argv
[++i
]);
293 wdelay
= atol(argv
[++i
]);
301 printf_verbose("running test for %lu seconds, %u enqueuers, "
303 duration
, nr_enqueuers
, nr_dequeuers
);
304 printf_verbose("Writer delay : %lu loops.\n", rduration
);
305 printf_verbose("Reader duration : %lu loops.\n", wdelay
);
306 printf_verbose("thread %-6s, tid %lu\n",
307 "main", urcu_get_thread_id());
309 tid_enqueuer
= calloc(nr_enqueuers
, sizeof(*tid_enqueuer
));
310 tid_dequeuer
= calloc(nr_dequeuers
, sizeof(*tid_dequeuer
));
311 count_enqueuer
= calloc(nr_enqueuers
, 2 * sizeof(*count_enqueuer
));
312 count_dequeuer
= calloc(nr_dequeuers
, 2 * sizeof(*count_dequeuer
));
317 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
318 err
= pthread_create(&tid_enqueuer
[i_thr
], NULL
, thr_enqueuer
,
319 &count_enqueuer
[2 * i_thr
]);
323 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
324 err
= pthread_create(&tid_dequeuer
[i_thr
], NULL
, thr_dequeuer
,
325 &count_dequeuer
[2 * i_thr
]);
334 for (i_thr
= 0; i_thr
< duration
; i_thr
++) {
337 fwrite(".", sizeof(char), 1, stdout
);
344 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
345 err
= pthread_join(tid_enqueuer
[i_thr
], &tret
);
348 tot_enqueues
+= count_enqueuer
[2 * i_thr
];
349 tot_successful_enqueues
+= count_enqueuer
[2 * i_thr
+ 1];
351 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
352 err
= pthread_join(tid_dequeuer
[i_thr
], &tret
);
355 tot_dequeues
+= count_dequeuer
[2 * i_thr
];
356 tot_successful_dequeues
+= count_dequeuer
[2 * i_thr
+ 1];
359 test_end(&end_dequeues
);
361 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
362 tot_enqueues
, tot_dequeues
);
363 printf_verbose("total number of successful enqueues : %llu, "
364 "successful dequeues %llu\n",
365 tot_successful_enqueues
, tot_successful_dequeues
);
366 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
368 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
369 "successful enqueues %12llu successful dequeues %12llu "
370 "end_dequeues %llu nr_ops %12llu\n",
371 argv
[0], duration
, nr_enqueuers
, wdelay
,
372 nr_dequeuers
, rduration
, tot_enqueues
, tot_dequeues
,
373 tot_successful_enqueues
,
374 tot_successful_dequeues
, end_dequeues
,
375 tot_enqueues
+ tot_dequeues
);
376 if (tot_successful_enqueues
!= tot_successful_dequeues
+ end_dequeues
)
377 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
378 "succ. dequeues + end dequeues %llu.\n",
379 tot_successful_enqueues
,
380 tot_successful_dequeues
+ end_dequeues
);
383 free(count_enqueuer
);
384 free(count_dequeuer
);