Cleanup: remove unused return value warning from tests
[urcu.git] / tests / benchmark / test_urcu_lfq.c
CommitLineData
453629a9
MD
1/*
2 * test_urcu_lfq.c
3 *
4 * Userspace RCU library - example RCU-based lock-free 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
f5ab766e 25#include "config.h"
453629a9
MD
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>
453629a9
MD
37#include <errno.h>
38
39#include <urcu/arch.h>
bd252a04 40#include <urcu/tls-compat.h>
2953b501 41#include "cpuset.h"
94df6318 42#include "thread-id.h"
65fcc7e9 43
453629a9
MD
44/* hardcoded number of CPUs */
45#define NR_CPUS 16384
46
453629a9
MD
47#ifndef DYNAMIC_LINK_TEST
48#define _LGPL_SOURCE
49#endif
50#include <urcu.h>
e5a7d709 51#include <urcu/cds.h>
453629a9
MD
52
53static volatile int test_go, test_stop;
54
55static unsigned long rduration;
56
57static unsigned long duration;
58
59/* read-side C.S. duration, in loops */
60static unsigned long wdelay;
61
ab0aacbe 62static inline void loop_sleep(unsigned long loops)
453629a9 63{
ab0aacbe 64 while (loops-- != 0)
06f22bdb 65 caa_cpu_relax();
453629a9
MD
66}
67
68static int verbose_mode;
69
70#define printf_verbose(fmt, args...) \
71 do { \
72 if (verbose_mode) \
73 printf(fmt, args); \
74 } while (0)
75
76static unsigned int cpu_affinities[NR_CPUS];
77static unsigned int next_aff = 0;
78static int use_affinity = 0;
79
80pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
81
453629a9
MD
82static void set_affinity(void)
83{
95bc7fb9 84#if HAVE_SCHED_SETAFFINITY
453629a9 85 cpu_set_t mask;
95bc7fb9
MD
86 int cpu, ret;
87#endif /* HAVE_SCHED_SETAFFINITY */
453629a9
MD
88
89 if (!use_affinity)
90 return;
91
92#if HAVE_SCHED_SETAFFINITY
93 ret = pthread_mutex_lock(&affinity_mutex);
94 if (ret) {
95 perror("Error in pthread mutex lock");
96 exit(-1);
97 }
98 cpu = cpu_affinities[next_aff++];
99 ret = pthread_mutex_unlock(&affinity_mutex);
100 if (ret) {
101 perror("Error in pthread mutex unlock");
102 exit(-1);
103 }
104
105 CPU_ZERO(&mask);
106 CPU_SET(cpu, &mask);
107#if SCHED_SETAFFINITY_ARGS == 2
108 sched_setaffinity(0, &mask);
109#else
110 sched_setaffinity(0, sizeof(mask), &mask);
111#endif
112#endif /* HAVE_SCHED_SETAFFINITY */
113}
114
115/*
116 * returns 0 if test should end.
117 */
118static int test_duration_dequeue(void)
119{
120 return !test_stop;
121}
122
123static int test_duration_enqueue(void)
124{
125 return !test_stop;
126}
127
bd252a04
MD
128static DEFINE_URCU_TLS(unsigned long long, nr_dequeues);
129static DEFINE_URCU_TLS(unsigned long long, nr_enqueues);
453629a9 130
bd252a04
MD
131static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues);
132static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues);
453629a9
MD
133
134static unsigned int nr_enqueuers;
135static unsigned int nr_dequeuers;
136
94aec122
MD
137struct test {
138 struct cds_lfq_node_rcu list;
139 struct rcu_head rcu;
140};
141
16aa9ee8 142static struct cds_lfq_queue_rcu q;
453629a9
MD
143
144void *thr_enqueuer(void *_count)
145{
146 unsigned long long *count = _count;
147
94df6318
MD
148 printf_verbose("thread_begin %s, tid %lu\n",
149 "enqueuer", urcu_get_thread_id());
453629a9
MD
150
151 set_affinity();
152
153 rcu_register_thread();
154
155 while (!test_go)
156 {
157 }
5481ddb3 158 cmm_smp_mb();
453629a9
MD
159
160 for (;;) {
94aec122 161 struct test *node = malloc(sizeof(*node));
453629a9
MD
162 if (!node)
163 goto fail;
94aec122 164 cds_lfq_node_init_rcu(&node->list);
6e5f88cf 165 rcu_read_lock();
94aec122 166 cds_lfq_enqueue_rcu(&q, &node->list);
6e5f88cf 167 rcu_read_unlock();
bd252a04 168 URCU_TLS(nr_successful_enqueues)++;
453629a9 169
a0b7f7ea 170 if (caa_unlikely(wdelay))
453629a9
MD
171 loop_sleep(wdelay);
172fail:
bd252a04 173 URCU_TLS(nr_enqueues)++;
a0b7f7ea 174 if (caa_unlikely(!test_duration_enqueue()))
453629a9
MD
175 break;
176 }
177
178 rcu_unregister_thread();
179
bd252a04
MD
180 count[0] = URCU_TLS(nr_enqueues);
181 count[1] = URCU_TLS(nr_successful_enqueues);
94df6318
MD
182 printf_verbose("enqueuer thread_end, tid %lu, "
183 "enqueues %llu successful_enqueues %llu\n",
184 urcu_get_thread_id(),
185 URCU_TLS(nr_enqueues),
186 URCU_TLS(nr_successful_enqueues));
453629a9
MD
187 return ((void*)1);
188
189}
190
94aec122
MD
191static
192void free_node_cb(struct rcu_head *head)
193{
194 struct test *node =
195 caa_container_of(head, struct test, rcu);
196 free(node);
197}
198
453629a9
MD
199void *thr_dequeuer(void *_count)
200{
201 unsigned long long *count = _count;
202
94df6318
MD
203 printf_verbose("thread_begin %s, tid %lu\n",
204 "dequeuer", urcu_get_thread_id());
453629a9
MD
205
206 set_affinity();
207
453629a9
MD
208 rcu_register_thread();
209
210 while (!test_go)
211 {
212 }
5481ddb3 213 cmm_smp_mb();
453629a9
MD
214
215 for (;;) {
94aec122 216 struct cds_lfq_node_rcu *qnode;
d9b52143 217
6e5f88cf 218 rcu_read_lock();
94aec122 219 qnode = cds_lfq_dequeue_rcu(&q);
6e5f88cf
MD
220 rcu_read_unlock();
221
747b5930
LJ
222 if (qnode) {
223 struct test *node;
224
225 node = caa_container_of(qnode, struct test, list);
94aec122 226 call_rcu(&node->rcu, free_node_cb);
bd252a04 227 URCU_TLS(nr_successful_dequeues)++;
453629a9
MD
228 }
229
bd252a04 230 URCU_TLS(nr_dequeues)++;
a0b7f7ea 231 if (caa_unlikely(!test_duration_dequeue()))
453629a9 232 break;
a0b7f7ea 233 if (caa_unlikely(rduration))
453629a9
MD
234 loop_sleep(rduration);
235 }
236
237 rcu_unregister_thread();
94df6318
MD
238 printf_verbose("dequeuer thread_end, tid %lu, "
239 "dequeues %llu, successful_dequeues %llu\n",
240 urcu_get_thread_id(),
241 URCU_TLS(nr_dequeues),
242 URCU_TLS(nr_successful_dequeues));
bd252a04
MD
243 count[0] = URCU_TLS(nr_dequeues);
244 count[1] = URCU_TLS(nr_successful_dequeues);
453629a9
MD
245 return ((void*)2);
246}
247
16aa9ee8 248void test_end(struct cds_lfq_queue_rcu *q, unsigned long long *nr_dequeues)
453629a9 249{
94aec122 250 struct cds_lfq_node_rcu *snode;
453629a9
MD
251
252 do {
94aec122
MD
253 snode = cds_lfq_dequeue_rcu(q);
254 if (snode) {
255 struct test *node;
256
257 node = caa_container_of(snode, struct test, list);
e17d9985 258 free(node); /* no more concurrent access */
453629a9
MD
259 (*nr_dequeues)++;
260 }
94aec122 261 } while (snode);
453629a9
MD
262}
263
264void show_usage(int argc, char **argv)
265{
06637138
MD
266 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
267 argv[0]);
268 printf("OPTIONS:\n");
269 printf(" [-d delay] (enqueuer period (in loops))\n");
270 printf(" [-c duration] (dequeuer period (in loops))\n");
271 printf(" [-v] (verbose output)\n");
272 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
453629a9
MD
273 printf("\n");
274}
275
276int main(int argc, char **argv)
277{
278 int err;
279 pthread_t *tid_enqueuer, *tid_dequeuer;
280 void *tret;
281 unsigned long long *count_enqueuer, *count_dequeuer;
282 unsigned long long tot_enqueues = 0, tot_dequeues = 0;
283 unsigned long long tot_successful_enqueues = 0,
284 tot_successful_dequeues = 0;
285 unsigned long long end_dequeues = 0;
286 int i, a;
287
288 if (argc < 4) {
289 show_usage(argc, argv);
290 return -1;
291 }
292
293 err = sscanf(argv[1], "%u", &nr_dequeuers);
294 if (err != 1) {
295 show_usage(argc, argv);
296 return -1;
297 }
298
299 err = sscanf(argv[2], "%u", &nr_enqueuers);
300 if (err != 1) {
301 show_usage(argc, argv);
302 return -1;
303 }
304
305 err = sscanf(argv[3], "%lu", &duration);
306 if (err != 1) {
307 show_usage(argc, argv);
308 return -1;
309 }
310
311 for (i = 4; i < argc; i++) {
312 if (argv[i][0] != '-')
313 continue;
314 switch (argv[i][1]) {
315 case 'a':
316 if (argc < i + 2) {
317 show_usage(argc, argv);
318 return -1;
319 }
320 a = atoi(argv[++i]);
321 cpu_affinities[next_aff++] = a;
322 use_affinity = 1;
323 printf_verbose("Adding CPU %d affinity\n", a);
324 break;
325 case 'c':
326 if (argc < i + 2) {
327 show_usage(argc, argv);
328 return -1;
329 }
330 rduration = atol(argv[++i]);
331 break;
332 case 'd':
333 if (argc < i + 2) {
334 show_usage(argc, argv);
335 return -1;
336 }
337 wdelay = atol(argv[++i]);
338 break;
339 case 'v':
340 verbose_mode = 1;
341 break;
342 }
343 }
344
345 printf_verbose("running test for %lu seconds, %u enqueuers, "
346 "%u dequeuers.\n",
347 duration, nr_enqueuers, nr_dequeuers);
348 printf_verbose("Writer delay : %lu loops.\n", rduration);
349 printf_verbose("Reader duration : %lu loops.\n", wdelay);
94df6318
MD
350 printf_verbose("thread %-6s, tid %lu\n",
351 "main", urcu_get_thread_id());
453629a9 352
9aa14175
MD
353 tid_enqueuer = calloc(nr_enqueuers, sizeof(*tid_enqueuer));
354 tid_dequeuer = calloc(nr_dequeuers, sizeof(*tid_dequeuer));
355 count_enqueuer = calloc(nr_enqueuers, 2 * sizeof(*count_enqueuer));
356 count_dequeuer = calloc(nr_dequeuers, 2 * sizeof(*count_dequeuer));
6e5f88cf 357 cds_lfq_init_rcu(&q, call_rcu);
94aec122 358 err = create_all_cpu_call_rcu_data(0);
8bcbd94a
MD
359 if (err) {
360 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
361 }
453629a9
MD
362
363 next_aff = 0;
364
365 for (i = 0; i < nr_enqueuers; i++) {
366 err = pthread_create(&tid_enqueuer[i], NULL, thr_enqueuer,
367 &count_enqueuer[2 * i]);
368 if (err != 0)
369 exit(1);
370 }
371 for (i = 0; i < nr_dequeuers; i++) {
372 err = pthread_create(&tid_dequeuer[i], NULL, thr_dequeuer,
373 &count_dequeuer[2 * i]);
374 if (err != 0)
375 exit(1);
376 }
377
5481ddb3 378 cmm_smp_mb();
453629a9
MD
379
380 test_go = 1;
381
382 for (i = 0; i < duration; i++) {
383 sleep(1);
4b665350
MD
384 if (verbose_mode) {
385 fwrite(".", sizeof(char), 1, stdout);
386 fflush(stdout);
387 }
453629a9
MD
388 }
389
390 test_stop = 1;
391
392 for (i = 0; i < nr_enqueuers; i++) {
393 err = pthread_join(tid_enqueuer[i], &tret);
394 if (err != 0)
395 exit(1);
396 tot_enqueues += count_enqueuer[2 * i];
397 tot_successful_enqueues += count_enqueuer[2 * i + 1];
398 }
399 for (i = 0; i < nr_dequeuers; i++) {
400 err = pthread_join(tid_dequeuer[i], &tret);
401 if (err != 0)
402 exit(1);
403 tot_dequeues += count_dequeuer[2 * i];
404 tot_successful_dequeues += count_dequeuer[2 * i + 1];
405 }
406
407 test_end(&q, &end_dequeues);
e17d9985
MD
408 err = cds_lfq_destroy_rcu(&q);
409 assert(!err);
453629a9
MD
410
411 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
412 tot_enqueues, tot_dequeues);
413 printf_verbose("total number of successful enqueues : %llu, "
414 "successful dequeues %llu\n",
415 tot_successful_enqueues, tot_successful_dequeues);
416 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
417 "nr_dequeuers %3u "
418 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
419 "successful enqueues %12llu successful dequeues %12llu "
420 "end_dequeues %llu nr_ops %12llu\n",
421 argv[0], duration, nr_enqueuers, wdelay,
422 nr_dequeuers, rduration, tot_enqueues, tot_dequeues,
423 tot_successful_enqueues,
424 tot_successful_dequeues, end_dequeues,
425 tot_enqueues + tot_dequeues);
426 if (tot_successful_enqueues != tot_successful_dequeues + end_dequeues)
427 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
428 "succ. dequeues + end dequeues %llu.\n",
429 tot_successful_enqueues,
430 tot_successful_dequeues + end_dequeues);
431
0938c541 432 free_all_cpu_call_rcu_data();
453629a9
MD
433 free(count_enqueuer);
434 free(count_dequeuer);
435 free(tid_enqueuer);
436 free(tid_dequeuer);
437 return 0;
438}
This page took 0.075451 seconds and 4 git commands to generate.