4 * Userspace RCU library - example RCU-based lock-free stack
6 * Copyright February 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 * Copyright February 2010 - Paolo Bonzini <pbonzini@redhat.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include "../config.h"
32 #include <sys/types.h>
40 #include <urcu/arch.h>
41 #include <urcu/tls-compat.h>
42 #include <urcu/uatomic.h>
48 /* hardcoded number of CPUs */
51 #if defined(_syscall0)
52 _syscall0(pid_t
, gettid
)
53 #elif defined(__NR_gettid)
54 static inline pid_t
gettid(void)
56 return syscall(__NR_gettid
);
59 #warning "use pid as tid"
60 static inline pid_t
gettid(void)
66 #ifndef DYNAMIC_LINK_TEST
69 #include <urcu/wfstack.h>
72 * External synchronization used.
79 static enum test_sync test_sync
;
81 static int test_force_sync
;
83 static volatile int test_go
, test_stop_enqueue
, test_stop_dequeue
;
85 static unsigned long rduration
;
87 static unsigned long duration
;
89 /* read-side C.S. duration, in loops */
90 static unsigned long wdelay
;
92 static inline void loop_sleep(unsigned long loops
)
98 static int verbose_mode
;
100 static int test_pop
, test_pop_all
, test_wait_empty
;
101 static int test_enqueue_stopped
;
103 #define printf_verbose(fmt, args...) \
106 printf(fmt, ## args); \
109 static unsigned int cpu_affinities
[NR_CPUS
];
110 static unsigned int next_aff
= 0;
111 static int use_affinity
= 0;
113 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
115 #ifndef HAVE_CPU_SET_T
116 typedef unsigned long cpu_set_t
;
117 # define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
118 # define CPU_SET(cpu, cpuset) do { *(cpuset) |= (1UL << (cpu)); } while(0)
121 static void set_affinity(void)
123 #if HAVE_SCHED_SETAFFINITY
126 #endif /* HAVE_SCHED_SETAFFINITY */
131 #if HAVE_SCHED_SETAFFINITY
132 ret
= pthread_mutex_lock(&affinity_mutex
);
134 perror("Error in pthread mutex lock");
137 cpu
= cpu_affinities
[next_aff
++];
138 ret
= pthread_mutex_unlock(&affinity_mutex
);
140 perror("Error in pthread mutex unlock");
146 #if SCHED_SETAFFINITY_ARGS == 2
147 sched_setaffinity(0, &mask
);
149 sched_setaffinity(0, sizeof(mask
), &mask
);
151 #endif /* HAVE_SCHED_SETAFFINITY */
155 * returns 0 if test should end.
157 static int test_duration_dequeue(void)
159 return !test_stop_dequeue
;
162 static int test_duration_enqueue(void)
164 return !test_stop_enqueue
;
167 static DEFINE_URCU_TLS(unsigned long long, nr_dequeues
);
168 static DEFINE_URCU_TLS(unsigned long long, nr_enqueues
);
170 static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues
);
171 static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues
);
172 static DEFINE_URCU_TLS(unsigned long long, nr_empty_dest_enqueues
);
173 static DEFINE_URCU_TLS(unsigned long long, nr_pop_all
);
175 static unsigned int nr_enqueuers
;
176 static unsigned int nr_dequeuers
;
178 static struct cds_wfs_stack s
;
180 static void *thr_enqueuer(void *_count
)
182 unsigned long long *count
= _count
;
185 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
186 "enqueuer", (unsigned long) pthread_self(),
187 (unsigned long) gettid());
197 struct cds_wfs_node
*node
= malloc(sizeof(*node
));
200 cds_wfs_node_init(node
);
201 was_nonempty
= cds_wfs_push(&s
, node
);
202 URCU_TLS(nr_successful_enqueues
)++;
204 URCU_TLS(nr_empty_dest_enqueues
)++;
206 if (caa_unlikely(wdelay
))
209 URCU_TLS(nr_enqueues
)++;
210 if (caa_unlikely(!test_duration_enqueue()))
214 uatomic_inc(&test_enqueue_stopped
);
215 count
[0] = URCU_TLS(nr_enqueues
);
216 count
[1] = URCU_TLS(nr_successful_enqueues
);
217 count
[2] = URCU_TLS(nr_empty_dest_enqueues
);
218 printf_verbose("enqueuer thread_end, thread id : %lx, tid %lu, "
219 "enqueues %llu successful_enqueues %llu, "
220 "empty_dest_enqueues %llu\n",
222 (unsigned long) gettid(),
223 URCU_TLS(nr_enqueues
),
224 URCU_TLS(nr_successful_enqueues
),
225 URCU_TLS(nr_empty_dest_enqueues
));
230 static void do_test_pop(enum test_sync sync
)
232 struct cds_wfs_node
*node
;
234 if (sync
== TEST_SYNC_MUTEX
)
235 cds_wfs_pop_lock(&s
);
236 node
= __cds_wfs_pop_blocking(&s
);
237 if (sync
== TEST_SYNC_MUTEX
)
238 cds_wfs_pop_unlock(&s
);
242 URCU_TLS(nr_successful_dequeues
)++;
244 URCU_TLS(nr_dequeues
)++;
247 static void do_test_pop_all(enum test_sync sync
)
249 struct cds_wfs_head
*head
;
250 struct cds_wfs_node
*node
, *n
;
252 if (sync
== TEST_SYNC_MUTEX
)
253 cds_wfs_pop_lock(&s
);
254 head
= __cds_wfs_pop_all(&s
);
255 if (sync
== TEST_SYNC_MUTEX
)
256 cds_wfs_pop_unlock(&s
);
259 if (cds_wfs_first(head
) == NULL
)
262 URCU_TLS(nr_pop_all
)++;
264 cds_wfs_for_each_blocking_safe(head
, node
, n
) {
266 URCU_TLS(nr_successful_dequeues
)++;
267 URCU_TLS(nr_dequeues
)++;
271 static void *thr_dequeuer(void *_count
)
273 unsigned long long *count
= _count
;
274 unsigned int counter
;
276 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
277 "dequeuer", (unsigned long) pthread_self(),
278 (unsigned long) gettid());
287 assert(test_pop
|| test_pop_all
);
290 if (test_pop
&& test_pop_all
) {
292 do_test_pop(test_sync
);
294 do_test_pop_all(test_sync
);
298 do_test_pop(test_sync
);
300 do_test_pop_all(test_sync
);
303 if (caa_unlikely(!test_duration_dequeue()))
305 if (caa_unlikely(rduration
))
306 loop_sleep(rduration
);
309 printf_verbose("dequeuer thread_end, thread id : %lx, tid %lu, "
310 "dequeues %llu, successful_dequeues %llu "
313 (unsigned long) gettid(),
314 URCU_TLS(nr_dequeues
), URCU_TLS(nr_successful_dequeues
),
315 URCU_TLS(nr_pop_all
));
316 count
[0] = URCU_TLS(nr_dequeues
);
317 count
[1] = URCU_TLS(nr_successful_dequeues
);
318 count
[2] = URCU_TLS(nr_pop_all
);
322 static void test_end(struct cds_wfs_stack
*s
, unsigned long long *nr_dequeues
)
324 struct cds_wfs_node
*node
;
327 node
= cds_wfs_pop_blocking(s
);
335 static void show_usage(int argc
, char **argv
)
337 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s)", argv
[0]);
338 printf(" [-d delay] (enqueuer period (in loops))");
339 printf(" [-c duration] (dequeuer period (in loops))");
340 printf(" [-v] (verbose output)");
341 printf(" [-a cpu#] [-a cpu#]... (affinity)");
342 printf(" [-p] (test pop)");
343 printf(" [-P] (test pop_all, enabled by default)");
344 printf(" [-M] (use mutex external synchronization)");
345 printf(" Note: default: no external synchronization used.");
346 printf(" [-f] (force user-provided synchronization)");
347 printf(" [-w] Wait for dequeuer to empty stack");
351 int main(int argc
, char **argv
)
354 pthread_t
*tid_enqueuer
, *tid_dequeuer
;
356 unsigned long long *count_enqueuer
, *count_dequeuer
;
357 unsigned long long tot_enqueues
= 0, tot_dequeues
= 0;
358 unsigned long long tot_successful_enqueues
= 0,
359 tot_successful_dequeues
= 0,
360 tot_empty_dest_enqueues
= 0,
362 unsigned long long end_dequeues
= 0;
363 int i
, a
, retval
= 0;
366 show_usage(argc
, argv
);
370 err
= sscanf(argv
[1], "%u", &nr_dequeuers
);
372 show_usage(argc
, argv
);
376 err
= sscanf(argv
[2], "%u", &nr_enqueuers
);
378 show_usage(argc
, argv
);
382 err
= sscanf(argv
[3], "%lu", &duration
);
384 show_usage(argc
, argv
);
388 for (i
= 4; i
< argc
; i
++) {
389 if (argv
[i
][0] != '-')
391 switch (argv
[i
][1]) {
394 show_usage(argc
, argv
);
398 cpu_affinities
[next_aff
++] = a
;
400 printf_verbose("Adding CPU %d affinity\n", a
);
404 show_usage(argc
, argv
);
407 rduration
= atol(argv
[++i
]);
411 show_usage(argc
, argv
);
414 wdelay
= atol(argv
[++i
]);
426 test_sync
= TEST_SYNC_MUTEX
;
437 /* activate pop_all test by default */
438 if (!test_pop
&& !test_pop_all
)
441 if (test_sync
== TEST_SYNC_NONE
&& nr_dequeuers
> 1 && test_pop
) {
442 if (test_force_sync
) {
443 fprintf(stderr
, "[WARNING] Using pop concurrently "
444 "with other pop or pop_all without external "
445 "synchronization. Expect run-time failure.\n");
447 printf("Enforcing mutex synchronization\n");
448 test_sync
= TEST_SYNC_MUTEX
;
452 printf_verbose("running test for %lu seconds, %u enqueuers, "
454 duration
, nr_enqueuers
, nr_dequeuers
);
456 printf_verbose("pop test activated.\n");
458 printf_verbose("pop_all test activated.\n");
459 if (test_sync
== TEST_SYNC_MUTEX
)
460 printf_verbose("External sync: mutex.\n");
462 printf_verbose("External sync: none.\n");
464 printf_verbose("Wait for dequeuers to empty stack.\n");
465 printf_verbose("Writer delay : %lu loops.\n", rduration
);
466 printf_verbose("Reader duration : %lu loops.\n", wdelay
);
467 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
468 "main", (unsigned long) pthread_self(),
469 (unsigned long) gettid());
471 tid_enqueuer
= malloc(sizeof(*tid_enqueuer
) * nr_enqueuers
);
472 tid_dequeuer
= malloc(sizeof(*tid_dequeuer
) * nr_dequeuers
);
473 count_enqueuer
= malloc(3 * sizeof(*count_enqueuer
) * nr_enqueuers
);
474 count_dequeuer
= malloc(3 * sizeof(*count_dequeuer
) * nr_dequeuers
);
479 for (i
= 0; i
< nr_enqueuers
; i
++) {
480 err
= pthread_create(&tid_enqueuer
[i
], NULL
, thr_enqueuer
,
481 &count_enqueuer
[3 * i
]);
485 for (i
= 0; i
< nr_dequeuers
; i
++) {
486 err
= pthread_create(&tid_dequeuer
[i
], NULL
, thr_dequeuer
,
487 &count_dequeuer
[3 * i
]);
496 for (i
= 0; i
< duration
; i
++) {
502 test_stop_enqueue
= 1;
504 if (test_wait_empty
) {
505 while (nr_enqueuers
!= uatomic_read(&test_enqueue_stopped
)) {
508 while (!cds_wfs_empty(&s
)) {
513 test_stop_dequeue
= 1;
515 for (i
= 0; i
< nr_enqueuers
; i
++) {
516 err
= pthread_join(tid_enqueuer
[i
], &tret
);
519 tot_enqueues
+= count_enqueuer
[3 * i
];
520 tot_successful_enqueues
+= count_enqueuer
[3 * i
+ 1];
521 tot_empty_dest_enqueues
+= count_enqueuer
[3 * i
+ 2];
523 for (i
= 0; i
< nr_dequeuers
; i
++) {
524 err
= pthread_join(tid_dequeuer
[i
], &tret
);
527 tot_dequeues
+= count_dequeuer
[3 * i
];
528 tot_successful_dequeues
+= count_dequeuer
[3 * i
+ 1];
529 tot_pop_all
+= count_dequeuer
[3 * i
+ 2];
532 test_end(&s
, &end_dequeues
);
534 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
535 tot_enqueues
, tot_dequeues
);
536 printf_verbose("total number of successful enqueues : %llu, "
537 "enqueues to empty dest : %llu, "
538 "successful dequeues %llu, "
540 tot_successful_enqueues
,
541 tot_empty_dest_enqueues
,
542 tot_successful_dequeues
,
544 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
546 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
547 "successful enqueues %12llu enqueues to empty dest %12llu "
548 "successful dequeues %12llu pop_all %12llu "
549 "end_dequeues %llu nr_ops %12llu\n",
550 argv
[0], duration
, nr_enqueuers
, wdelay
,
551 nr_dequeuers
, rduration
, tot_enqueues
, tot_dequeues
,
552 tot_successful_enqueues
,
553 tot_empty_dest_enqueues
,
554 tot_successful_dequeues
, tot_pop_all
, end_dequeues
,
555 tot_enqueues
+ tot_dequeues
);
556 if (tot_successful_enqueues
!= tot_successful_dequeues
+ end_dequeues
) {
557 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
558 "succ. dequeues + end dequeues %llu.\n",
559 tot_successful_enqueues
,
560 tot_successful_dequeues
+ end_dequeues
);
564 * If only using pop_all to dequeue, the enqueuer should see
565 * exactly as many empty queues than the number of non-empty
568 if (test_wait_empty
&& test_pop_all
&& !test_pop
569 && tot_empty_dest_enqueues
!= tot_pop_all
) {
570 printf("WARNING! Discrepancy between empty enqueue (%llu) and "
571 "number of non-empty pop_all (%llu)\n",
572 tot_empty_dest_enqueues
,
576 free(count_enqueuer
);
577 free(count_dequeuer
);