Rename likely/unlikely to caa_likely/caa_unlikely
[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>
38
65fcc7e9
MD
39#ifdef __linux__
40#include <syscall.h>
41#endif
42
074d8438
MD
43/* hardcoded number of CPUs */
44#define NR_CPUS 16384
45
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
61#ifndef DYNAMIC_LINK_TEST
62#define _LGPL_SOURCE
63#else
64#define debug_yield_read()
65#endif
66#include <urcu.h>
67
68struct test_array {
69 int a;
70};
71
72static volatile int test_go, test_stop;
73
74static unsigned long wdelay;
75
76static struct test_array *test_rcu_pointer;
77
78static unsigned long duration;
79
80/* read-side C.S. duration, in loops */
81static unsigned long rduration;
82
31b598e0
MD
83/* write-side C.S. duration, in loops */
84static unsigned long wduration;
85
074d8438
MD
86static inline void loop_sleep(unsigned long l)
87{
88 while(l-- != 0)
06f22bdb 89 caa_cpu_relax();
074d8438
MD
90}
91
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
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
074d8438
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
074d8438
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
074d8438
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
074d8438 139 sched_setaffinity(0, sizeof(mask), &mask);
d8540fc5
PA
140#endif
141#endif /* HAVE_SCHED_SETAFFINITY */
074d8438
MD
142}
143
144/*
145 * returns 0 if test should end.
146 */
147static int test_duration_write(void)
148{
149 return !test_stop;
150}
151
152static int test_duration_read(void)
153{
154 return !test_stop;
155}
156
157static unsigned long long __thread nr_writes;
158static unsigned long long __thread nr_reads;
159
160static unsigned int nr_readers;
161static unsigned int nr_writers;
162
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}
185
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.
074d8438
MD
191 */
192#define ARRAY_SIZE (1048576 * nr_writers)
193#define ARRAY_POISON 0xDEADBEEF
194static int array_index;
195static struct test_array *test_array;
196
197static struct test_array *test_array_alloc(void)
198{
199 struct test_array *ret;
200 int index;
201
074d8438
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;
074d8438
MD
209 return ret;
210}
211
212static void test_array_free(struct test_array *ptr)
213{
214 if (!ptr)
215 return;
074d8438 216 ptr->a = ARRAY_POISON;
074d8438
MD
217}
218
219void *thr_reader(void *_count)
220{
221 unsigned long long *count = _count;
222 struct test_array *local_ptr;
223
224 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
225 "reader", pthread_self(), (unsigned long)gettid());
226
227 set_affinity();
228
229 rcu_register_thread();
230
231 while (!test_go)
232 {
233 }
5481ddb3 234 cmm_smp_mb();
074d8438
MD
235
236 for (;;) {
237 rcu_read_lock();
238 local_ptr = rcu_dereference(test_rcu_pointer);
239 debug_yield_read();
240 if (local_ptr)
241 assert(local_ptr->a == 8);
a0b7f7ea 242 if (caa_unlikely(rduration))
074d8438
MD
243 loop_sleep(rduration);
244 rcu_read_unlock();
245 nr_reads++;
a0b7f7ea 246 if (caa_unlikely(!test_duration_read()))
074d8438
MD
247 break;
248 }
249
250 rcu_unregister_thread();
251
252 *count = nr_reads;
253 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
254 "reader", pthread_self(), (unsigned long)gettid());
255 return ((void*)1);
256
257}
258
259void *thr_writer(void *_count)
260{
261 unsigned long long *count = _count;
262 struct test_array *new, *old;
263
264 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
265 "writer", pthread_self(), (unsigned long)gettid());
266
267 set_affinity();
268
269 while (!test_go)
270 {
271 }
5481ddb3 272 cmm_smp_mb();
074d8438
MD
273
274 for (;;) {
d4267b0b 275 rcu_copy_mutex_lock();
074d8438
MD
276 new = test_array_alloc();
277 new->a = 8;
074d8438
MD
278 old = test_rcu_pointer;
279 rcu_assign_pointer(test_rcu_pointer, new);
a0b7f7ea 280 if (caa_unlikely(wduration))
31b598e0 281 loop_sleep(wduration);
074d8438
MD
282 synchronize_rcu();
283 if (old)
284 old->a = 0;
285 test_array_free(old);
d4267b0b 286 rcu_copy_mutex_unlock();
074d8438 287 nr_writes++;
a0b7f7ea 288 if (caa_unlikely(!test_duration_write()))
074d8438 289 break;
a0b7f7ea 290 if (caa_unlikely(wdelay))
074d8438
MD
291 loop_sleep(wdelay);
292 }
293
294 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
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
306 printf(" [-d delay] (writer period (us))");
307 printf(" [-c duration] (reader C.S. duration (in loops))");
31b598e0 308 printf(" [-e duration] (writer C.S. duration (in loops))");
074d8438
MD
309 printf(" [-v] (verbose output)");
310 printf(" [-a cpu#] [-a cpu#]... (affinity)");
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;
321 int i, a;
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
358 case 'a':
359 if (argc < i + 2) {
360 show_usage(argc, argv);
361 return -1;
362 }
363 a = atoi(argv[++i]);
364 cpu_affinities[next_aff++] = a;
365 use_affinity = 1;
366 printf_verbose("Adding CPU %d affinity\n", a);
367 break;
368 case 'c':
369 if (argc < i + 2) {
370 show_usage(argc, argv);
371 return -1;
372 }
373 rduration = atol(argv[++i]);
374 break;
375 case 'd':
376 if (argc < i + 2) {
377 show_usage(argc, argv);
378 return -1;
379 }
380 wdelay = atol(argv[++i]);
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;
074d8438
MD
389 case 'v':
390 verbose_mode = 1;
391 break;
392 }
393 }
394
395 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
396 duration, nr_readers, nr_writers);
397 printf_verbose("Writer delay : %lu loops.\n", wdelay);
398 printf_verbose("Reader duration : %lu loops.\n", rduration);
399 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
400 "main", pthread_self(), (unsigned long)gettid());
401
92e8d9d6 402 test_array = calloc(1, sizeof(*test_array) * ARRAY_SIZE);
074d8438
MD
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
408 next_aff = 0;
409
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
5481ddb3 423 cmm_smp_mb();
074d8438
MD
424
425 test_go = 1;
426
427 sleep(duration);
428
429 test_stop = 1;
430
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
444 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
445 tot_writes);
a50a7b43 446 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
074d8438
MD
447 "nr_writers %3u "
448 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
a50a7b43 449 argv[0], duration, nr_readers, rduration, wduration,
074d8438
MD
450 nr_writers, wdelay, tot_reads, tot_writes,
451 tot_reads + tot_writes);
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.042024 seconds and 4 git commands to generate.