Add rcu-reclaim.so library
[urcu.git] / tests / test_urcu_reclaim.c
1 /*
2 * test_urcu_reclaim.c
3 *
4 * Userspace RCU library - test program (with automatic reclamation)
5 *
6 * Copyright February 2009 - Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
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 <stdio.h>
25 #include <pthread.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <sys/types.h>
29 #include <sys/wait.h>
30 #include <unistd.h>
31 #include <stdio.h>
32 #include <assert.h>
33 #include <sys/syscall.h>
34 #include <sched.h>
35
36 #include "../arch.h"
37
38 /* Make this big enough to include the POWER5+ L3 cacheline size of 256B */
39 #define CACHE_LINE_SIZE 4096
40
41 /* hardcoded number of CPUs */
42 #define NR_CPUS 16384
43
44 #if defined(_syscall0)
45 _syscall0(pid_t, gettid)
46 #elif defined(__NR_gettid)
47 static inline pid_t gettid(void)
48 {
49 return syscall(__NR_gettid);
50 }
51 #else
52 #warning "use pid as tid"
53 static inline pid_t gettid(void)
54 {
55 return getpid();
56 }
57 #endif
58
59 #ifndef DYNAMIC_LINK_TEST
60 #define _LGPL_SOURCE
61 #else
62 #define debug_yield_read()
63 #endif
64 #include "../urcu.h"
65 #include "../urcu-reclaim.h"
66
67 struct test_array {
68 int a;
69 };
70
71 static volatile int test_go, test_stop;
72
73 static unsigned long wdelay;
74
75 static struct test_array *test_rcu_pointer;
76
77 static unsigned long duration;
78
79 /* read-side C.S. duration, in loops */
80 static unsigned long rduration;
81
82 static inline void loop_sleep(unsigned long l)
83 {
84 while(l-- != 0)
85 cpu_relax();
86 }
87
88 static int verbose_mode;
89
90 #define printf_verbose(fmt, args...) \
91 do { \
92 if (verbose_mode) \
93 printf(fmt, args); \
94 } while (0)
95
96 static unsigned int cpu_affinities[NR_CPUS];
97 static unsigned int next_aff = 0;
98 static int use_affinity = 0;
99
100 pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
101
102 static void set_affinity(void)
103 {
104 cpu_set_t mask;
105 int cpu;
106 int ret;
107
108 if (!use_affinity)
109 return;
110
111 ret = pthread_mutex_lock(&affinity_mutex);
112 if (ret) {
113 perror("Error in pthread mutex lock");
114 exit(-1);
115 }
116 cpu = cpu_affinities[next_aff++];
117 ret = pthread_mutex_unlock(&affinity_mutex);
118 if (ret) {
119 perror("Error in pthread mutex unlock");
120 exit(-1);
121 }
122 CPU_ZERO(&mask);
123 CPU_SET(cpu, &mask);
124 sched_setaffinity(0, sizeof(mask), &mask);
125 }
126
127 /*
128 * returns 0 if test should end.
129 */
130 static int test_duration_write(void)
131 {
132 return !test_stop;
133 }
134
135 static int test_duration_read(void)
136 {
137 return !test_stop;
138 }
139
140 static unsigned long long __thread nr_writes;
141 static unsigned long long __thread nr_reads;
142
143 static
144 unsigned long long __attribute__((aligned(CACHE_LINE_SIZE))) *tot_nr_writes;
145
146 static unsigned int nr_readers;
147 static unsigned int nr_writers;
148
149 pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
150
151 void rcu_copy_mutex_lock(void)
152 {
153 int ret;
154 ret = pthread_mutex_lock(&rcu_copy_mutex);
155 if (ret) {
156 perror("Error in pthread mutex lock");
157 exit(-1);
158 }
159 }
160
161 void rcu_copy_mutex_unlock(void)
162 {
163 int ret;
164
165 ret = pthread_mutex_unlock(&rcu_copy_mutex);
166 if (ret) {
167 perror("Error in pthread mutex unlock");
168 exit(-1);
169 }
170 }
171
172 void *thr_reader(void *_count)
173 {
174 unsigned long long *count = _count;
175 struct test_array *local_ptr;
176
177 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
178 "reader", pthread_self(), (unsigned long)gettid());
179
180 set_affinity();
181
182 rcu_register_thread();
183
184 while (!test_go)
185 {
186 }
187 smp_mb();
188
189 for (;;) {
190 rcu_read_lock();
191 local_ptr = rcu_dereference(test_rcu_pointer);
192 debug_yield_read();
193 if (local_ptr)
194 assert(local_ptr->a == 8);
195 if (unlikely(rduration))
196 loop_sleep(rduration);
197 rcu_read_unlock();
198 nr_reads++;
199 if (unlikely(!test_duration_read()))
200 break;
201 }
202
203 rcu_unregister_thread();
204
205 *count = nr_reads;
206 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
207 "reader", pthread_self(), (unsigned long)gettid());
208 return ((void*)1);
209
210 }
211
212 void *thr_writer(void *data)
213 {
214 unsigned long wtidx = (unsigned long)data;
215 struct test_array *new, *old = NULL;
216
217 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
218 "writer", pthread_self(), (unsigned long)gettid());
219
220 set_affinity();
221
222 rcu_reclaim_register_thread();
223
224 while (!test_go)
225 {
226 }
227 smp_mb();
228
229 for (;;) {
230 new = malloc(sizeof(*new));
231 new->a = 8;
232 old = rcu_xchg_pointer(&test_rcu_pointer, new);
233 rcu_reclaim_queue(old);
234 nr_writes++;
235 if (unlikely(!test_duration_write()))
236 break;
237 if (unlikely(wdelay))
238 loop_sleep(wdelay);
239 }
240
241 rcu_reclaim_unregister_thread();
242
243 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
244 "writer", pthread_self(), (unsigned long)gettid());
245 tot_nr_writes[wtidx] = nr_writes;
246 return ((void*)2);
247 }
248
249 void show_usage(int argc, char **argv)
250 {
251 printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
252 #ifdef DEBUG_YIELD
253 printf(" [-r] [-w] (yield reader and/or writer)");
254 #endif
255 printf(" [-d delay] (writer period (us))");
256 printf(" [-c duration] (reader C.S. duration (in loops))");
257 printf(" [-v] (verbose output)");
258 printf(" [-a cpu#] [-a cpu#]... (affinity)");
259 printf("\n");
260 }
261
262 int main(int argc, char **argv)
263 {
264 int err;
265 pthread_t *tid_reader, *tid_writer;
266 void *tret;
267 unsigned long long *count_reader;
268 unsigned long long tot_reads = 0, tot_writes = 0;
269 int i, a;
270
271 if (argc < 4) {
272 show_usage(argc, argv);
273 return -1;
274 }
275
276 err = sscanf(argv[1], "%u", &nr_readers);
277 if (err != 1) {
278 show_usage(argc, argv);
279 return -1;
280 }
281
282 err = sscanf(argv[2], "%u", &nr_writers);
283 if (err != 1) {
284 show_usage(argc, argv);
285 return -1;
286 }
287
288 err = sscanf(argv[3], "%lu", &duration);
289 if (err != 1) {
290 show_usage(argc, argv);
291 return -1;
292 }
293
294 for (i = 4; i < argc; i++) {
295 if (argv[i][0] != '-')
296 continue;
297 switch (argv[i][1]) {
298 #ifdef DEBUG_YIELD
299 case 'r':
300 yield_active |= YIELD_READ;
301 break;
302 case 'w':
303 yield_active |= YIELD_WRITE;
304 break;
305 #endif
306 case 'a':
307 if (argc < i + 2) {
308 show_usage(argc, argv);
309 return -1;
310 }
311 a = atoi(argv[++i]);
312 cpu_affinities[next_aff++] = a;
313 use_affinity = 1;
314 printf_verbose("Adding CPU %d affinity\n", a);
315 break;
316 case 'c':
317 if (argc < i + 2) {
318 show_usage(argc, argv);
319 return -1;
320 }
321 rduration = atol(argv[++i]);
322 break;
323 case 'd':
324 if (argc < i + 2) {
325 show_usage(argc, argv);
326 return -1;
327 }
328 wdelay = atol(argv[++i]);
329 break;
330 case 'v':
331 verbose_mode = 1;
332 break;
333 }
334 }
335
336 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
337 duration, nr_readers, nr_writers);
338 printf_verbose("Writer delay : %lu loops.\n", wdelay);
339 printf_verbose("Reader duration : %lu loops.\n", rduration);
340 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
341 "main", pthread_self(), (unsigned long)gettid());
342
343 tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
344 tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
345 count_reader = malloc(sizeof(*count_reader) * nr_readers);
346 tot_nr_writes = malloc(sizeof(*tot_nr_writes) * nr_writers);
347
348 next_aff = 0;
349
350 for (i = 0; i < nr_readers; i++) {
351 err = pthread_create(&tid_reader[i], NULL, thr_reader,
352 &count_reader[i]);
353 if (err != 0)
354 exit(1);
355 }
356 for (i = 0; i < nr_writers; i++) {
357 err = pthread_create(&tid_writer[i], NULL, thr_writer,
358 (void *)(long)i);
359 if (err != 0)
360 exit(1);
361 }
362
363 smp_mb();
364
365 test_go = 1;
366
367 sleep(duration);
368
369 test_stop = 1;
370
371 for (i = 0; i < nr_readers; i++) {
372 err = pthread_join(tid_reader[i], &tret);
373 if (err != 0)
374 exit(1);
375 tot_reads += count_reader[i];
376 }
377 for (i = 0; i < nr_writers; i++) {
378 err = pthread_join(tid_writer[i], &tret);
379 if (err != 0)
380 exit(1);
381 tot_writes += tot_nr_writes[i];
382 }
383
384 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
385 tot_writes);
386 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
387 "nr_writers %3u "
388 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
389 argv[0], duration, nr_readers, rduration,
390 nr_writers, wdelay, tot_reads, tot_writes,
391 tot_reads + tot_writes);
392 free(tid_reader);
393 free(tid_writer);
394 free(count_reader);
395 free(tot_nr_writes);
396
397 return 0;
398 }
This page took 0.054806 seconds and 4 git commands to generate.