1 // SPDX-FileCopyrightText: 2010-2012 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 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
36 #define POISON_PTR ((void *) 0x42UL)
39 * External synchronization used.
46 static enum test_sync test_sync
;
48 static unsigned long rduration
;
50 static unsigned long duration
;
52 /* read-side C.S. duration, in loops */
53 static unsigned long wdelay
;
55 static inline void loop_sleep(unsigned long loops
)
61 static int verbose_mode
;
63 static int test_pop
, test_pop_all
;
65 #define printf_verbose(fmt, args...) \
68 printf(fmt, ## args); \
71 static unsigned int cpu_affinities
[NR_CPUS
];
72 static unsigned int next_aff
= 0;
73 static int use_affinity
= 0;
75 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
77 static void set_affinity(void)
79 #ifdef HAVE_SCHED_SETAFFINITY
82 #endif /* HAVE_SCHED_SETAFFINITY */
87 #ifdef HAVE_SCHED_SETAFFINITY
88 ret
= pthread_mutex_lock(&affinity_mutex
);
90 perror("Error in pthread mutex lock");
93 cpu
= cpu_affinities
[next_aff
++];
94 ret
= pthread_mutex_unlock(&affinity_mutex
);
96 perror("Error in pthread mutex unlock");
102 sched_setaffinity(0, sizeof(mask
), &mask
);
103 #endif /* HAVE_SCHED_SETAFFINITY */
107 * returns 0 if test should end.
109 static int test_duration_dequeue(void)
111 return test_duration_read();
114 static int test_duration_enqueue(void)
116 return test_duration_write();
119 static DEFINE_URCU_TLS(unsigned long long, nr_dequeues
);
120 static DEFINE_URCU_TLS(unsigned long long, nr_enqueues
);
122 static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues
);
123 static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues
);
125 static unsigned int nr_enqueuers
;
126 static unsigned int nr_dequeuers
;
129 struct cds_lfs_node list
;
133 static struct cds_lfs_stack s
;
135 static void *thr_enqueuer(void *_count
)
137 unsigned long long *count
= _count
;
139 printf_verbose("thread_begin %s, tid %lu\n",
140 "enqueuer", urcu_get_thread_id());
144 rcu_register_thread();
149 struct test
*node
= malloc(sizeof(*node
));
152 cds_lfs_node_init(&node
->list
);
153 cds_lfs_push(&s
, &node
->list
);
154 URCU_TLS(nr_successful_enqueues
)++;
156 if (caa_unlikely(wdelay
))
159 URCU_TLS(nr_enqueues
)++;
160 if (caa_unlikely(!test_duration_enqueue()))
164 rcu_unregister_thread();
166 count
[0] = URCU_TLS(nr_enqueues
);
167 count
[1] = URCU_TLS(nr_successful_enqueues
);
168 printf_verbose("enqueuer thread_end, tid %lu, "
169 "enqueues %llu successful_enqueues %llu\n",
170 urcu_get_thread_id(),
171 URCU_TLS(nr_enqueues
),
172 URCU_TLS(nr_successful_enqueues
));
178 void free_node_cb(struct rcu_head
*head
)
181 caa_container_of(head
, struct test
, rcu
);
186 void do_test_pop(enum test_sync sync
)
188 struct cds_lfs_node
*snode
;
190 if (sync
== TEST_SYNC_RCU
)
192 snode
= __cds_lfs_pop(&s
);
193 if (sync
== TEST_SYNC_RCU
)
198 snode
->next
= POISON_PTR
;
199 node
= caa_container_of(snode
,
201 if (sync
== TEST_SYNC_RCU
)
202 call_rcu(&node
->rcu
, free_node_cb
);
205 URCU_TLS(nr_successful_dequeues
)++;
207 URCU_TLS(nr_dequeues
)++;
211 void do_test_pop_all(enum test_sync sync
)
213 struct cds_lfs_node
*snode
;
214 struct cds_lfs_head
*head
;
215 struct cds_lfs_node
*n
;
217 head
= __cds_lfs_pop_all(&s
);
218 cds_lfs_for_each_safe(head
, snode
, n
) {
221 snode
->next
= POISON_PTR
;
222 node
= caa_container_of(snode
, struct test
, list
);
223 if (sync
== TEST_SYNC_RCU
)
224 call_rcu(&node
->rcu
, free_node_cb
);
227 URCU_TLS(nr_successful_dequeues
)++;
228 URCU_TLS(nr_dequeues
)++;
233 static void *thr_dequeuer(void *_count
)
235 unsigned long long *count
= _count
;
236 unsigned int counter
= 0;
238 printf_verbose("thread_begin %s, tid %lu\n",
239 "dequeuer", urcu_get_thread_id());
243 rcu_register_thread();
247 urcu_posix_assert(test_pop
|| test_pop_all
);
250 if (test_pop
&& test_pop_all
) {
251 /* both pop and pop all */
253 do_test_pop(test_sync
);
255 do_test_pop_all(test_sync
);
259 do_test_pop(test_sync
);
261 do_test_pop_all(test_sync
);
264 if (caa_unlikely(!test_duration_dequeue()))
266 if (caa_unlikely(rduration
))
267 loop_sleep(rduration
);
270 rcu_unregister_thread();
272 printf_verbose("dequeuer thread_end, tid %lu, "
273 "dequeues %llu, successful_dequeues %llu\n",
274 urcu_get_thread_id(),
275 URCU_TLS(nr_dequeues
),
276 URCU_TLS(nr_successful_dequeues
));
277 count
[0] = URCU_TLS(nr_dequeues
);
278 count
[1] = URCU_TLS(nr_successful_dequeues
);
282 static void test_end(unsigned long long *nr_dequeues_l
)
284 struct cds_lfs_node
*snode
;
287 snode
= __cds_lfs_pop(&s
);
291 node
= caa_container_of(snode
, struct test
, list
);
298 static void show_usage(char **argv
)
300 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
302 printf("OPTIONS:\n");
303 printf(" [-d delay] (enqueuer period (in loops))\n");
304 printf(" [-c duration] (dequeuer period (in loops))\n");
305 printf(" [-v] (verbose output)\n");
306 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
307 printf(" [-p] (test pop)\n");
308 printf(" [-P] (test pop_all, enabled by default)\n");
309 printf(" [-R] (use RCU external synchronization)\n");
310 printf(" Note: default: no external synchronization used.\n");
314 int main(int argc
, char **argv
)
317 pthread_t
*tid_enqueuer
, *tid_dequeuer
;
319 unsigned long long *count_enqueuer
, *count_dequeuer
;
320 unsigned long long tot_enqueues
= 0, tot_dequeues
= 0;
321 unsigned long long tot_successful_enqueues
= 0,
322 tot_successful_dequeues
= 0;
323 unsigned long long end_dequeues
= 0;
332 err
= sscanf(argv
[1], "%u", &nr_dequeuers
);
338 err
= sscanf(argv
[2], "%u", &nr_enqueuers
);
344 err
= sscanf(argv
[3], "%lu", &duration
);
350 for (i
= 4; i
< argc
; i
++) {
351 if (argv
[i
][0] != '-')
353 switch (argv
[i
][1]) {
360 cpu_affinities
[next_aff
++] = a
;
362 printf_verbose("Adding CPU %d affinity\n", a
);
369 rduration
= atol(argv
[++i
]);
376 wdelay
= atol(argv
[++i
]);
388 test_sync
= TEST_SYNC_RCU
;
393 /* activate pop_all test by default */
394 if (!test_pop
&& !test_pop_all
)
397 printf_verbose("running test for %lu seconds, %u enqueuers, "
399 duration
, nr_enqueuers
, nr_dequeuers
);
401 printf_verbose("pop test activated.\n");
403 printf_verbose("pop_all test activated.\n");
404 if (test_sync
== TEST_SYNC_RCU
)
405 printf_verbose("External sync: RCU.\n");
407 printf_verbose("External sync: none.\n");
408 printf_verbose("Writer delay : %lu loops.\n", rduration
);
409 printf_verbose("Reader duration : %lu loops.\n", wdelay
);
410 printf_verbose("thread %-6s, tid %lu\n",
411 "main", urcu_get_thread_id());
413 tid_enqueuer
= calloc(nr_enqueuers
, sizeof(*tid_enqueuer
));
414 tid_dequeuer
= calloc(nr_dequeuers
, sizeof(*tid_dequeuer
));
415 count_enqueuer
= calloc(nr_enqueuers
, 2 * sizeof(*count_enqueuer
));
416 count_dequeuer
= calloc(nr_dequeuers
, 2 * sizeof(*count_dequeuer
));
418 err
= create_all_cpu_call_rcu_data(0);
420 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
425 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
426 err
= pthread_create(&tid_enqueuer
[i_thr
], NULL
, thr_enqueuer
,
427 &count_enqueuer
[2 * i_thr
]);
431 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
432 err
= pthread_create(&tid_dequeuer
[i_thr
], NULL
, thr_dequeuer
,
433 &count_dequeuer
[2 * i_thr
]);
442 for (i_thr
= 0; i_thr
< duration
; i_thr
++) {
445 fwrite(".", sizeof(char), 1, stdout
);
452 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
453 err
= pthread_join(tid_enqueuer
[i_thr
], &tret
);
456 tot_enqueues
+= count_enqueuer
[2 * i_thr
];
457 tot_successful_enqueues
+= count_enqueuer
[2 * i_thr
+ 1];
459 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
460 err
= pthread_join(tid_dequeuer
[i_thr
], &tret
);
463 tot_dequeues
+= count_dequeuer
[2 * i_thr
];
464 tot_successful_dequeues
+= count_dequeuer
[2 * i_thr
+ 1];
467 test_end(&end_dequeues
);
469 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
470 tot_enqueues
, tot_dequeues
);
471 printf_verbose("total number of successful enqueues : %llu, "
472 "successful dequeues %llu\n",
473 tot_successful_enqueues
, tot_successful_dequeues
);
474 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
476 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
477 "successful enqueues %12llu successful dequeues %12llu "
478 "end_dequeues %llu nr_ops %12llu\n",
479 argv
[0], duration
, nr_enqueuers
, wdelay
,
480 nr_dequeuers
, rduration
, tot_enqueues
, tot_dequeues
,
481 tot_successful_enqueues
,
482 tot_successful_dequeues
, end_dequeues
,
483 tot_enqueues
+ tot_dequeues
);
484 if (tot_successful_enqueues
!= tot_successful_dequeues
+ end_dequeues
)
485 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
486 "succ. dequeues + end dequeues %llu.\n",
487 tot_successful_enqueues
,
488 tot_successful_dequeues
+ end_dequeues
);
490 free_all_cpu_call_rcu_data();
492 free(count_enqueuer
);
493 free(count_dequeuer
);