Deprecate rculfstack
[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>
37#include <sched.h>
38#include <errno.h>
39
40#include <urcu/arch.h>
41#include <urcu/tls-compat.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
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
104#ifndef HAVE_CPU_SET_T
105typedef unsigned long cpu_set_t;
106# define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
107# define CPU_SET(cpu, cpuset) do { *(cpuset) |= (1UL << (cpu)); } while(0)
108#endif
109
110static void set_affinity(void)
111{
112 cpu_set_t mask;
113 int cpu;
114 int ret;
115
116 if (!use_affinity)
117 return;
118
119#if HAVE_SCHED_SETAFFINITY
120 ret = pthread_mutex_lock(&affinity_mutex);
121 if (ret) {
122 perror("Error in pthread mutex lock");
123 exit(-1);
124 }
125 cpu = cpu_affinities[next_aff++];
126 ret = pthread_mutex_unlock(&affinity_mutex);
127 if (ret) {
128 perror("Error in pthread mutex unlock");
129 exit(-1);
130 }
131
132 CPU_ZERO(&mask);
133 CPU_SET(cpu, &mask);
134#if SCHED_SETAFFINITY_ARGS == 2
135 sched_setaffinity(0, &mask);
136#else
137 sched_setaffinity(0, sizeof(mask), &mask);
138#endif
139#endif /* HAVE_SCHED_SETAFFINITY */
140}
141
142/*
143 * returns 0 if test should end.
144 */
145static int test_duration_dequeue(void)
146{
147 return !test_stop;
148}
149
150static int test_duration_enqueue(void)
151{
152 return !test_stop;
153}
154
155static DEFINE_URCU_TLS(unsigned long long, nr_dequeues);
156static DEFINE_URCU_TLS(unsigned long long, nr_enqueues);
157
158static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues);
159static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues);
160
161static unsigned int nr_enqueuers;
162static unsigned int nr_dequeuers;
163
164struct test {
165 struct cds_lfs_node_rcu list;
166 struct rcu_head rcu;
167};
168
169static struct cds_lfs_stack_rcu s;
170
171void *thr_enqueuer(void *_count)
172{
173 unsigned long long *count = _count;
174
175 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
176 "enqueuer", pthread_self(), (unsigned long)gettid());
177
178 set_affinity();
179
180 rcu_register_thread();
181
182 while (!test_go)
183 {
184 }
185 cmm_smp_mb();
186
187 for (;;) {
188 struct test *node = malloc(sizeof(*node));
189 if (!node)
190 goto fail;
191 cds_lfs_node_init_rcu(&node->list);
192 /* No rcu read-side is needed for push */
193 cds_lfs_push_rcu(&s, &node->list);
194 URCU_TLS(nr_successful_enqueues)++;
195
196 if (caa_unlikely(wdelay))
197 loop_sleep(wdelay);
198fail:
199 URCU_TLS(nr_enqueues)++;
200 if (caa_unlikely(!test_duration_enqueue()))
201 break;
202 }
203
204 rcu_unregister_thread();
205
206 count[0] = URCU_TLS(nr_enqueues);
207 count[1] = URCU_TLS(nr_successful_enqueues);
208 printf_verbose("enqueuer thread_end, thread id : %lx, tid %lu, "
209 "enqueues %llu successful_enqueues %llu\n",
210 pthread_self(), (unsigned long)gettid(),
211 URCU_TLS(nr_enqueues), URCU_TLS(nr_successful_enqueues));
212 return ((void*)1);
213
214}
215
216static
217void free_node_cb(struct rcu_head *head)
218{
219 struct test *node =
220 caa_container_of(head, struct test, rcu);
221 free(node);
222}
223
224void *thr_dequeuer(void *_count)
225{
226 unsigned long long *count = _count;
227
228 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
229 "dequeuer", pthread_self(), (unsigned long)gettid());
230
231 set_affinity();
232
233 rcu_register_thread();
234
235 while (!test_go)
236 {
237 }
238 cmm_smp_mb();
239
240 for (;;) {
241 struct cds_lfs_node_rcu *snode;
242
243 rcu_read_lock();
244 snode = cds_lfs_pop_rcu(&s);
245 rcu_read_unlock();
246 if (snode) {
247 struct test *node;
248
249 node = caa_container_of(snode, struct test, list);
250 call_rcu(&node->rcu, free_node_cb);
251 URCU_TLS(nr_successful_dequeues)++;
252 }
253 URCU_TLS(nr_dequeues)++;
254 if (caa_unlikely(!test_duration_dequeue()))
255 break;
256 if (caa_unlikely(rduration))
257 loop_sleep(rduration);
258 }
259
260 rcu_unregister_thread();
261
262 printf_verbose("dequeuer thread_end, thread id : %lx, tid %lu, "
263 "dequeues %llu, successful_dequeues %llu\n",
264 pthread_self(), (unsigned long)gettid(),
265 URCU_TLS(nr_dequeues), URCU_TLS(nr_successful_dequeues));
266 count[0] = URCU_TLS(nr_dequeues);
267 count[1] = URCU_TLS(nr_successful_dequeues);
268 return ((void*)2);
269}
270
271void test_end(struct cds_lfs_stack_rcu *s, unsigned long long *nr_dequeues)
272{
273 struct cds_lfs_node_rcu *snode;
274
275 do {
276 snode = cds_lfs_pop_rcu(s);
277 if (snode) {
278 struct test *node;
279
280 node = caa_container_of(snode, struct test, list);
281 free(node);
282 (*nr_dequeues)++;
283 }
284 } while (snode);
285}
286
287void show_usage(int argc, char **argv)
288{
289 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s)", argv[0]);
290 printf(" [-d delay] (enqueuer period (in loops))");
291 printf(" [-c duration] (dequeuer period (in loops))");
292 printf(" [-v] (verbose output)");
293 printf(" [-a cpu#] [-a cpu#]... (affinity)");
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",
372 "main", pthread_self(), (unsigned long)gettid());
373
374 tid_enqueuer = malloc(sizeof(*tid_enqueuer) * nr_enqueuers);
375 tid_dequeuer = malloc(sizeof(*tid_dequeuer) * nr_dequeuers);
376 count_enqueuer = malloc(2 * sizeof(*count_enqueuer) * nr_enqueuers);
377 count_dequeuer = malloc(2 * sizeof(*count_dequeuer) * nr_dequeuers);
378 cds_lfs_init_rcu(&s);
379 err = create_all_cpu_call_rcu_data(0);
380 if (err) {
381 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
382 }
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(&s, &end_dequeues);
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_all_cpu_call_rcu_data();
450 free(count_enqueuer);
451 free(count_dequeuer);
452 free(tid_enqueuer);
453 free(tid_dequeuer);
454 return 0;
455}
This page took 0.037662 seconds and 4 git commands to generate.