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