wfcqueue: remove ancient comment
[urcu.git] / tests / test_urcu_assign.c
CommitLineData
074d8438
MD
1/*
2 * test_urcu_assign.c
3 *
4 * Userspace RCU library - test program
5 *
6982d6d7 6 * Copyright February 2009 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
074d8438
MD
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
d8540fc5 24#include "../config.h"
074d8438
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>
074d8438 34#include <sched.h>
94b343fd 35#include <errno.h>
074d8438
MD
36
37#include <urcu/arch.h>
bd252a04 38#include <urcu/tls-compat.h>
074d8438 39
65fcc7e9
MD
40#ifdef __linux__
41#include <syscall.h>
42#endif
43
074d8438
MD
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.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
31b598e0
MD
84/* write-side C.S. duration, in loops */
85static unsigned long wduration;
86
ab0aacbe 87static inline void loop_sleep(unsigned long loops)
074d8438 88{
ab0aacbe 89 while (loops-- != 0)
06f22bdb 90 caa_cpu_relax();
074d8438
MD
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
d8540fc5
PA
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
074d8438
MD
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
d8540fc5 122#if HAVE_SCHED_SETAFFINITY
074d8438
MD
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 }
d8540fc5 134
074d8438
MD
135 CPU_ZERO(&mask);
136 CPU_SET(cpu, &mask);
d8540fc5
PA
137#if SCHED_SETAFFINITY_ARGS == 2
138 sched_setaffinity(0, &mask);
139#else
074d8438 140 sched_setaffinity(0, sizeof(mask), &mask);
d8540fc5
PA
141#endif
142#endif /* HAVE_SCHED_SETAFFINITY */
074d8438
MD
143}
144
145/*
146 * returns 0 if test should end.
147 */
148static int test_duration_write(void)
149{
150 return !test_stop;
151}
152
153static int test_duration_read(void)
154{
155 return !test_stop;
156}
157
bd252a04
MD
158static DEFINE_URCU_TLS(unsigned long long, nr_writes);
159static DEFINE_URCU_TLS(unsigned long long, nr_reads);
074d8438
MD
160
161static unsigned int nr_readers;
162static unsigned int nr_writers;
163
164pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
165
166void rcu_copy_mutex_lock(void)
167{
168 int ret;
169 ret = pthread_mutex_lock(&rcu_copy_mutex);
170 if (ret) {
171 perror("Error in pthread mutex lock");
172 exit(-1);
173 }
174}
175
176void rcu_copy_mutex_unlock(void)
177{
178 int ret;
179
180 ret = pthread_mutex_unlock(&rcu_copy_mutex);
181 if (ret) {
182 perror("Error in pthread mutex unlock");
183 exit(-1);
184 }
185}
186
187/*
188 * malloc/free are reusing memory areas too quickly, which does not let us
189 * test races appropriately. Use a large circular array for allocations.
d4267b0b
MD
190 * ARRAY_SIZE is larger than nr_writers, and we keep the mutex across
191 * both alloc and free, which insures we never run over our tail.
074d8438
MD
192 */
193#define ARRAY_SIZE (1048576 * nr_writers)
194#define ARRAY_POISON 0xDEADBEEF
195static int array_index;
196static struct test_array *test_array;
197
198static struct test_array *test_array_alloc(void)
199{
200 struct test_array *ret;
201 int index;
202
074d8438
MD
203 index = array_index % ARRAY_SIZE;
204 assert(test_array[index].a == ARRAY_POISON ||
205 test_array[index].a == 0);
206 ret = &test_array[index];
207 array_index++;
208 if (array_index == ARRAY_SIZE)
209 array_index = 0;
074d8438
MD
210 return ret;
211}
212
213static void test_array_free(struct test_array *ptr)
214{
215 if (!ptr)
216 return;
074d8438 217 ptr->a = ARRAY_POISON;
074d8438
MD
218}
219
220void *thr_reader(void *_count)
221{
222 unsigned long long *count = _count;
223 struct test_array *local_ptr;
224
225 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
226 "reader", pthread_self(), (unsigned long)gettid());
227
228 set_affinity();
229
230 rcu_register_thread();
231
232 while (!test_go)
233 {
234 }
5481ddb3 235 cmm_smp_mb();
074d8438
MD
236
237 for (;;) {
238 rcu_read_lock();
239 local_ptr = rcu_dereference(test_rcu_pointer);
240 debug_yield_read();
241 if (local_ptr)
242 assert(local_ptr->a == 8);
a0b7f7ea 243 if (caa_unlikely(rduration))
074d8438
MD
244 loop_sleep(rduration);
245 rcu_read_unlock();
bd252a04 246 URCU_TLS(nr_reads)++;
a0b7f7ea 247 if (caa_unlikely(!test_duration_read()))
074d8438
MD
248 break;
249 }
250
251 rcu_unregister_thread();
252
bd252a04 253 *count = URCU_TLS(nr_reads);
074d8438
MD
254 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
255 "reader", pthread_self(), (unsigned long)gettid());
256 return ((void*)1);
257
258}
259
260void *thr_writer(void *_count)
261{
262 unsigned long long *count = _count;
263 struct test_array *new, *old;
264
265 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
266 "writer", pthread_self(), (unsigned long)gettid());
267
268 set_affinity();
269
270 while (!test_go)
271 {
272 }
5481ddb3 273 cmm_smp_mb();
074d8438
MD
274
275 for (;;) {
d4267b0b 276 rcu_copy_mutex_lock();
074d8438
MD
277 new = test_array_alloc();
278 new->a = 8;
074d8438
MD
279 old = test_rcu_pointer;
280 rcu_assign_pointer(test_rcu_pointer, new);
a0b7f7ea 281 if (caa_unlikely(wduration))
31b598e0 282 loop_sleep(wduration);
074d8438
MD
283 synchronize_rcu();
284 if (old)
285 old->a = 0;
286 test_array_free(old);
d4267b0b 287 rcu_copy_mutex_unlock();
bd252a04 288 URCU_TLS(nr_writes)++;
a0b7f7ea 289 if (caa_unlikely(!test_duration_write()))
074d8438 290 break;
a0b7f7ea 291 if (caa_unlikely(wdelay))
074d8438
MD
292 loop_sleep(wdelay);
293 }
294
295 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
296 "writer", pthread_self(), (unsigned long)gettid());
bd252a04 297 *count = URCU_TLS(nr_writes);
074d8438
MD
298 return ((void*)2);
299}
300
301void show_usage(int argc, char **argv)
302{
303 printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
304#ifdef DEBUG_YIELD
305 printf(" [-r] [-w] (yield reader and/or writer)");
306#endif
307 printf(" [-d delay] (writer period (us))");
308 printf(" [-c duration] (reader C.S. duration (in loops))");
31b598e0 309 printf(" [-e duration] (writer C.S. duration (in loops))");
074d8438
MD
310 printf(" [-v] (verbose output)");
311 printf(" [-a cpu#] [-a cpu#]... (affinity)");
312 printf("\n");
313}
314
315int main(int argc, char **argv)
316{
317 int err;
318 pthread_t *tid_reader, *tid_writer;
319 void *tret;
320 unsigned long long *count_reader, *count_writer;
321 unsigned long long tot_reads = 0, tot_writes = 0;
322 int i, a;
323
324 if (argc < 4) {
325 show_usage(argc, argv);
326 return -1;
327 }
328
329 err = sscanf(argv[1], "%u", &nr_readers);
330 if (err != 1) {
331 show_usage(argc, argv);
332 return -1;
333 }
334
335 err = sscanf(argv[2], "%u", &nr_writers);
336 if (err != 1) {
337 show_usage(argc, argv);
338 return -1;
339 }
340
341 err = sscanf(argv[3], "%lu", &duration);
342 if (err != 1) {
343 show_usage(argc, argv);
344 return -1;
345 }
346
347 for (i = 4; i < argc; i++) {
348 if (argv[i][0] != '-')
349 continue;
350 switch (argv[i][1]) {
351#ifdef DEBUG_YIELD
352 case 'r':
353 yield_active |= YIELD_READ;
354 break;
355 case 'w':
356 yield_active |= YIELD_WRITE;
357 break;
358#endif
359 case 'a':
360 if (argc < i + 2) {
361 show_usage(argc, argv);
362 return -1;
363 }
364 a = atoi(argv[++i]);
365 cpu_affinities[next_aff++] = a;
366 use_affinity = 1;
367 printf_verbose("Adding CPU %d affinity\n", a);
368 break;
369 case 'c':
370 if (argc < i + 2) {
371 show_usage(argc, argv);
372 return -1;
373 }
374 rduration = atol(argv[++i]);
375 break;
376 case 'd':
377 if (argc < i + 2) {
378 show_usage(argc, argv);
379 return -1;
380 }
381 wdelay = atol(argv[++i]);
382 break;
31b598e0
MD
383 case 'e':
384 if (argc < i + 2) {
385 show_usage(argc, argv);
386 return -1;
387 }
388 wduration = atol(argv[++i]);
389 break;
074d8438
MD
390 case 'v':
391 verbose_mode = 1;
392 break;
393 }
394 }
395
396 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
397 duration, nr_readers, nr_writers);
398 printf_verbose("Writer delay : %lu loops.\n", wdelay);
399 printf_verbose("Reader duration : %lu loops.\n", rduration);
400 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
401 "main", pthread_self(), (unsigned long)gettid());
402
92e8d9d6 403 test_array = calloc(1, sizeof(*test_array) * ARRAY_SIZE);
074d8438
MD
404 tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
405 tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
406 count_reader = malloc(sizeof(*count_reader) * nr_readers);
407 count_writer = malloc(sizeof(*count_writer) * nr_writers);
408
409 next_aff = 0;
410
411 for (i = 0; i < nr_readers; i++) {
412 err = pthread_create(&tid_reader[i], NULL, thr_reader,
413 &count_reader[i]);
414 if (err != 0)
415 exit(1);
416 }
417 for (i = 0; i < nr_writers; i++) {
418 err = pthread_create(&tid_writer[i], NULL, thr_writer,
419 &count_writer[i]);
420 if (err != 0)
421 exit(1);
422 }
423
5481ddb3 424 cmm_smp_mb();
074d8438
MD
425
426 test_go = 1;
427
428 sleep(duration);
429
430 test_stop = 1;
431
432 for (i = 0; i < nr_readers; i++) {
433 err = pthread_join(tid_reader[i], &tret);
434 if (err != 0)
435 exit(1);
436 tot_reads += count_reader[i];
437 }
438 for (i = 0; i < nr_writers; i++) {
439 err = pthread_join(tid_writer[i], &tret);
440 if (err != 0)
441 exit(1);
442 tot_writes += count_writer[i];
443 }
444
445 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
446 tot_writes);
a50a7b43 447 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
074d8438
MD
448 "nr_writers %3u "
449 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
a50a7b43 450 argv[0], duration, nr_readers, rduration, wduration,
074d8438
MD
451 nr_writers, wdelay, tot_reads, tot_writes,
452 tot_reads + tot_writes);
453 test_array_free(test_rcu_pointer);
454 free(test_array);
455 free(tid_reader);
456 free(tid_writer);
457 free(count_reader);
458 free(count_writer);
459 return 0;
460}
This page took 0.068411 seconds and 4 git commands to generate.