Use urcu/tls-compat.h
[urcu.git] / tests / test_urcu_qsbr.c
CommitLineData
de10a585
MD
1/*
2 * test_urcu.c
3 *
4 * Userspace RCU library - test program
5 *
6 * Copyright February 2009 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 */
22
23#define _GNU_SOURCE
24#include "../config.h"
25#include <stdio.h>
26#include <pthread.h>
27#include <stdlib.h>
28#include <string.h>
29#include <sys/types.h>
30#include <sys/wait.h>
31#include <unistd.h>
32#include <stdio.h>
33#include <assert.h>
34#include <sched.h>
35#include <errno.h>
36
37#include <urcu/arch.h>
bd252a04 38#include <urcu/tls-compat.h>
de10a585
MD
39
40#ifdef __linux__
41#include <syscall.h>
42#endif
43
44/* hardcoded number of CPUs */
45#define NR_CPUS 16384
46
47#if defined(_syscall0)
48_syscall0(pid_t, gettid)
49#elif defined(__NR_gettid)
50static inline pid_t gettid(void)
51{
52 return syscall(__NR_gettid);
53}
54#else
55#warning "use pid as tid"
56static inline pid_t gettid(void)
57{
58 return getpid();
59}
60#endif
61
62#ifndef DYNAMIC_LINK_TEST
63#define _LGPL_SOURCE
64#else
65#define debug_yield_read()
66#endif
67#include "urcu-qsbr.h"
68
69struct test_array {
70 int a;
71};
72
73static volatile int test_go, test_stop;
74
75static unsigned long wdelay;
76
77static struct test_array *test_rcu_pointer;
78
79static unsigned long duration;
80
81/* read-side C.S. duration, in loops */
82static unsigned long rduration;
83
84/* write-side C.S. duration, in loops */
85static unsigned long wduration;
86
87static inline void loop_sleep(unsigned long l)
88{
89 while(l-- != 0)
90 caa_cpu_relax();
91}
92
93static int verbose_mode;
94
95#define printf_verbose(fmt, args...) \
96 do { \
97 if (verbose_mode) \
98 printf(fmt, args); \
99 } while (0)
100
101static unsigned int cpu_affinities[NR_CPUS];
102static unsigned int next_aff = 0;
103static int use_affinity = 0;
104
105pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
106
107#ifndef HAVE_CPU_SET_T
108typedef unsigned long cpu_set_t;
109# define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
110# define CPU_SET(cpu, cpuset) do { *(cpuset) |= (1UL << (cpu)); } while(0)
111#endif
112
113static void set_affinity(void)
114{
115 cpu_set_t mask;
116 int cpu;
117 int ret;
118
119 if (!use_affinity)
120 return;
121
122#if HAVE_SCHED_SETAFFINITY
123 ret = pthread_mutex_lock(&affinity_mutex);
124 if (ret) {
125 perror("Error in pthread mutex lock");
126 exit(-1);
127 }
128 cpu = cpu_affinities[next_aff++];
129 ret = pthread_mutex_unlock(&affinity_mutex);
130 if (ret) {
131 perror("Error in pthread mutex unlock");
132 exit(-1);
133 }
134 CPU_ZERO(&mask);
135 CPU_SET(cpu, &mask);
136#if SCHED_SETAFFINITY_ARGS == 2
137 sched_setaffinity(0, &mask);
138#else
139 sched_setaffinity(0, sizeof(mask), &mask);
140#endif
141#endif /* HAVE_SCHED_SETAFFINITY */
142}
143
144/*
145 * returns 0 if test should end.
146 */
147static int test_duration_write(void)
148{
149 return !test_stop;
150}
151
152static int test_duration_read(void)
153{
154 return !test_stop;
155}
156
bd252a04
MD
157static DEFINE_URCU_TLS(unsigned long long, nr_writes);
158static DEFINE_URCU_TLS(unsigned long long, nr_reads);
de10a585
MD
159
160static unsigned int nr_readers;
161static unsigned int nr_writers;
162
163pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
164
165void rcu_copy_mutex_lock(void)
166{
167 int ret;
168 ret = pthread_mutex_lock(&rcu_copy_mutex);
169 if (ret) {
170 perror("Error in pthread mutex lock");
171 exit(-1);
172 }
173}
174
175void rcu_copy_mutex_unlock(void)
176{
177 int ret;
178
179 ret = pthread_mutex_unlock(&rcu_copy_mutex);
180 if (ret) {
181 perror("Error in pthread mutex unlock");
182 exit(-1);
183 }
184}
185
186/*
187 * malloc/free are reusing memory areas too quickly, which does not let us
188 * test races appropriately. Use a large circular array for allocations.
189 * ARRAY_SIZE is larger than nr_writers, and we keep the mutex across
190 * both alloc and free, which insures we never run over our tail.
191 */
192#define ARRAY_SIZE (1048576 * nr_writers)
193#define ARRAY_POISON 0xDEADBEEF
194static int array_index;
195static struct test_array *test_array;
196
197static struct test_array *test_array_alloc(void)
198{
199 struct test_array *ret;
200 int index;
201
202 index = array_index % ARRAY_SIZE;
203 assert(test_array[index].a == ARRAY_POISON ||
204 test_array[index].a == 0);
205 ret = &test_array[index];
206 array_index++;
207 if (array_index == ARRAY_SIZE)
208 array_index = 0;
209 return ret;
210}
211
212static void test_array_free(struct test_array *ptr)
213{
214 if (!ptr)
215 return;
216 ptr->a = ARRAY_POISON;
217}
218
219void *thr_reader(void *_count)
220{
221 unsigned long long *count = _count;
222 struct test_array *local_ptr;
223
224 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
225 "reader", pthread_self(), (unsigned long)gettid());
226
227 set_affinity();
228
229 rcu_register_thread();
230
231 while (!test_go)
232 {
233 }
234 cmm_smp_mb();
235
236 for (;;) {
237 rcu_read_lock();
238 local_ptr = rcu_dereference(test_rcu_pointer);
239 debug_yield_read();
240 if (local_ptr)
241 assert(local_ptr->a == 8);
a0b7f7ea 242 if (caa_unlikely(rduration))
de10a585
MD
243 loop_sleep(rduration);
244 rcu_read_unlock();
bd252a04 245 URCU_TLS(nr_reads)++;
de10a585 246 /* QS each 1024 reads */
bd252a04 247 if (caa_unlikely((URCU_TLS(nr_reads) & ((1 << 10) - 1)) == 0))
de10a585 248 rcu_quiescent_state();
a0b7f7ea 249 if (caa_unlikely(!test_duration_read()))
de10a585
MD
250 break;
251 }
252
253 rcu_unregister_thread();
254
255 /* test extra thread registration */
256 rcu_register_thread();
257 rcu_unregister_thread();
258
bd252a04 259 *count = URCU_TLS(nr_reads);
de10a585
MD
260 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
261 "reader", pthread_self(), (unsigned long)gettid());
262 return ((void*)1);
263
264}
265
266void *thr_writer(void *_count)
267{
268 unsigned long long *count = _count;
269 struct test_array *new, *old;
270
271 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
272 "writer", pthread_self(), (unsigned long)gettid());
273
274 set_affinity();
275
276 while (!test_go)
277 {
278 }
279 cmm_smp_mb();
280
281 for (;;) {
282 rcu_copy_mutex_lock();
283 new = test_array_alloc();
284 new->a = 8;
285 old = rcu_xchg_pointer(&test_rcu_pointer, new);
a0b7f7ea 286 if (caa_unlikely(wduration))
de10a585
MD
287 loop_sleep(wduration);
288 synchronize_rcu();
289 /* can be done after unlock */
290 if (old)
291 old->a = 0;
292 test_array_free(old);
293 rcu_copy_mutex_unlock();
bd252a04 294 URCU_TLS(nr_writes)++;
a0b7f7ea 295 if (caa_unlikely(!test_duration_write()))
de10a585 296 break;
a0b7f7ea 297 if (caa_unlikely(wdelay))
de10a585
MD
298 loop_sleep(wdelay);
299 }
300
301 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
302 "writer", pthread_self(), (unsigned long)gettid());
bd252a04 303 *count = URCU_TLS(nr_writes);
de10a585
MD
304 return ((void*)2);
305}
306
307void show_usage(int argc, char **argv)
308{
309 printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
310#ifdef DEBUG_YIELD
311 printf(" [-r] [-w] (yield reader and/or writer)");
312#endif
313 printf(" [-d delay] (writer period (us))");
314 printf(" [-c duration] (reader C.S. duration (in loops))");
315 printf(" [-e duration] (writer C.S. duration (in loops))");
316 printf(" [-v] (verbose output)");
317 printf(" [-a cpu#] [-a cpu#]... (affinity)");
318 printf("\n");
319}
320
321int main(int argc, char **argv)
322{
323 int err;
324 pthread_t *tid_reader, *tid_writer;
325 void *tret;
326 unsigned long long *count_reader, *count_writer;
327 unsigned long long tot_reads = 0, tot_writes = 0;
328 int i, a;
329
330 if (argc < 4) {
331 show_usage(argc, argv);
332 return -1;
333 }
334
335 err = sscanf(argv[1], "%u", &nr_readers);
336 if (err != 1) {
337 show_usage(argc, argv);
338 return -1;
339 }
340
341 err = sscanf(argv[2], "%u", &nr_writers);
342 if (err != 1) {
343 show_usage(argc, argv);
344 return -1;
345 }
346
347 err = sscanf(argv[3], "%lu", &duration);
348 if (err != 1) {
349 show_usage(argc, argv);
350 return -1;
351 }
352
353 for (i = 4; i < argc; i++) {
354 if (argv[i][0] != '-')
355 continue;
356 switch (argv[i][1]) {
357#ifdef DEBUG_YIELD
358 case 'r':
359 yield_active |= YIELD_READ;
360 break;
361 case 'w':
362 yield_active |= YIELD_WRITE;
363 break;
364#endif
365 case 'a':
366 if (argc < i + 2) {
367 show_usage(argc, argv);
368 return -1;
369 }
370 a = atoi(argv[++i]);
371 cpu_affinities[next_aff++] = a;
372 use_affinity = 1;
373 printf_verbose("Adding CPU %d affinity\n", a);
374 break;
375 case 'c':
376 if (argc < i + 2) {
377 show_usage(argc, argv);
378 return -1;
379 }
380 rduration = atol(argv[++i]);
381 break;
382 case 'd':
383 if (argc < i + 2) {
384 show_usage(argc, argv);
385 return -1;
386 }
387 wdelay = atol(argv[++i]);
388 break;
389 case 'e':
390 if (argc < i + 2) {
391 show_usage(argc, argv);
392 return -1;
393 }
394 wduration = atol(argv[++i]);
395 break;
396 case 'v':
397 verbose_mode = 1;
398 break;
399 }
400 }
401
402 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
403 duration, nr_readers, nr_writers);
404 printf_verbose("Writer delay : %lu loops.\n", wdelay);
405 printf_verbose("Reader duration : %lu loops.\n", rduration);
406 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
407 "main", pthread_self(), (unsigned long)gettid());
408
409 test_array = calloc(1, sizeof(*test_array) * ARRAY_SIZE);
410 tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
411 tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
412 count_reader = malloc(sizeof(*count_reader) * nr_readers);
413 count_writer = malloc(sizeof(*count_writer) * nr_writers);
414
415 next_aff = 0;
416
417 for (i = 0; i < nr_readers; i++) {
418 err = pthread_create(&tid_reader[i], NULL, thr_reader,
419 &count_reader[i]);
420 if (err != 0)
421 exit(1);
422 }
423 for (i = 0; i < nr_writers; i++) {
424 err = pthread_create(&tid_writer[i], NULL, thr_writer,
425 &count_writer[i]);
426 if (err != 0)
427 exit(1);
428 }
429
430 cmm_smp_mb();
431
432 test_go = 1;
433
434 sleep(duration);
435
436 test_stop = 1;
437
438 for (i = 0; i < nr_readers; i++) {
439 err = pthread_join(tid_reader[i], &tret);
440 if (err != 0)
441 exit(1);
442 tot_reads += count_reader[i];
443 }
444 for (i = 0; i < nr_writers; i++) {
445 err = pthread_join(tid_writer[i], &tret);
446 if (err != 0)
447 exit(1);
448 tot_writes += count_writer[i];
449 }
450
451 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
452 tot_writes);
453 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
454 "nr_writers %3u "
455 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
456 argv[0], duration, nr_readers, rduration, wduration,
457 nr_writers, wdelay, tot_reads, tot_writes,
458 tot_reads + tot_writes);
459 test_array_free(test_rcu_pointer);
460 free(test_array);
461 free(tid_reader);
462 free(tid_writer);
463 free(count_reader);
464 free(count_writer);
465 return 0;
466}
This page took 0.039107 seconds and 4 git commands to generate.