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