lfstack: implement lock-free stack
[urcu.git] / tests / test_urcu_lfs.c
CommitLineData
453629a9
MD
1/*
2 * test_urcu_lfs.c
3 *
4 * Userspace RCU library - example RCU-based lock-free stack
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_lfs_node_rcu list;
163 struct rcu_head rcu;
164};
165
16aa9ee8 166static struct cds_lfs_stack_rcu s;
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",
173 "enqueuer", pthread_self(), (unsigned long)gettid());
174
175 set_affinity();
176
177 rcu_register_thread();
178
179 while (!test_go)
180 {
181 }
5481ddb3 182 cmm_smp_mb();
453629a9
MD
183
184 for (;;) {
94aec122 185 struct test *node = malloc(sizeof(*node));
453629a9
MD
186 if (!node)
187 goto fail;
94aec122 188 cds_lfs_node_init_rcu(&node->list);
d9b52143 189 /* No rcu read-side is needed for push */
94aec122 190 cds_lfs_push_rcu(&s, &node->list);
bd252a04 191 URCU_TLS(nr_successful_enqueues)++;
453629a9 192
a0b7f7ea 193 if (caa_unlikely(wdelay))
453629a9
MD
194 loop_sleep(wdelay);
195fail:
bd252a04 196 URCU_TLS(nr_enqueues)++;
a0b7f7ea 197 if (caa_unlikely(!test_duration_enqueue()))
453629a9
MD
198 break;
199 }
200
201 rcu_unregister_thread();
202
bd252a04
MD
203 count[0] = URCU_TLS(nr_enqueues);
204 count[1] = URCU_TLS(nr_successful_enqueues);
453629a9
MD
205 printf_verbose("enqueuer thread_end, thread id : %lx, tid %lu, "
206 "enqueues %llu successful_enqueues %llu\n",
bd252a04
MD
207 pthread_self(), (unsigned long)gettid(),
208 URCU_TLS(nr_enqueues), URCU_TLS(nr_successful_enqueues));
453629a9
MD
209 return ((void*)1);
210
211}
212
94aec122
MD
213static
214void free_node_cb(struct rcu_head *head)
215{
216 struct test *node =
217 caa_container_of(head, struct test, rcu);
218 free(node);
219}
220
453629a9
MD
221void *thr_dequeuer(void *_count)
222{
223 unsigned long long *count = _count;
224
225 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
226 "dequeuer", pthread_self(), (unsigned long)gettid());
227
228 set_affinity();
229
453629a9
MD
230 rcu_register_thread();
231
232 while (!test_go)
233 {
234 }
5481ddb3 235 cmm_smp_mb();
453629a9
MD
236
237 for (;;) {
94aec122 238 struct cds_lfs_node_rcu *snode;
453629a9 239
6e5f88cf 240 rcu_read_lock();
94aec122 241 snode = cds_lfs_pop_rcu(&s);
6e5f88cf 242 rcu_read_unlock();
f3eb6ef1
LJ
243 if (snode) {
244 struct test *node;
245
246 node = caa_container_of(snode, struct test, list);
94aec122 247 call_rcu(&node->rcu, free_node_cb);
bd252a04 248 URCU_TLS(nr_successful_dequeues)++;
453629a9 249 }
bd252a04 250 URCU_TLS(nr_dequeues)++;
a0b7f7ea 251 if (caa_unlikely(!test_duration_dequeue()))
453629a9 252 break;
a0b7f7ea 253 if (caa_unlikely(rduration))
453629a9
MD
254 loop_sleep(rduration);
255 }
256
257 rcu_unregister_thread();
453629a9
MD
258
259 printf_verbose("dequeuer thread_end, thread id : %lx, tid %lu, "
260 "dequeues %llu, successful_dequeues %llu\n",
bd252a04
MD
261 pthread_self(), (unsigned long)gettid(),
262 URCU_TLS(nr_dequeues), URCU_TLS(nr_successful_dequeues));
263 count[0] = URCU_TLS(nr_dequeues);
264 count[1] = URCU_TLS(nr_successful_dequeues);
453629a9
MD
265 return ((void*)2);
266}
267
16aa9ee8 268void test_end(struct cds_lfs_stack_rcu *s, unsigned long long *nr_dequeues)
453629a9 269{
94aec122 270 struct cds_lfs_node_rcu *snode;
453629a9
MD
271
272 do {
94aec122
MD
273 snode = cds_lfs_pop_rcu(s);
274 if (snode) {
275 struct test *node;
276
277 node = caa_container_of(snode, struct test, list);
453629a9
MD
278 free(node);
279 (*nr_dequeues)++;
280 }
94aec122 281 } while (snode);
453629a9
MD
282}
283
284void show_usage(int argc, char **argv)
285{
286 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s)", argv[0]);
287 printf(" [-d delay] (enqueuer period (in loops))");
288 printf(" [-c duration] (dequeuer period (in loops))");
289 printf(" [-v] (verbose output)");
290 printf(" [-a cpu#] [-a cpu#]... (affinity)");
291 printf("\n");
292}
293
294int main(int argc, char **argv)
295{
296 int err;
297 pthread_t *tid_enqueuer, *tid_dequeuer;
298 void *tret;
299 unsigned long long *count_enqueuer, *count_dequeuer;
300 unsigned long long tot_enqueues = 0, tot_dequeues = 0;
301 unsigned long long tot_successful_enqueues = 0,
302 tot_successful_dequeues = 0;
303 unsigned long long end_dequeues = 0;
304 int i, a;
305
306 if (argc < 4) {
307 show_usage(argc, argv);
308 return -1;
309 }
310
311 err = sscanf(argv[1], "%u", &nr_dequeuers);
312 if (err != 1) {
313 show_usage(argc, argv);
314 return -1;
315 }
316
317 err = sscanf(argv[2], "%u", &nr_enqueuers);
318 if (err != 1) {
319 show_usage(argc, argv);
320 return -1;
321 }
322
323 err = sscanf(argv[3], "%lu", &duration);
324 if (err != 1) {
325 show_usage(argc, argv);
326 return -1;
327 }
328
329 for (i = 4; i < argc; i++) {
330 if (argv[i][0] != '-')
331 continue;
332 switch (argv[i][1]) {
333 case 'a':
334 if (argc < i + 2) {
335 show_usage(argc, argv);
336 return -1;
337 }
338 a = atoi(argv[++i]);
339 cpu_affinities[next_aff++] = a;
340 use_affinity = 1;
341 printf_verbose("Adding CPU %d affinity\n", a);
342 break;
343 case 'c':
344 if (argc < i + 2) {
345 show_usage(argc, argv);
346 return -1;
347 }
348 rduration = atol(argv[++i]);
349 break;
350 case 'd':
351 if (argc < i + 2) {
352 show_usage(argc, argv);
353 return -1;
354 }
355 wdelay = atol(argv[++i]);
356 break;
357 case 'v':
358 verbose_mode = 1;
359 break;
360 }
361 }
362
363 printf_verbose("running test for %lu seconds, %u enqueuers, "
364 "%u dequeuers.\n",
365 duration, nr_enqueuers, nr_dequeuers);
366 printf_verbose("Writer delay : %lu loops.\n", rduration);
367 printf_verbose("Reader duration : %lu loops.\n", wdelay);
368 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
369 "main", pthread_self(), (unsigned long)gettid());
370
371 tid_enqueuer = malloc(sizeof(*tid_enqueuer) * nr_enqueuers);
372 tid_dequeuer = malloc(sizeof(*tid_dequeuer) * nr_dequeuers);
373 count_enqueuer = malloc(2 * sizeof(*count_enqueuer) * nr_enqueuers);
374 count_dequeuer = malloc(2 * sizeof(*count_dequeuer) * nr_dequeuers);
16aa9ee8 375 cds_lfs_init_rcu(&s);
94aec122 376 err = create_all_cpu_call_rcu_data(0);
8bcbd94a
MD
377 if (err) {
378 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
379 }
453629a9
MD
380
381 next_aff = 0;
382
383 for (i = 0; i < nr_enqueuers; i++) {
384 err = pthread_create(&tid_enqueuer[i], NULL, thr_enqueuer,
385 &count_enqueuer[2 * i]);
386 if (err != 0)
387 exit(1);
388 }
389 for (i = 0; i < nr_dequeuers; i++) {
390 err = pthread_create(&tid_dequeuer[i], NULL, thr_dequeuer,
391 &count_dequeuer[2 * i]);
392 if (err != 0)
393 exit(1);
394 }
395
5481ddb3 396 cmm_smp_mb();
453629a9
MD
397
398 test_go = 1;
399
400 for (i = 0; i < duration; i++) {
401 sleep(1);
402 if (verbose_mode)
403 write (1, ".", 1);
404 }
405
406 test_stop = 1;
407
408 for (i = 0; i < nr_enqueuers; i++) {
409 err = pthread_join(tid_enqueuer[i], &tret);
410 if (err != 0)
411 exit(1);
412 tot_enqueues += count_enqueuer[2 * i];
413 tot_successful_enqueues += count_enqueuer[2 * i + 1];
414 }
415 for (i = 0; i < nr_dequeuers; i++) {
416 err = pthread_join(tid_dequeuer[i], &tret);
417 if (err != 0)
418 exit(1);
419 tot_dequeues += count_dequeuer[2 * i];
420 tot_successful_dequeues += count_dequeuer[2 * i + 1];
421 }
422
423 test_end(&s, &end_dequeues);
424
425 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
426 tot_enqueues, tot_dequeues);
427 printf_verbose("total number of successful enqueues : %llu, "
428 "successful dequeues %llu\n",
429 tot_successful_enqueues, tot_successful_dequeues);
430 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
431 "nr_dequeuers %3u "
432 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
433 "successful enqueues %12llu successful dequeues %12llu "
434 "end_dequeues %llu nr_ops %12llu\n",
435 argv[0], duration, nr_enqueuers, wdelay,
436 nr_dequeuers, rduration, tot_enqueues, tot_dequeues,
437 tot_successful_enqueues,
438 tot_successful_dequeues, end_dequeues,
439 tot_enqueues + tot_dequeues);
440 if (tot_successful_enqueues != tot_successful_dequeues + end_dequeues)
441 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
442 "succ. dequeues + end dequeues %llu.\n",
443 tot_successful_enqueues,
444 tot_successful_dequeues + end_dequeues);
445
0938c541 446 free_all_cpu_call_rcu_data();
453629a9
MD
447 free(count_enqueuer);
448 free(count_dequeuer);
449 free(tid_enqueuer);
450 free(tid_dequeuer);
451 return 0;
452}
This page took 0.0425 seconds and 4 git commands to generate.