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