6c2e4e827707f80ce7af9a29a1480f7ee49c4fb3
[urcu.git] / tests / test_urcu_wfcq.c
1 /*
2 * test_urcu_wfcq.c
3 *
4 * Userspace RCU library - example RCU-based lock-free concurrent queue
5 *
6 * Copyright February 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 * Copyright February 2010 - Paolo Bonzini <pbonzini@redhat.com>
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 */
23
24 #define _GNU_SOURCE
25 #include "../config.h"
26 #include <stdio.h>
27 #include <pthread.h>
28 #include <stdlib.h>
29 #include <stdint.h>
30 #include <stdbool.h>
31 #include <string.h>
32 #include <sys/types.h>
33 #include <sys/wait.h>
34 #include <unistd.h>
35 #include <stdio.h>
36 #include <assert.h>
37 #include <sched.h>
38 #include <errno.h>
39
40 #include <urcu/arch.h>
41 #include <urcu/tls-compat.h>
42
43 #ifdef __linux__
44 #include <syscall.h>
45 #endif
46
47 /* hardcoded number of CPUs */
48 #define NR_CPUS 16384
49
50 #if defined(_syscall0)
51 _syscall0(pid_t, gettid)
52 #elif defined(__NR_gettid)
53 static inline pid_t gettid(void)
54 {
55 return syscall(__NR_gettid);
56 }
57 #else
58 #warning "use pid as tid"
59 static inline pid_t gettid(void)
60 {
61 return getpid();
62 }
63 #endif
64
65 #ifndef DYNAMIC_LINK_TEST
66 #define _LGPL_SOURCE
67 #endif
68 #include <urcu.h>
69 #include <urcu/wfcqueue.h>
70
71 static volatile int test_go, test_stop;
72
73 static unsigned long rduration;
74
75 static unsigned long duration;
76
77 /* read-side C.S. duration, in loops */
78 static unsigned long wdelay;
79
80 static inline void loop_sleep(unsigned long loops)
81 {
82 while (loops-- != 0)
83 caa_cpu_relax();
84 }
85
86 static int verbose_mode;
87
88 #define printf_verbose(fmt, args...) \
89 do { \
90 if (verbose_mode) \
91 printf(fmt, args); \
92 } while (0)
93
94 static unsigned int cpu_affinities[NR_CPUS];
95 static unsigned int next_aff = 0;
96 static int use_affinity = 0;
97
98 pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
99
100 #ifndef HAVE_CPU_SET_T
101 typedef unsigned long cpu_set_t;
102 # define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
103 # define CPU_SET(cpu, cpuset) do { *(cpuset) |= (1UL << (cpu)); } while(0)
104 #endif
105
106 static void set_affinity(void)
107 {
108 cpu_set_t mask;
109 int cpu;
110 int ret;
111
112 if (!use_affinity)
113 return;
114
115 #if HAVE_SCHED_SETAFFINITY
116 ret = pthread_mutex_lock(&affinity_mutex);
117 if (ret) {
118 perror("Error in pthread mutex lock");
119 exit(-1);
120 }
121 cpu = cpu_affinities[next_aff++];
122 ret = pthread_mutex_unlock(&affinity_mutex);
123 if (ret) {
124 perror("Error in pthread mutex unlock");
125 exit(-1);
126 }
127
128 CPU_ZERO(&mask);
129 CPU_SET(cpu, &mask);
130 #if SCHED_SETAFFINITY_ARGS == 2
131 sched_setaffinity(0, &mask);
132 #else
133 sched_setaffinity(0, sizeof(mask), &mask);
134 #endif
135 #endif /* HAVE_SCHED_SETAFFINITY */
136 }
137
138 /*
139 * returns 0 if test should end.
140 */
141 static int test_duration_dequeue(void)
142 {
143 return !test_stop;
144 }
145
146 static int test_duration_enqueue(void)
147 {
148 return !test_stop;
149 }
150
151 static DEFINE_URCU_TLS(unsigned long long, nr_dequeues);
152 static DEFINE_URCU_TLS(unsigned long long, nr_enqueues);
153
154 static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues);
155 static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues);
156
157 static unsigned int nr_enqueuers;
158 static unsigned int nr_dequeuers;
159
160 static struct cds_wfcq_head __attribute__((aligned(CAA_CACHE_LINE_SIZE))) head;
161 static struct cds_wfcq_tail __attribute__((aligned(CAA_CACHE_LINE_SIZE))) tail;
162
163 void *thr_enqueuer(void *_count)
164 {
165 unsigned long long *count = _count;
166
167 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
168 "enqueuer", pthread_self(), (unsigned long)gettid());
169
170 set_affinity();
171
172 while (!test_go)
173 {
174 }
175 cmm_smp_mb();
176
177 for (;;) {
178 struct cds_wfcq_node *node = malloc(sizeof(*node));
179 if (!node)
180 goto fail;
181 cds_wfcq_node_init(node);
182 cds_wfcq_enqueue(&head, &tail, node);
183 URCU_TLS(nr_successful_enqueues)++;
184
185 if (caa_unlikely(wdelay))
186 loop_sleep(wdelay);
187 fail:
188 URCU_TLS(nr_enqueues)++;
189 if (caa_unlikely(!test_duration_enqueue()))
190 break;
191 }
192
193 count[0] = URCU_TLS(nr_enqueues);
194 count[1] = URCU_TLS(nr_successful_enqueues);
195 printf_verbose("enqueuer thread_end, thread id : %lx, tid %lu, "
196 "enqueues %llu successful_enqueues %llu\n",
197 pthread_self(), (unsigned long)gettid(),
198 URCU_TLS(nr_enqueues), URCU_TLS(nr_successful_enqueues));
199 return ((void*)1);
200
201 }
202
203 void *thr_dequeuer(void *_count)
204 {
205 unsigned long long *count = _count;
206
207 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
208 "dequeuer", pthread_self(), (unsigned long)gettid());
209
210 set_affinity();
211
212 while (!test_go)
213 {
214 }
215 cmm_smp_mb();
216
217 for (;;) {
218 struct cds_wfcq_node *node =
219 cds_wfcq_dequeue_blocking(&head, &tail);
220
221 if (node) {
222 free(node);
223 URCU_TLS(nr_successful_dequeues)++;
224 }
225
226 URCU_TLS(nr_dequeues)++;
227 if (caa_unlikely(!test_duration_dequeue()))
228 break;
229 if (caa_unlikely(rduration))
230 loop_sleep(rduration);
231 }
232
233 printf_verbose("dequeuer thread_end, thread id : %lx, tid %lu, "
234 "dequeues %llu, successful_dequeues %llu\n",
235 pthread_self(), (unsigned long)gettid(),
236 URCU_TLS(nr_dequeues), URCU_TLS(nr_successful_dequeues));
237 count[0] = URCU_TLS(nr_dequeues);
238 count[1] = URCU_TLS(nr_successful_dequeues);
239 return ((void*)2);
240 }
241
242 void test_end(unsigned long long *nr_dequeues)
243 {
244 struct cds_wfcq_node *node;
245
246 do {
247 node = cds_wfcq_dequeue_blocking(&head, &tail);
248 if (node) {
249 free(node);
250 (*nr_dequeues)++;
251 }
252 } while (node);
253 }
254
255 void show_usage(int argc, char **argv)
256 {
257 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s)", argv[0]);
258 printf(" [-d delay] (enqueuer period (in loops))");
259 printf(" [-c duration] (dequeuer period (in loops))");
260 printf(" [-v] (verbose output)");
261 printf(" [-a cpu#] [-a cpu#]... (affinity)");
262 printf("\n");
263 }
264
265 int main(int argc, char **argv)
266 {
267 int err;
268 pthread_t *tid_enqueuer, *tid_dequeuer;
269 void *tret;
270 unsigned long long *count_enqueuer, *count_dequeuer;
271 unsigned long long tot_enqueues = 0, tot_dequeues = 0;
272 unsigned long long tot_successful_enqueues = 0,
273 tot_successful_dequeues = 0;
274 unsigned long long end_dequeues = 0;
275 int i, a;
276
277 if (argc < 4) {
278 show_usage(argc, argv);
279 return -1;
280 }
281
282 err = sscanf(argv[1], "%u", &nr_dequeuers);
283 if (err != 1) {
284 show_usage(argc, argv);
285 return -1;
286 }
287
288 err = sscanf(argv[2], "%u", &nr_enqueuers);
289 if (err != 1) {
290 show_usage(argc, argv);
291 return -1;
292 }
293
294 err = sscanf(argv[3], "%lu", &duration);
295 if (err != 1) {
296 show_usage(argc, argv);
297 return -1;
298 }
299
300 for (i = 4; i < argc; i++) {
301 if (argv[i][0] != '-')
302 continue;
303 switch (argv[i][1]) {
304 case 'a':
305 if (argc < i + 2) {
306 show_usage(argc, argv);
307 return -1;
308 }
309 a = atoi(argv[++i]);
310 cpu_affinities[next_aff++] = a;
311 use_affinity = 1;
312 printf_verbose("Adding CPU %d affinity\n", a);
313 break;
314 case 'c':
315 if (argc < i + 2) {
316 show_usage(argc, argv);
317 return -1;
318 }
319 rduration = atol(argv[++i]);
320 break;
321 case 'd':
322 if (argc < i + 2) {
323 show_usage(argc, argv);
324 return -1;
325 }
326 wdelay = atol(argv[++i]);
327 break;
328 case 'v':
329 verbose_mode = 1;
330 break;
331 }
332 }
333
334 printf_verbose("running test for %lu seconds, %u enqueuers, "
335 "%u dequeuers.\n",
336 duration, nr_enqueuers, nr_dequeuers);
337 printf_verbose("Writer delay : %lu loops.\n", rduration);
338 printf_verbose("Reader duration : %lu loops.\n", wdelay);
339 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
340 "main", pthread_self(), (unsigned long)gettid());
341
342 tid_enqueuer = malloc(sizeof(*tid_enqueuer) * nr_enqueuers);
343 tid_dequeuer = malloc(sizeof(*tid_dequeuer) * nr_dequeuers);
344 count_enqueuer = malloc(2 * sizeof(*count_enqueuer) * nr_enqueuers);
345 count_dequeuer = malloc(2 * sizeof(*count_dequeuer) * nr_dequeuers);
346 cds_wfcq_init(&head, &tail);
347
348 next_aff = 0;
349
350 for (i = 0; i < nr_enqueuers; i++) {
351 err = pthread_create(&tid_enqueuer[i], NULL, thr_enqueuer,
352 &count_enqueuer[2 * i]);
353 if (err != 0)
354 exit(1);
355 }
356 for (i = 0; i < nr_dequeuers; i++) {
357 err = pthread_create(&tid_dequeuer[i], NULL, thr_dequeuer,
358 &count_dequeuer[2 * i]);
359 if (err != 0)
360 exit(1);
361 }
362
363 cmm_smp_mb();
364
365 test_go = 1;
366
367 for (i = 0; i < duration; i++) {
368 sleep(1);
369 if (verbose_mode)
370 write (1, ".", 1);
371 }
372
373 test_stop = 1;
374
375 for (i = 0; i < nr_enqueuers; i++) {
376 err = pthread_join(tid_enqueuer[i], &tret);
377 if (err != 0)
378 exit(1);
379 tot_enqueues += count_enqueuer[2 * i];
380 tot_successful_enqueues += count_enqueuer[2 * i + 1];
381 }
382 for (i = 0; i < nr_dequeuers; i++) {
383 err = pthread_join(tid_dequeuer[i], &tret);
384 if (err != 0)
385 exit(1);
386 tot_dequeues += count_dequeuer[2 * i];
387 tot_successful_dequeues += count_dequeuer[2 * i + 1];
388 }
389
390 test_end(&end_dequeues);
391
392 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
393 tot_enqueues, tot_dequeues);
394 printf_verbose("total number of successful enqueues : %llu, "
395 "successful dequeues %llu\n",
396 tot_successful_enqueues, tot_successful_dequeues);
397 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
398 "nr_dequeuers %3u "
399 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
400 "successful enqueues %12llu successful dequeues %12llu "
401 "end_dequeues %llu nr_ops %12llu\n",
402 argv[0], duration, nr_enqueuers, wdelay,
403 nr_dequeuers, rduration, tot_enqueues, tot_dequeues,
404 tot_successful_enqueues,
405 tot_successful_dequeues, end_dequeues,
406 tot_enqueues + tot_dequeues);
407 if (tot_successful_enqueues != tot_successful_dequeues + end_dequeues)
408 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
409 "succ. dequeues + end dequeues %llu.\n",
410 tot_successful_enqueues,
411 tot_successful_dequeues + end_dequeues);
412
413 free(count_enqueuer);
414 free(count_dequeuer);
415 free(tid_enqueuer);
416 free(tid_dequeuer);
417 return 0;
418 }
This page took 0.037444 seconds and 3 git commands to generate.