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