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