Add wait-free push/blocking pop stack
[urcu.git] / tests / test_urcu_wfs.c
CommitLineData
a5eb5ffc
MD
1/*
2 * test_urcu_wfs.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>
37#include <sys/syscall.h>
38#include <sched.h>
39#include <errno.h>
40
41#include <urcu/arch.h>
42
43/* hardcoded number of CPUs */
44#define NR_CPUS 16384
45
46#if defined(_syscall0)
47_syscall0(pid_t, gettid)
48#elif defined(__NR_gettid)
49static inline pid_t gettid(void)
50{
51 return syscall(__NR_gettid);
52}
53#else
54#warning "use pid as tid"
55static inline pid_t gettid(void)
56{
57 return getpid();
58}
59#endif
60
61#ifndef DYNAMIC_LINK_TEST
62#define _LGPL_SOURCE
63#endif
64#include <urcu.h>
65#include <urcu/rcuwfstack.h>
66#include <urcu-defer.h>
67
68static volatile int test_go, test_stop;
69
70static unsigned long rduration;
71
72static unsigned long duration;
73
74/* read-side C.S. duration, in loops */
75static unsigned long wdelay;
76
77static inline void loop_sleep(unsigned long l)
78{
79 while(l-- != 0)
80 cpu_relax();
81}
82
83static int verbose_mode;
84
85#define printf_verbose(fmt, args...) \
86 do { \
87 if (verbose_mode) \
88 printf(fmt, args); \
89 } while (0)
90
91static unsigned int cpu_affinities[NR_CPUS];
92static unsigned int next_aff = 0;
93static int use_affinity = 0;
94
95pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
96
97#ifndef HAVE_CPU_SET_T
98typedef unsigned long cpu_set_t;
99# define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
100# define CPU_SET(cpu, cpuset) do { *(cpuset) |= (1UL << (cpu)); } while(0)
101#endif
102
103static void set_affinity(void)
104{
105 cpu_set_t mask;
106 int cpu;
107 int ret;
108
109 if (!use_affinity)
110 return;
111
112#if HAVE_SCHED_SETAFFINITY
113 ret = pthread_mutex_lock(&affinity_mutex);
114 if (ret) {
115 perror("Error in pthread mutex lock");
116 exit(-1);
117 }
118 cpu = cpu_affinities[next_aff++];
119 ret = pthread_mutex_unlock(&affinity_mutex);
120 if (ret) {
121 perror("Error in pthread mutex unlock");
122 exit(-1);
123 }
124
125 CPU_ZERO(&mask);
126 CPU_SET(cpu, &mask);
127#if SCHED_SETAFFINITY_ARGS == 2
128 sched_setaffinity(0, &mask);
129#else
130 sched_setaffinity(0, sizeof(mask), &mask);
131#endif
132#endif /* HAVE_SCHED_SETAFFINITY */
133}
134
135/*
136 * returns 0 if test should end.
137 */
138static int test_duration_dequeue(void)
139{
140 return !test_stop;
141}
142
143static int test_duration_enqueue(void)
144{
145 return !test_stop;
146}
147
148static unsigned long long __thread nr_dequeues;
149static unsigned long long __thread nr_enqueues;
150
151static unsigned long long __thread nr_successful_dequeues;
152static unsigned long long __thread nr_successful_enqueues;
153
154static unsigned int nr_enqueuers;
155static unsigned int nr_dequeuers;
156
157static struct rcu_wfs_stack s;
158
159void *thr_enqueuer(void *_count)
160{
161 unsigned long long *count = _count;
162
163 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
164 "enqueuer", pthread_self(), (unsigned long)gettid());
165
166 set_affinity();
167
168 rcu_register_thread();
169
170 while (!test_go)
171 {
172 }
173 smp_mb();
174
175 for (;;) {
176 struct rcu_wfs_node *node = malloc(sizeof(*node));
177 if (!node)
178 goto fail;
179 rcu_wfs_node_init(node);
180 rcu_wfs_push(&s, node);
181 nr_successful_enqueues++;
182
183 if (unlikely(wdelay))
184 loop_sleep(wdelay);
185fail:
186 nr_enqueues++;
187 if (unlikely(!test_duration_enqueue()))
188 break;
189 }
190
191 rcu_unregister_thread();
192
193 count[0] = nr_enqueues;
194 count[1] = nr_successful_enqueues;
195 printf_verbose("enqueuer thread_end, thread id : %lx, tid %lu, "
196 "enqueues %llu successful_enqueues %llu\n",
197 pthread_self(), (unsigned long)gettid(), nr_enqueues,
198 nr_successful_enqueues);
199 return ((void*)1);
200
201}
202
203void *thr_dequeuer(void *_count)
204{
205 unsigned long long *count = _count;
206
207 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
208 "dequeuer", pthread_self(), (unsigned long)gettid());
209
210 set_affinity();
211
212 rcu_defer_register_thread();
213 rcu_register_thread();
214
215 while (!test_go)
216 {
217 }
218 smp_mb();
219
220 for (;;) {
221 struct rcu_wfs_node *node = rcu_wfs_pop(&s);
222
223 if (node) {
224 defer_rcu(free, node);
225 nr_successful_dequeues++;
226 }
227
228 nr_dequeues++;
229 if (unlikely(!test_duration_dequeue()))
230 break;
231 if (unlikely(rduration))
232 loop_sleep(rduration);
233 }
234
235 rcu_unregister_thread();
236 rcu_defer_unregister_thread();
237
238 printf_verbose("dequeuer thread_end, thread id : %lx, tid %lu, "
239 "dequeues %llu, successful_dequeues %llu\n",
240 pthread_self(), (unsigned long)gettid(), nr_dequeues,
241 nr_successful_dequeues);
242 count[0] = nr_dequeues;
243 count[1] = nr_successful_dequeues;
244 return ((void*)2);
245}
246
247void test_end(struct rcu_wfs_stack *s, unsigned long long *nr_dequeues)
248{
249 struct rcu_wfs_node *node;
250
251 do {
252 node = rcu_wfs_pop(s);
253 if (node) {
254 free(node);
255 (*nr_dequeues)++;
256 }
257 } while (node);
258}
259
260void show_usage(int argc, char **argv)
261{
262 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s)", argv[0]);
263 printf(" [-d delay] (enqueuer period (in loops))");
264 printf(" [-c duration] (dequeuer period (in loops))");
265 printf(" [-v] (verbose output)");
266 printf(" [-a cpu#] [-a cpu#]... (affinity)");
267 printf("\n");
268}
269
270int main(int argc, char **argv)
271{
272 int err;
273 pthread_t *tid_enqueuer, *tid_dequeuer;
274 void *tret;
275 unsigned long long *count_enqueuer, *count_dequeuer;
276 unsigned long long tot_enqueues = 0, tot_dequeues = 0;
277 unsigned long long tot_successful_enqueues = 0,
278 tot_successful_dequeues = 0;
279 unsigned long long end_dequeues = 0;
280 int i, a;
281
282 if (argc < 4) {
283 show_usage(argc, argv);
284 return -1;
285 }
286
287 err = sscanf(argv[1], "%u", &nr_dequeuers);
288 if (err != 1) {
289 show_usage(argc, argv);
290 return -1;
291 }
292
293 err = sscanf(argv[2], "%u", &nr_enqueuers);
294 if (err != 1) {
295 show_usage(argc, argv);
296 return -1;
297 }
298
299 err = sscanf(argv[3], "%lu", &duration);
300 if (err != 1) {
301 show_usage(argc, argv);
302 return -1;
303 }
304
305 for (i = 4; i < argc; i++) {
306 if (argv[i][0] != '-')
307 continue;
308 switch (argv[i][1]) {
309 case 'a':
310 if (argc < i + 2) {
311 show_usage(argc, argv);
312 return -1;
313 }
314 a = atoi(argv[++i]);
315 cpu_affinities[next_aff++] = a;
316 use_affinity = 1;
317 printf_verbose("Adding CPU %d affinity\n", a);
318 break;
319 case 'c':
320 if (argc < i + 2) {
321 show_usage(argc, argv);
322 return -1;
323 }
324 rduration = atol(argv[++i]);
325 break;
326 case 'd':
327 if (argc < i + 2) {
328 show_usage(argc, argv);
329 return -1;
330 }
331 wdelay = atol(argv[++i]);
332 break;
333 case 'v':
334 verbose_mode = 1;
335 break;
336 }
337 }
338
339 printf_verbose("running test for %lu seconds, %u enqueuers, "
340 "%u dequeuers.\n",
341 duration, nr_enqueuers, nr_dequeuers);
342 printf_verbose("Writer delay : %lu loops.\n", rduration);
343 printf_verbose("Reader duration : %lu loops.\n", wdelay);
344 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
345 "main", pthread_self(), (unsigned long)gettid());
346
347 tid_enqueuer = malloc(sizeof(*tid_enqueuer) * nr_enqueuers);
348 tid_dequeuer = malloc(sizeof(*tid_dequeuer) * nr_dequeuers);
349 count_enqueuer = malloc(2 * sizeof(*count_enqueuer) * nr_enqueuers);
350 count_dequeuer = malloc(2 * sizeof(*count_dequeuer) * nr_dequeuers);
351 rcu_wfs_init(&s);
352
353 next_aff = 0;
354
355 for (i = 0; i < nr_enqueuers; i++) {
356 err = pthread_create(&tid_enqueuer[i], NULL, thr_enqueuer,
357 &count_enqueuer[2 * i]);
358 if (err != 0)
359 exit(1);
360 }
361 for (i = 0; i < nr_dequeuers; i++) {
362 err = pthread_create(&tid_dequeuer[i], NULL, thr_dequeuer,
363 &count_dequeuer[2 * i]);
364 if (err != 0)
365 exit(1);
366 }
367
368 smp_mb();
369
370 test_go = 1;
371
372 for (i = 0; i < duration; i++) {
373 sleep(1);
374 if (verbose_mode)
375 write (1, ".", 1);
376 }
377
378 test_stop = 1;
379
380 for (i = 0; i < nr_enqueuers; i++) {
381 err = pthread_join(tid_enqueuer[i], &tret);
382 if (err != 0)
383 exit(1);
384 tot_enqueues += count_enqueuer[2 * i];
385 tot_successful_enqueues += count_enqueuer[2 * i + 1];
386 }
387 for (i = 0; i < nr_dequeuers; i++) {
388 err = pthread_join(tid_dequeuer[i], &tret);
389 if (err != 0)
390 exit(1);
391 tot_dequeues += count_dequeuer[2 * i];
392 tot_successful_dequeues += count_dequeuer[2 * i + 1];
393 }
394
395 test_end(&s, &end_dequeues);
396
397 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
398 tot_enqueues, tot_dequeues);
399 printf_verbose("total number of successful enqueues : %llu, "
400 "successful dequeues %llu\n",
401 tot_successful_enqueues, tot_successful_dequeues);
402 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
403 "nr_dequeuers %3u "
404 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
405 "successful enqueues %12llu successful dequeues %12llu "
406 "end_dequeues %llu nr_ops %12llu\n",
407 argv[0], duration, nr_enqueuers, wdelay,
408 nr_dequeuers, rduration, tot_enqueues, tot_dequeues,
409 tot_successful_enqueues,
410 tot_successful_dequeues, end_dequeues,
411 tot_enqueues + tot_dequeues);
412 if (tot_successful_enqueues != tot_successful_dequeues + end_dequeues)
413 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
414 "succ. dequeues + end dequeues %llu.\n",
415 tot_successful_enqueues,
416 tot_successful_dequeues + end_dequeues);
417
418 free(count_enqueuer);
419 free(count_dequeuer);
420 free(tid_enqueuer);
421 free(tid_dequeuer);
422 return 0;
423}
This page took 0.055666 seconds and 4 git commands to generate.