Test cleanup: replace "l" parameter by "loops"
[urcu.git] / tests / test_urcu_qsbr_gc.c
CommitLineData
de10a585
MD
1/*
2 * test_urcu_gc.c
3 *
4 * Userspace RCU library - test program (with baatch reclamation)
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 <sched.h>
35#include <errno.h>
36
37#include <urcu/arch.h>
bd252a04 38#include <urcu/tls-compat.h>
de10a585
MD
39
40#ifdef __linux__
41#include <syscall.h>
42#endif
43
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#define _LGPL_SOURCE
63#include <urcu-qsbr.h>
64
65struct test_array {
66 int a;
67};
68
69static volatile int test_go, test_stop;
70
71static unsigned long wdelay;
72
73static struct test_array *test_rcu_pointer;
74
75static unsigned long duration;
76
77/* read-side C.S. duration, in loops */
78static unsigned long rduration;
79static unsigned int reclaim_batch = 1;
80
81struct reclaim_queue {
82 void **queue; /* Beginning of queue */
83 void **head; /* Insert position */
84};
85
86static struct reclaim_queue *pending_reclaims;
87
88
89/* write-side C.S. duration, in loops */
90static unsigned long wduration;
91
ab0aacbe 92static inline void loop_sleep(unsigned long loops)
de10a585 93{
ab0aacbe 94 while (loops-- != 0)
de10a585
MD
95 caa_cpu_relax();
96}
97
98static int verbose_mode;
99
100#define printf_verbose(fmt, args...) \
101 do { \
102 if (verbose_mode) \
103 printf(fmt, args); \
104 } while (0)
105
106static unsigned int cpu_affinities[NR_CPUS];
107static unsigned int next_aff = 0;
108static int use_affinity = 0;
109
110pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
111
112#ifndef HAVE_CPU_SET_T
113typedef unsigned long cpu_set_t;
114# define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
115# define CPU_SET(cpu, cpuset) do { *(cpuset) |= (1UL << (cpu)); } while(0)
116#endif
117
118static void set_affinity(void)
119{
120 cpu_set_t mask;
121 int cpu;
122 int ret;
123
124 if (!use_affinity)
125 return;
126
127#if HAVE_SCHED_SETAFFINITY
128 ret = pthread_mutex_lock(&affinity_mutex);
129 if (ret) {
130 perror("Error in pthread mutex lock");
131 exit(-1);
132 }
133 cpu = cpu_affinities[next_aff++];
134 ret = pthread_mutex_unlock(&affinity_mutex);
135 if (ret) {
136 perror("Error in pthread mutex unlock");
137 exit(-1);
138 }
139
140 CPU_ZERO(&mask);
141 CPU_SET(cpu, &mask);
142#if SCHED_SETAFFINITY_ARGS == 2
143 sched_setaffinity(0, &mask);
144#else
145 sched_setaffinity(0, sizeof(mask), &mask);
146#endif
147#endif /* HAVE_SCHED_SETAFFINITY */
148}
149
150/*
151 * returns 0 if test should end.
152 */
153static int test_duration_write(void)
154{
155 return !test_stop;
156}
157
158static int test_duration_read(void)
159{
160 return !test_stop;
161}
162
bd252a04
MD
163static DEFINE_URCU_TLS(unsigned long long, nr_writes);
164static DEFINE_URCU_TLS(unsigned long long, nr_reads);
de10a585
MD
165
166static unsigned int nr_readers;
167static unsigned int nr_writers;
168
169pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
170static
171unsigned long long __attribute__((aligned(CAA_CACHE_LINE_SIZE))) *tot_nr_writes;
172
173
174void rcu_copy_mutex_lock(void)
175{
176 int ret;
177 ret = pthread_mutex_lock(&rcu_copy_mutex);
178 if (ret) {
179 perror("Error in pthread mutex lock");
180 exit(-1);
181 }
182}
183
184void rcu_copy_mutex_unlock(void)
185{
186 int ret;
187
188 ret = pthread_mutex_unlock(&rcu_copy_mutex);
189 if (ret) {
190 perror("Error in pthread mutex unlock");
191 exit(-1);
192 }
193}
194
195void *thr_reader(void *_count)
196{
197 unsigned long long *count = _count;
198 struct test_array *local_ptr;
199
200 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
201 "reader", pthread_self(), (unsigned long)gettid());
202
203 set_affinity();
204
205 rcu_register_thread();
206
207 while (!test_go)
208 {
209 }
210 cmm_smp_mb();
211
212 for (;;) {
213 _rcu_read_lock();
214 local_ptr = _rcu_dereference(test_rcu_pointer);
215 debug_yield_read();
216 if (local_ptr)
217 assert(local_ptr->a == 8);
a0b7f7ea 218 if (caa_unlikely(rduration))
de10a585
MD
219 loop_sleep(rduration);
220 _rcu_read_unlock();
bd252a04 221 URCU_TLS(nr_reads)++;
de10a585 222 /* QS each 1024 reads */
bd252a04 223 if (caa_unlikely((URCU_TLS(nr_reads) & ((1 << 10) - 1)) == 0))
de10a585 224 _rcu_quiescent_state();
a0b7f7ea 225 if (caa_unlikely(!test_duration_read()))
de10a585
MD
226 break;
227 }
228
229 rcu_unregister_thread();
230
bd252a04 231 *count = URCU_TLS(nr_reads);
de10a585
MD
232 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
233 "reader", pthread_self(), (unsigned long)gettid());
234 return ((void*)1);
235
236}
237
238static void rcu_gc_clear_queue(unsigned long wtidx)
239{
240 void **p;
241
242 /* Wait for Q.S and empty queue */
243 synchronize_rcu();
244
245 for (p = pending_reclaims[wtidx].queue;
246 p < pending_reclaims[wtidx].head; p++) {
247 /* poison */
248 if (*p)
249 ((struct test_array *)*p)->a = 0;
250 free(*p);
251 }
252 pending_reclaims[wtidx].head = pending_reclaims[wtidx].queue;
253}
254
255/* Using per-thread queue */
256static void rcu_gc_reclaim(unsigned long wtidx, void *old)
257{
258 /* Queue pointer */
259 *pending_reclaims[wtidx].head = old;
260 pending_reclaims[wtidx].head++;
261
a0b7f7ea 262 if (caa_likely(pending_reclaims[wtidx].head - pending_reclaims[wtidx].queue
de10a585
MD
263 < reclaim_batch))
264 return;
265
266 rcu_gc_clear_queue(wtidx);
267}
268
269void *thr_writer(void *data)
270{
271 unsigned long wtidx = (unsigned long)data;
272#ifdef TEST_LOCAL_GC
273 struct test_array *old = NULL;
274#else
275 struct test_array *new, *old;
276#endif
277
278 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
279 "writer", pthread_self(), (unsigned long)gettid());
280
281 set_affinity();
282
283 while (!test_go)
284 {
285 }
286 cmm_smp_mb();
287
288 for (;;) {
289#ifndef TEST_LOCAL_GC
290 new = malloc(sizeof(*new));
291 new->a = 8;
292 old = _rcu_xchg_pointer(&test_rcu_pointer, new);
293#endif
a0b7f7ea 294 if (caa_unlikely(wduration))
de10a585
MD
295 loop_sleep(wduration);
296 rcu_gc_reclaim(wtidx, old);
bd252a04 297 URCU_TLS(nr_writes)++;
a0b7f7ea 298 if (caa_unlikely(!test_duration_write()))
de10a585 299 break;
a0b7f7ea 300 if (caa_unlikely(wdelay))
de10a585
MD
301 loop_sleep(wdelay);
302 }
303
304 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
305 "writer", pthread_self(), (unsigned long)gettid());
bd252a04 306 tot_nr_writes[wtidx] = URCU_TLS(nr_writes);
de10a585
MD
307 return ((void*)2);
308}
309
310void show_usage(int argc, char **argv)
311{
312 printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
313#ifdef DEBUG_YIELD
314 printf(" [-r] [-w] (yield reader and/or writer)");
315#endif
316 printf(" [-b batch] (batch reclaim)");
317 printf(" [-d delay] (writer period (us))");
318 printf(" [-c duration] (reader C.S. duration (in loops))");
319 printf(" [-e duration] (writer C.S. duration (in loops))");
320 printf(" [-v] (verbose output)");
321 printf(" [-a cpu#] [-a cpu#]... (affinity)");
322 printf("\n");
323}
324
325int main(int argc, char **argv)
326{
327 int err;
328 pthread_t *tid_reader, *tid_writer;
329 void *tret;
330 unsigned long long *count_reader;
331 unsigned long long tot_reads = 0, tot_writes = 0;
332 int i, a;
333
334 if (argc < 4) {
335 show_usage(argc, argv);
336 return -1;
337 }
338
339 err = sscanf(argv[1], "%u", &nr_readers);
340 if (err != 1) {
341 show_usage(argc, argv);
342 return -1;
343 }
344
345 err = sscanf(argv[2], "%u", &nr_writers);
346 if (err != 1) {
347 show_usage(argc, argv);
348 return -1;
349 }
350
351 err = sscanf(argv[3], "%lu", &duration);
352 if (err != 1) {
353 show_usage(argc, argv);
354 return -1;
355 }
356
357 for (i = 4; i < argc; i++) {
358 if (argv[i][0] != '-')
359 continue;
360 switch (argv[i][1]) {
361#ifdef DEBUG_YIELD
362 case 'r':
363 yield_active |= YIELD_READ;
364 break;
365 case 'w':
366 yield_active |= YIELD_WRITE;
367 break;
368#endif
369 case 'a':
370 if (argc < i + 2) {
371 show_usage(argc, argv);
372 return -1;
373 }
374 a = atoi(argv[++i]);
375 cpu_affinities[next_aff++] = a;
376 use_affinity = 1;
377 printf_verbose("Adding CPU %d affinity\n", a);
378 break;
379 case 'b':
380 if (argc < i + 2) {
381 show_usage(argc, argv);
382 return -1;
383 }
384 reclaim_batch = atol(argv[++i]);
385 break;
386 case 'c':
387 if (argc < i + 2) {
388 show_usage(argc, argv);
389 return -1;
390 }
391 rduration = atol(argv[++i]);
392 break;
393 case 'd':
394 if (argc < i + 2) {
395 show_usage(argc, argv);
396 return -1;
397 }
398 wdelay = atol(argv[++i]);
399 break;
400 case 'e':
401 if (argc < i + 2) {
402 show_usage(argc, argv);
403 return -1;
404 }
405 wduration = atol(argv[++i]);
406 break;
407 case 'v':
408 verbose_mode = 1;
409 break;
410 }
411 }
412
413 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
414 duration, nr_readers, nr_writers);
415 printf_verbose("Writer delay : %lu loops.\n", wdelay);
416 printf_verbose("Reader duration : %lu loops.\n", rduration);
417 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
418 "main", pthread_self(), (unsigned long)gettid());
419
420 tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
421 tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
422 count_reader = malloc(sizeof(*count_reader) * nr_readers);
423 tot_nr_writes = malloc(sizeof(*tot_nr_writes) * nr_writers);
424 pending_reclaims = malloc(sizeof(*pending_reclaims) * nr_writers);
425 if (reclaim_batch * sizeof(*pending_reclaims[i].queue)
426 < CAA_CACHE_LINE_SIZE)
427 for (i = 0; i < nr_writers; i++)
428 pending_reclaims[i].queue = calloc(1, CAA_CACHE_LINE_SIZE);
429 else
430 for (i = 0; i < nr_writers; i++)
431 pending_reclaims[i].queue = calloc(reclaim_batch,
432 sizeof(*pending_reclaims[i].queue));
433 for (i = 0; i < nr_writers; i++)
434 pending_reclaims[i].head = pending_reclaims[i].queue;
435
436 next_aff = 0;
437
438 for (i = 0; i < nr_readers; i++) {
439 err = pthread_create(&tid_reader[i], NULL, thr_reader,
440 &count_reader[i]);
441 if (err != 0)
442 exit(1);
443 }
444 for (i = 0; i < nr_writers; i++) {
445 err = pthread_create(&tid_writer[i], NULL, thr_writer,
446 (void *)(long)i);
447 if (err != 0)
448 exit(1);
449 }
450
451 cmm_smp_mb();
452
453 test_go = 1;
454
455 sleep(duration);
456
457 test_stop = 1;
458
459 for (i = 0; i < nr_readers; i++) {
460 err = pthread_join(tid_reader[i], &tret);
461 if (err != 0)
462 exit(1);
463 tot_reads += count_reader[i];
464 }
465 for (i = 0; i < nr_writers; i++) {
466 err = pthread_join(tid_writer[i], &tret);
467 if (err != 0)
468 exit(1);
469 tot_writes += tot_nr_writes[i];
470 rcu_gc_clear_queue(i);
471 }
472
473 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
474 tot_writes);
475 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
476 "nr_writers %3u "
477 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu "
478 "batch %u\n",
479 argv[0], duration, nr_readers, rduration, wduration,
480 nr_writers, wdelay, tot_reads, tot_writes,
481 tot_reads + tot_writes, reclaim_batch);
482 free(tid_reader);
483 free(tid_writer);
484 free(count_reader);
485 free(tot_nr_writes);
486 for (i = 0; i < nr_writers; i++)
487 free(pending_reclaims[i].queue);
488 free(pending_reclaims);
489
490 return 0;
491}
This page took 0.040238 seconds and 4 git commands to generate.