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