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