Spelling cleanups within comments and documentation
[userspace-rcu.git] / tests / test_urcu_lfq.c
CommitLineData
453629a9
MD
1/*
2 * test_urcu_lfq.c
3 *
4 * Userspace RCU library - example RCU-based lock-free queue
5 *
6 * Copyright February 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 * Copyright February 2010 - Paolo Bonzini <pbonzini@redhat.com>
8 *
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.
13 *
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.
18 *
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.
22 */
23
24#define _GNU_SOURCE
25#include "../config.h"
26#include <stdio.h>
27#include <pthread.h>
28#include <stdlib.h>
29#include <stdint.h>
30#include <stdbool.h>
31#include <string.h>
32#include <sys/types.h>
33#include <sys/wait.h>
34#include <unistd.h>
35#include <stdio.h>
36#include <assert.h>
453629a9
MD
37#include <sched.h>
38#include <errno.h>
39
40#include <urcu/arch.h>
bd252a04 41#include <urcu/tls-compat.h>
453629a9 42
65fcc7e9
MD
43#ifdef __linux__
44#include <syscall.h>
45#endif
46
453629a9
MD
47/* hardcoded number of CPUs */
48#define NR_CPUS 16384
49
50#if defined(_syscall0)
51_syscall0(pid_t, gettid)
52#elif defined(__NR_gettid)
53static inline pid_t gettid(void)
54{
55 return syscall(__NR_gettid);
56}
57#else
58#warning "use pid as tid"
59static inline pid_t gettid(void)
60{
61 return getpid();
62}
63#endif
64
65#ifndef DYNAMIC_LINK_TEST
66#define _LGPL_SOURCE
67#endif
68#include <urcu.h>
e5a7d709 69#include <urcu/cds.h>
453629a9
MD
70
71static volatile int test_go, test_stop;
72
73static unsigned long rduration;
74
75static unsigned long duration;
76
77/* read-side C.S. duration, in loops */
78static unsigned long wdelay;
79
ab0aacbe 80static inline void loop_sleep(unsigned long loops)
453629a9 81{
ab0aacbe 82 while (loops-- != 0)
06f22bdb 83 caa_cpu_relax();
453629a9
MD
84}
85
86static int verbose_mode;
87
88#define printf_verbose(fmt, args...) \
89 do { \
90 if (verbose_mode) \
91 printf(fmt, args); \
92 } while (0)
93
94static unsigned int cpu_affinities[NR_CPUS];
95static unsigned int next_aff = 0;
96static int use_affinity = 0;
97
98pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
99
100#ifndef HAVE_CPU_SET_T
101typedef unsigned long cpu_set_t;
102# define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
103# define CPU_SET(cpu, cpuset) do { *(cpuset) |= (1UL << (cpu)); } while(0)
104#endif
105
106static void set_affinity(void)
107{
95bc7fb9 108#if HAVE_SCHED_SETAFFINITY
453629a9 109 cpu_set_t mask;
95bc7fb9
MD
110 int cpu, ret;
111#endif /* HAVE_SCHED_SETAFFINITY */
453629a9
MD
112
113 if (!use_affinity)
114 return;
115
116#if HAVE_SCHED_SETAFFINITY
117 ret = pthread_mutex_lock(&affinity_mutex);
118 if (ret) {
119 perror("Error in pthread mutex lock");
120 exit(-1);
121 }
122 cpu = cpu_affinities[next_aff++];
123 ret = pthread_mutex_unlock(&affinity_mutex);
124 if (ret) {
125 perror("Error in pthread mutex unlock");
126 exit(-1);
127 }
128
129 CPU_ZERO(&mask);
130 CPU_SET(cpu, &mask);
131#if SCHED_SETAFFINITY_ARGS == 2
132 sched_setaffinity(0, &mask);
133#else
134 sched_setaffinity(0, sizeof(mask), &mask);
135#endif
136#endif /* HAVE_SCHED_SETAFFINITY */
137}
138
139/*
140 * returns 0 if test should end.
141 */
142static int test_duration_dequeue(void)
143{
144 return !test_stop;
145}
146
147static int test_duration_enqueue(void)
148{
149 return !test_stop;
150}
151
bd252a04
MD
152static DEFINE_URCU_TLS(unsigned long long, nr_dequeues);
153static DEFINE_URCU_TLS(unsigned long long, nr_enqueues);
453629a9 154
bd252a04
MD
155static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues);
156static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues);
453629a9
MD
157
158static unsigned int nr_enqueuers;
159static unsigned int nr_dequeuers;
160
94aec122
MD
161struct test {
162 struct cds_lfq_node_rcu list;
163 struct rcu_head rcu;
164};
165
16aa9ee8 166static struct cds_lfq_queue_rcu q;
453629a9
MD
167
168void *thr_enqueuer(void *_count)
169{
170 unsigned long long *count = _count;
171
172 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
6ff854ac
MD
173 "enqueuer", (unsigned long) pthread_self(),
174 (unsigned long) gettid());
453629a9
MD
175
176 set_affinity();
177
178 rcu_register_thread();
179
180 while (!test_go)
181 {
182 }
5481ddb3 183 cmm_smp_mb();
453629a9
MD
184
185 for (;;) {
94aec122 186 struct test *node = malloc(sizeof(*node));
453629a9
MD
187 if (!node)
188 goto fail;
94aec122 189 cds_lfq_node_init_rcu(&node->list);
6e5f88cf 190 rcu_read_lock();
94aec122 191 cds_lfq_enqueue_rcu(&q, &node->list);
6e5f88cf 192 rcu_read_unlock();
bd252a04 193 URCU_TLS(nr_successful_enqueues)++;
453629a9 194
a0b7f7ea 195 if (caa_unlikely(wdelay))
453629a9
MD
196 loop_sleep(wdelay);
197fail:
bd252a04 198 URCU_TLS(nr_enqueues)++;
a0b7f7ea 199 if (caa_unlikely(!test_duration_enqueue()))
453629a9
MD
200 break;
201 }
202
203 rcu_unregister_thread();
204
bd252a04
MD
205 count[0] = URCU_TLS(nr_enqueues);
206 count[1] = URCU_TLS(nr_successful_enqueues);
453629a9
MD
207 printf_verbose("enqueuer thread_end, thread id : %lx, tid %lu, "
208 "enqueues %llu successful_enqueues %llu\n",
6ff854ac
MD
209 pthread_self(),
210 (unsigned long) gettid(),
bd252a04 211 URCU_TLS(nr_enqueues), URCU_TLS(nr_successful_enqueues));
453629a9
MD
212 return ((void*)1);
213
214}
215
94aec122
MD
216static
217void free_node_cb(struct rcu_head *head)
218{
219 struct test *node =
220 caa_container_of(head, struct test, rcu);
221 free(node);
222}
223
453629a9
MD
224void *thr_dequeuer(void *_count)
225{
226 unsigned long long *count = _count;
227
228 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
6ff854ac
MD
229 "dequeuer", (unsigned long) pthread_self(),
230 (unsigned long) gettid());
453629a9
MD
231
232 set_affinity();
233
453629a9
MD
234 rcu_register_thread();
235
236 while (!test_go)
237 {
238 }
5481ddb3 239 cmm_smp_mb();
453629a9
MD
240
241 for (;;) {
94aec122 242 struct cds_lfq_node_rcu *qnode;
d9b52143 243
6e5f88cf 244 rcu_read_lock();
94aec122 245 qnode = cds_lfq_dequeue_rcu(&q);
6e5f88cf
MD
246 rcu_read_unlock();
247
747b5930
LJ
248 if (qnode) {
249 struct test *node;
250
251 node = caa_container_of(qnode, struct test, list);
94aec122 252 call_rcu(&node->rcu, free_node_cb);
bd252a04 253 URCU_TLS(nr_successful_dequeues)++;
453629a9
MD
254 }
255
bd252a04 256 URCU_TLS(nr_dequeues)++;
a0b7f7ea 257 if (caa_unlikely(!test_duration_dequeue()))
453629a9 258 break;
a0b7f7ea 259 if (caa_unlikely(rduration))
453629a9
MD
260 loop_sleep(rduration);
261 }
262
263 rcu_unregister_thread();
453629a9
MD
264 printf_verbose("dequeuer thread_end, thread id : %lx, tid %lu, "
265 "dequeues %llu, successful_dequeues %llu\n",
6ff854ac
MD
266 pthread_self(),
267 (unsigned long) gettid(),
bd252a04
MD
268 URCU_TLS(nr_dequeues), URCU_TLS(nr_successful_dequeues));
269 count[0] = URCU_TLS(nr_dequeues);
270 count[1] = URCU_TLS(nr_successful_dequeues);
453629a9
MD
271 return ((void*)2);
272}
273
16aa9ee8 274void test_end(struct cds_lfq_queue_rcu *q, unsigned long long *nr_dequeues)
453629a9 275{
94aec122 276 struct cds_lfq_node_rcu *snode;
453629a9
MD
277
278 do {
94aec122
MD
279 snode = cds_lfq_dequeue_rcu(q);
280 if (snode) {
281 struct test *node;
282
283 node = caa_container_of(snode, struct test, list);
e17d9985 284 free(node); /* no more concurrent access */
453629a9
MD
285 (*nr_dequeues)++;
286 }
94aec122 287 } while (snode);
453629a9
MD
288}
289
290void show_usage(int argc, char **argv)
291{
292 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s)", argv[0]);
293 printf(" [-d delay] (enqueuer period (in loops))");
294 printf(" [-c duration] (dequeuer period (in loops))");
295 printf(" [-v] (verbose output)");
296 printf(" [-a cpu#] [-a cpu#]... (affinity)");
297 printf("\n");
298}
299
300int main(int argc, char **argv)
301{
302 int err;
303 pthread_t *tid_enqueuer, *tid_dequeuer;
304 void *tret;
305 unsigned long long *count_enqueuer, *count_dequeuer;
306 unsigned long long tot_enqueues = 0, tot_dequeues = 0;
307 unsigned long long tot_successful_enqueues = 0,
308 tot_successful_dequeues = 0;
309 unsigned long long end_dequeues = 0;
310 int i, a;
311
312 if (argc < 4) {
313 show_usage(argc, argv);
314 return -1;
315 }
316
317 err = sscanf(argv[1], "%u", &nr_dequeuers);
318 if (err != 1) {
319 show_usage(argc, argv);
320 return -1;
321 }
322
323 err = sscanf(argv[2], "%u", &nr_enqueuers);
324 if (err != 1) {
325 show_usage(argc, argv);
326 return -1;
327 }
328
329 err = sscanf(argv[3], "%lu", &duration);
330 if (err != 1) {
331 show_usage(argc, argv);
332 return -1;
333 }
334
335 for (i = 4; i < argc; i++) {
336 if (argv[i][0] != '-')
337 continue;
338 switch (argv[i][1]) {
339 case 'a':
340 if (argc < i + 2) {
341 show_usage(argc, argv);
342 return -1;
343 }
344 a = atoi(argv[++i]);
345 cpu_affinities[next_aff++] = a;
346 use_affinity = 1;
347 printf_verbose("Adding CPU %d affinity\n", a);
348 break;
349 case 'c':
350 if (argc < i + 2) {
351 show_usage(argc, argv);
352 return -1;
353 }
354 rduration = atol(argv[++i]);
355 break;
356 case 'd':
357 if (argc < i + 2) {
358 show_usage(argc, argv);
359 return -1;
360 }
361 wdelay = atol(argv[++i]);
362 break;
363 case 'v':
364 verbose_mode = 1;
365 break;
366 }
367 }
368
369 printf_verbose("running test for %lu seconds, %u enqueuers, "
370 "%u dequeuers.\n",
371 duration, nr_enqueuers, nr_dequeuers);
372 printf_verbose("Writer delay : %lu loops.\n", rduration);
373 printf_verbose("Reader duration : %lu loops.\n", wdelay);
374 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
6ff854ac
MD
375 "main", (unsigned long) pthread_self(),
376 (unsigned long) gettid());
453629a9
MD
377
378 tid_enqueuer = malloc(sizeof(*tid_enqueuer) * nr_enqueuers);
379 tid_dequeuer = malloc(sizeof(*tid_dequeuer) * nr_dequeuers);
380 count_enqueuer = malloc(2 * sizeof(*count_enqueuer) * nr_enqueuers);
381 count_dequeuer = malloc(2 * sizeof(*count_dequeuer) * nr_dequeuers);
6e5f88cf 382 cds_lfq_init_rcu(&q, call_rcu);
94aec122 383 err = create_all_cpu_call_rcu_data(0);
8bcbd94a
MD
384 if (err) {
385 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
386 }
453629a9
MD
387
388 next_aff = 0;
389
390 for (i = 0; i < nr_enqueuers; i++) {
391 err = pthread_create(&tid_enqueuer[i], NULL, thr_enqueuer,
392 &count_enqueuer[2 * i]);
393 if (err != 0)
394 exit(1);
395 }
396 for (i = 0; i < nr_dequeuers; i++) {
397 err = pthread_create(&tid_dequeuer[i], NULL, thr_dequeuer,
398 &count_dequeuer[2 * i]);
399 if (err != 0)
400 exit(1);
401 }
402
5481ddb3 403 cmm_smp_mb();
453629a9
MD
404
405 test_go = 1;
406
407 for (i = 0; i < duration; i++) {
408 sleep(1);
409 if (verbose_mode)
410 write (1, ".", 1);
411 }
412
413 test_stop = 1;
414
415 for (i = 0; i < nr_enqueuers; i++) {
416 err = pthread_join(tid_enqueuer[i], &tret);
417 if (err != 0)
418 exit(1);
419 tot_enqueues += count_enqueuer[2 * i];
420 tot_successful_enqueues += count_enqueuer[2 * i + 1];
421 }
422 for (i = 0; i < nr_dequeuers; i++) {
423 err = pthread_join(tid_dequeuer[i], &tret);
424 if (err != 0)
425 exit(1);
426 tot_dequeues += count_dequeuer[2 * i];
427 tot_successful_dequeues += count_dequeuer[2 * i + 1];
428 }
429
430 test_end(&q, &end_dequeues);
e17d9985
MD
431 err = cds_lfq_destroy_rcu(&q);
432 assert(!err);
453629a9
MD
433
434 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
435 tot_enqueues, tot_dequeues);
436 printf_verbose("total number of successful enqueues : %llu, "
437 "successful dequeues %llu\n",
438 tot_successful_enqueues, tot_successful_dequeues);
439 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
440 "nr_dequeuers %3u "
441 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
442 "successful enqueues %12llu successful dequeues %12llu "
443 "end_dequeues %llu nr_ops %12llu\n",
444 argv[0], duration, nr_enqueuers, wdelay,
445 nr_dequeuers, rduration, tot_enqueues, tot_dequeues,
446 tot_successful_enqueues,
447 tot_successful_dequeues, end_dequeues,
448 tot_enqueues + tot_dequeues);
449 if (tot_successful_enqueues != tot_successful_dequeues + end_dequeues)
450 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
451 "succ. dequeues + end dequeues %llu.\n",
452 tot_successful_enqueues,
453 tot_successful_dequeues + end_dequeues);
454
0938c541 455 free_all_cpu_call_rcu_data();
453629a9
MD
456 free(count_enqueuer);
457 free(count_dequeuer);
458 free(tid_enqueuer);
459 free(tid_dequeuer);
460 return 0;
461}
This page took 0.044132 seconds and 4 git commands to generate.