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