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