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 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
35 /* Remove deprecation warnings from test build. */
36 #define CDS_LFS_RCU_DEPRECATED
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
;
119 struct cds_lfs_node_rcu list
;
123 static struct cds_lfs_stack_rcu s
;
126 void *thr_enqueuer(void *_count
)
128 unsigned long long *count
= _count
;
130 printf_verbose("thread_begin %s, tid %lu\n",
131 "enqueuer", urcu_get_thread_id());
135 rcu_register_thread();
140 struct test
*node
= malloc(sizeof(*node
));
143 cds_lfs_node_init_rcu(&node
->list
);
144 /* No rcu read-side is needed for push */
145 cds_lfs_push_rcu(&s
, &node
->list
);
146 URCU_TLS(nr_successful_enqueues
)++;
148 if (caa_unlikely(wdelay
))
151 URCU_TLS(nr_enqueues
)++;
152 if (caa_unlikely(!test_duration_enqueue()))
156 rcu_unregister_thread();
158 count
[0] = URCU_TLS(nr_enqueues
);
159 count
[1] = URCU_TLS(nr_successful_enqueues
);
160 printf_verbose("enqueuer thread_end, tid %lu, "
161 "enqueues %llu successful_enqueues %llu\n",
162 urcu_get_thread_id(),
163 URCU_TLS(nr_enqueues
),
164 URCU_TLS(nr_successful_enqueues
));
170 void free_node_cb(struct rcu_head
*head
)
173 caa_container_of(head
, struct test
, rcu
);
178 void *thr_dequeuer(void *_count
)
180 unsigned long long *count
= _count
;
182 printf_verbose("thread_begin %s, tid %lu\n",
183 "dequeuer", urcu_get_thread_id());
187 rcu_register_thread();
192 struct cds_lfs_node_rcu
*snode
;
195 snode
= cds_lfs_pop_rcu(&s
);
200 node
= caa_container_of(snode
, struct test
, list
);
201 call_rcu(&node
->rcu
, free_node_cb
);
202 URCU_TLS(nr_successful_dequeues
)++;
204 URCU_TLS(nr_dequeues
)++;
205 if (caa_unlikely(!test_duration_dequeue()))
207 if (caa_unlikely(rduration
))
208 loop_sleep(rduration
);
211 rcu_unregister_thread();
213 printf_verbose("dequeuer thread_end, tid %lu, "
214 "dequeues %llu, successful_dequeues %llu\n",
215 urcu_get_thread_id(),
216 URCU_TLS(nr_dequeues
),
217 URCU_TLS(nr_successful_dequeues
));
218 count
[0] = URCU_TLS(nr_dequeues
);
219 count
[1] = URCU_TLS(nr_successful_dequeues
);
224 void test_end(unsigned long long *nr_dequeues_l
)
226 struct cds_lfs_node_rcu
*snode
;
229 snode
= cds_lfs_pop_rcu(&s
);
233 node
= caa_container_of(snode
, struct test
, list
);
241 void show_usage(char **argv
)
243 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
245 printf("OPTIONS:\n");
246 printf(" [-d delay] (enqueuer period (in loops))\n");
247 printf(" [-c duration] (dequeuer period (in loops))\n");
248 printf(" [-v] (verbose output)\n");
249 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
253 int main(int argc
, char **argv
)
256 pthread_t
*tid_enqueuer
, *tid_dequeuer
;
258 unsigned long long *count_enqueuer
, *count_dequeuer
;
259 unsigned long long tot_enqueues
= 0, tot_dequeues
= 0;
260 unsigned long long tot_successful_enqueues
= 0,
261 tot_successful_dequeues
= 0;
262 unsigned long long end_dequeues
= 0;
271 err
= sscanf(argv
[1], "%u", &nr_dequeuers
);
277 err
= sscanf(argv
[2], "%u", &nr_enqueuers
);
283 err
= sscanf(argv
[3], "%lu", &duration
);
289 for (i
= 4; i
< argc
; i
++) {
290 if (argv
[i
][0] != '-')
292 switch (argv
[i
][1]) {
299 cpu_affinities
[next_aff
++] = a
;
301 printf_verbose("Adding CPU %d affinity\n", a
);
308 rduration
= atol(argv
[++i
]);
315 wdelay
= atol(argv
[++i
]);
323 printf_verbose("running test for %lu seconds, %u enqueuers, "
325 duration
, nr_enqueuers
, nr_dequeuers
);
326 printf_verbose("Writer delay : %lu loops.\n", rduration
);
327 printf_verbose("Reader duration : %lu loops.\n", wdelay
);
328 printf_verbose("thread %-6s, tid %lu\n",
329 "main", urcu_get_thread_id());
331 tid_enqueuer
= calloc(nr_enqueuers
, sizeof(*tid_enqueuer
));
332 tid_dequeuer
= calloc(nr_dequeuers
, sizeof(*tid_dequeuer
));
333 count_enqueuer
= calloc(nr_enqueuers
, 2 * sizeof(*count_enqueuer
));
334 count_dequeuer
= calloc(nr_dequeuers
, 2 * sizeof(*count_dequeuer
));
335 cds_lfs_init_rcu(&s
);
336 err
= create_all_cpu_call_rcu_data(0);
338 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
343 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
344 err
= pthread_create(&tid_enqueuer
[i_thr
], NULL
, thr_enqueuer
,
345 &count_enqueuer
[2 * i_thr
]);
349 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
350 err
= pthread_create(&tid_dequeuer
[i_thr
], NULL
, thr_dequeuer
,
351 &count_dequeuer
[2 * i_thr
]);
360 for (i_thr
= 0; i_thr
< duration
; i_thr
++) {
363 fwrite(".", sizeof(char), 1, stdout
);
370 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
371 err
= pthread_join(tid_enqueuer
[i_thr
], &tret
);
374 tot_enqueues
+= count_enqueuer
[2 * i_thr
];
375 tot_successful_enqueues
+= count_enqueuer
[2 * i_thr
+ 1];
377 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
378 err
= pthread_join(tid_dequeuer
[i_thr
], &tret
);
381 tot_dequeues
+= count_dequeuer
[2 * i_thr
];
382 tot_successful_dequeues
+= count_dequeuer
[2 * i_thr
+ 1];
385 test_end(&end_dequeues
);
387 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
388 tot_enqueues
, tot_dequeues
);
389 printf_verbose("total number of successful enqueues : %llu, "
390 "successful dequeues %llu\n",
391 tot_successful_enqueues
, tot_successful_dequeues
);
392 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
394 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
395 "successful enqueues %12llu successful dequeues %12llu "
396 "end_dequeues %llu nr_ops %12llu\n",
397 argv
[0], duration
, nr_enqueuers
, wdelay
,
398 nr_dequeuers
, rduration
, tot_enqueues
, tot_dequeues
,
399 tot_successful_enqueues
,
400 tot_successful_dequeues
, end_dequeues
,
401 tot_enqueues
+ tot_dequeues
);
402 if (tot_successful_enqueues
!= tot_successful_dequeues
+ end_dequeues
)
403 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
404 "succ. dequeues + end dequeues %llu.\n",
405 tot_successful_enqueues
,
406 tot_successful_dequeues
+ end_dequeues
);
408 free_all_cpu_call_rcu_data();
409 free(count_enqueuer
);
410 free(count_dequeuer
);