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