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