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