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