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 unsigned long rduration
;
42 static unsigned long duration
;
44 /* read-side C.S. duration, in loops */
45 static unsigned long wdelay
;
47 static inline void loop_sleep(unsigned long loops
)
53 static int verbose_mode
;
55 #define printf_verbose(fmt, args...) \
61 static unsigned int cpu_affinities
[NR_CPUS
];
62 static unsigned int next_aff
= 0;
63 static int use_affinity
= 0;
65 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
67 static void set_affinity(void)
69 #ifdef HAVE_SCHED_SETAFFINITY
72 #endif /* HAVE_SCHED_SETAFFINITY */
77 #ifdef HAVE_SCHED_SETAFFINITY
78 ret
= pthread_mutex_lock(&affinity_mutex
);
80 perror("Error in pthread mutex lock");
83 cpu
= cpu_affinities
[next_aff
++];
84 ret
= pthread_mutex_unlock(&affinity_mutex
);
86 perror("Error in pthread mutex unlock");
92 sched_setaffinity(0, sizeof(mask
), &mask
);
93 #endif /* HAVE_SCHED_SETAFFINITY */
97 * returns 0 if test should end.
99 static int test_duration_dequeue(void)
101 return test_duration_read();
104 static int test_duration_enqueue(void)
106 return test_duration_write();
109 static DEFINE_URCU_TLS(unsigned long long, nr_dequeues
);
110 static DEFINE_URCU_TLS(unsigned long long, nr_enqueues
);
112 static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues
);
113 static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues
);
115 static unsigned int nr_enqueuers
;
116 static unsigned int nr_dequeuers
;
118 static struct cds_wfq_queue q
;
121 void *thr_enqueuer(void *_count
)
123 unsigned long long *count
= _count
;
125 printf_verbose("thread_begin %s, tid %lu\n",
126 "enqueuer", urcu_get_thread_id());
133 struct cds_wfq_node
*node
= malloc(sizeof(*node
));
136 cds_wfq_node_init(node
);
137 cds_wfq_enqueue(&q
, node
);
138 URCU_TLS(nr_successful_enqueues
)++;
140 if (caa_unlikely(wdelay
))
143 URCU_TLS(nr_enqueues
)++;
144 if (caa_unlikely(!test_duration_enqueue()))
148 count
[0] = URCU_TLS(nr_enqueues
);
149 count
[1] = URCU_TLS(nr_successful_enqueues
);
150 printf_verbose("enqueuer thread_end, tid %lu, "
151 "enqueues %llu successful_enqueues %llu\n",
152 urcu_get_thread_id(),
153 URCU_TLS(nr_enqueues
),
154 URCU_TLS(nr_successful_enqueues
));
160 void *thr_dequeuer(void *_count
)
162 unsigned long long *count
= _count
;
164 printf_verbose("thread_begin %s, tid %lu\n",
165 "dequeuer", urcu_get_thread_id());
172 struct cds_wfq_node
*node
= cds_wfq_dequeue_blocking(&q
);
176 URCU_TLS(nr_successful_dequeues
)++;
179 URCU_TLS(nr_dequeues
)++;
180 if (caa_unlikely(!test_duration_dequeue()))
182 if (caa_unlikely(rduration
))
183 loop_sleep(rduration
);
186 printf_verbose("dequeuer thread_end, tid %lu, "
187 "dequeues %llu, successful_dequeues %llu\n",
188 urcu_get_thread_id(),
189 URCU_TLS(nr_dequeues
),
190 URCU_TLS(nr_successful_dequeues
));
191 count
[0] = URCU_TLS(nr_dequeues
);
192 count
[1] = URCU_TLS(nr_successful_dequeues
);
197 void test_end(unsigned long long *nr_dequeues_l
)
199 struct cds_wfq_node
*node
;
202 node
= cds_wfq_dequeue_blocking(&q
);
211 void show_usage(char **argv
)
213 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
215 printf("OPTIONS:\n");
216 printf(" [-d delay] (enqueuer period (in loops))\n");
217 printf(" [-c duration] (dequeuer period (in loops))\n");
218 printf(" [-v] (verbose output)\n");
219 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
223 int main(int argc
, char **argv
)
226 pthread_t
*tid_enqueuer
, *tid_dequeuer
;
228 unsigned long long *count_enqueuer
, *count_dequeuer
;
229 unsigned long long tot_enqueues
= 0, tot_dequeues
= 0;
230 unsigned long long tot_successful_enqueues
= 0,
231 tot_successful_dequeues
= 0;
232 unsigned long long end_dequeues
= 0;
241 err
= sscanf(argv
[1], "%u", &nr_dequeuers
);
247 err
= sscanf(argv
[2], "%u", &nr_enqueuers
);
253 err
= sscanf(argv
[3], "%lu", &duration
);
259 for (i
= 4; i
< argc
; i
++) {
260 if (argv
[i
][0] != '-')
262 switch (argv
[i
][1]) {
269 cpu_affinities
[next_aff
++] = a
;
271 printf_verbose("Adding CPU %d affinity\n", a
);
278 rduration
= atol(argv
[++i
]);
285 wdelay
= atol(argv
[++i
]);
293 printf_verbose("running test for %lu seconds, %u enqueuers, "
295 duration
, nr_enqueuers
, nr_dequeuers
);
296 printf_verbose("Writer delay : %lu loops.\n", rduration
);
297 printf_verbose("Reader duration : %lu loops.\n", wdelay
);
298 printf_verbose("thread %-6s, tid %lu\n",
299 "main", urcu_get_thread_id());
301 tid_enqueuer
= calloc(nr_enqueuers
, sizeof(*tid_enqueuer
));
302 tid_dequeuer
= calloc(nr_dequeuers
, sizeof(*tid_dequeuer
));
303 count_enqueuer
= calloc(nr_enqueuers
, 2 * sizeof(*count_enqueuer
));
304 count_dequeuer
= calloc(nr_dequeuers
, 2 * sizeof(*count_dequeuer
));
309 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
310 err
= pthread_create(&tid_enqueuer
[i_thr
], NULL
, thr_enqueuer
,
311 &count_enqueuer
[2 * i_thr
]);
315 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
316 err
= pthread_create(&tid_dequeuer
[i_thr
], NULL
, thr_dequeuer
,
317 &count_dequeuer
[2 * i_thr
]);
326 for (i_thr
= 0; i_thr
< duration
; i_thr
++) {
329 fwrite(".", sizeof(char), 1, stdout
);
336 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
337 err
= pthread_join(tid_enqueuer
[i_thr
], &tret
);
340 tot_enqueues
+= count_enqueuer
[2 * i_thr
];
341 tot_successful_enqueues
+= count_enqueuer
[2 * i_thr
+ 1];
343 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
344 err
= pthread_join(tid_dequeuer
[i_thr
], &tret
);
347 tot_dequeues
+= count_dequeuer
[2 * i_thr
];
348 tot_successful_dequeues
+= count_dequeuer
[2 * i_thr
+ 1];
351 test_end(&end_dequeues
);
353 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
354 tot_enqueues
, tot_dequeues
);
355 printf_verbose("total number of successful enqueues : %llu, "
356 "successful dequeues %llu\n",
357 tot_successful_enqueues
, tot_successful_dequeues
);
358 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
360 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
361 "successful enqueues %12llu successful dequeues %12llu "
362 "end_dequeues %llu nr_ops %12llu\n",
363 argv
[0], duration
, nr_enqueuers
, wdelay
,
364 nr_dequeuers
, rduration
, tot_enqueues
, tot_dequeues
,
365 tot_successful_enqueues
,
366 tot_successful_dequeues
, end_dequeues
,
367 tot_enqueues
+ tot_dequeues
);
368 if (tot_successful_enqueues
!= tot_successful_dequeues
+ end_dequeues
)
369 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
370 "succ. dequeues + end dequeues %llu.\n",
371 tot_successful_enqueues
,
372 tot_successful_dequeues
+ end_dequeues
);
375 free(count_enqueuer
);
376 free(count_dequeuer
);