4 * Userspace RCU library - example RCU-based lock-free queue
6 * Copyright February 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 * Copyright February 2010 - Paolo Bonzini <pbonzini@redhat.com>
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.
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.
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.
30 #include <sys/types.h>
37 #include <urcu/arch.h>
38 #include <urcu/tls-compat.h>
40 #include "thread-id.h"
42 /* hardcoded number of CPUs */
45 #ifndef DYNAMIC_LINK_TEST
49 /* Remove deprecation warnings from test build. */
50 #define CDS_WFQ_DEPRECATED
53 #include <urcu/wfqueue.h>
55 static volatile int test_go
, test_stop
;
57 static unsigned long rduration
;
59 static unsigned long duration
;
61 /* read-side C.S. duration, in loops */
62 static unsigned long wdelay
;
64 static inline void loop_sleep(unsigned long loops
)
70 static int verbose_mode
;
72 #define printf_verbose(fmt, args...) \
78 static unsigned int cpu_affinities
[NR_CPUS
];
79 static unsigned int next_aff
= 0;
80 static int use_affinity
= 0;
82 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
84 static void set_affinity(void)
86 #if HAVE_SCHED_SETAFFINITY
89 #endif /* HAVE_SCHED_SETAFFINITY */
94 #if HAVE_SCHED_SETAFFINITY
95 ret
= pthread_mutex_lock(&affinity_mutex
);
97 perror("Error in pthread mutex lock");
100 cpu
= cpu_affinities
[next_aff
++];
101 ret
= pthread_mutex_unlock(&affinity_mutex
);
103 perror("Error in pthread mutex unlock");
109 #if SCHED_SETAFFINITY_ARGS == 2
110 sched_setaffinity(0, &mask
);
112 sched_setaffinity(0, sizeof(mask
), &mask
);
114 #endif /* HAVE_SCHED_SETAFFINITY */
118 * returns 0 if test should end.
120 static int test_duration_dequeue(void)
125 static int test_duration_enqueue(void)
130 static DEFINE_URCU_TLS(unsigned long long, nr_dequeues
);
131 static DEFINE_URCU_TLS(unsigned long long, nr_enqueues
);
133 static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues
);
134 static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues
);
136 static unsigned int nr_enqueuers
;
137 static unsigned int nr_dequeuers
;
139 static struct cds_wfq_queue q
;
141 void *thr_enqueuer(void *_count
)
143 unsigned long long *count
= _count
;
145 printf_verbose("thread_begin %s, tid %lu\n",
146 "enqueuer", urcu_get_thread_id());
156 struct cds_wfq_node
*node
= malloc(sizeof(*node
));
159 cds_wfq_node_init(node
);
160 cds_wfq_enqueue(&q
, node
);
161 URCU_TLS(nr_successful_enqueues
)++;
163 if (caa_unlikely(wdelay
))
166 URCU_TLS(nr_enqueues
)++;
167 if (caa_unlikely(!test_duration_enqueue()))
171 count
[0] = URCU_TLS(nr_enqueues
);
172 count
[1] = URCU_TLS(nr_successful_enqueues
);
173 printf_verbose("enqueuer thread_end, tid %lu, "
174 "enqueues %llu successful_enqueues %llu\n",
175 urcu_get_thread_id(),
176 URCU_TLS(nr_enqueues
),
177 URCU_TLS(nr_successful_enqueues
));
182 void *thr_dequeuer(void *_count
)
184 unsigned long long *count
= _count
;
186 printf_verbose("thread_begin %s, tid %lu\n",
187 "dequeuer", urcu_get_thread_id());
197 struct cds_wfq_node
*node
= cds_wfq_dequeue_blocking(&q
);
201 URCU_TLS(nr_successful_dequeues
)++;
204 URCU_TLS(nr_dequeues
)++;
205 if (caa_unlikely(!test_duration_dequeue()))
207 if (caa_unlikely(rduration
))
208 loop_sleep(rduration
);
211 printf_verbose("dequeuer thread_end, tid %lu, "
212 "dequeues %llu, successful_dequeues %llu\n",
213 urcu_get_thread_id(),
214 URCU_TLS(nr_dequeues
),
215 URCU_TLS(nr_successful_dequeues
));
216 count
[0] = URCU_TLS(nr_dequeues
);
217 count
[1] = URCU_TLS(nr_successful_dequeues
);
221 void test_end(struct cds_wfq_queue
*q
, unsigned long long *nr_dequeues
)
223 struct cds_wfq_node
*node
;
226 node
= cds_wfq_dequeue_blocking(q
);
234 void show_usage(int argc
, char **argv
)
236 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
238 printf("OPTIONS:\n");
239 printf(" [-d delay] (enqueuer period (in loops))\n");
240 printf(" [-c duration] (dequeuer period (in loops))\n");
241 printf(" [-v] (verbose output)\n");
242 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
246 int main(int argc
, char **argv
)
249 pthread_t
*tid_enqueuer
, *tid_dequeuer
;
251 unsigned long long *count_enqueuer
, *count_dequeuer
;
252 unsigned long long tot_enqueues
= 0, tot_dequeues
= 0;
253 unsigned long long tot_successful_enqueues
= 0,
254 tot_successful_dequeues
= 0;
255 unsigned long long end_dequeues
= 0;
259 show_usage(argc
, argv
);
263 err
= sscanf(argv
[1], "%u", &nr_dequeuers
);
265 show_usage(argc
, argv
);
269 err
= sscanf(argv
[2], "%u", &nr_enqueuers
);
271 show_usage(argc
, argv
);
275 err
= sscanf(argv
[3], "%lu", &duration
);
277 show_usage(argc
, argv
);
281 for (i
= 4; i
< argc
; i
++) {
282 if (argv
[i
][0] != '-')
284 switch (argv
[i
][1]) {
287 show_usage(argc
, argv
);
291 cpu_affinities
[next_aff
++] = a
;
293 printf_verbose("Adding CPU %d affinity\n", a
);
297 show_usage(argc
, argv
);
300 rduration
= atol(argv
[++i
]);
304 show_usage(argc
, argv
);
307 wdelay
= atol(argv
[++i
]);
315 printf_verbose("running test for %lu seconds, %u enqueuers, "
317 duration
, nr_enqueuers
, nr_dequeuers
);
318 printf_verbose("Writer delay : %lu loops.\n", rduration
);
319 printf_verbose("Reader duration : %lu loops.\n", wdelay
);
320 printf_verbose("thread %-6s, tid %lu\n",
321 "main", urcu_get_thread_id());
323 tid_enqueuer
= calloc(nr_enqueuers
, sizeof(*tid_enqueuer
));
324 tid_dequeuer
= calloc(nr_dequeuers
, sizeof(*tid_dequeuer
));
325 count_enqueuer
= calloc(nr_enqueuers
, 2 * sizeof(*count_enqueuer
));
326 count_dequeuer
= calloc(nr_dequeuers
, 2 * sizeof(*count_dequeuer
));
331 for (i
= 0; i
< nr_enqueuers
; i
++) {
332 err
= pthread_create(&tid_enqueuer
[i
], NULL
, thr_enqueuer
,
333 &count_enqueuer
[2 * i
]);
337 for (i
= 0; i
< nr_dequeuers
; i
++) {
338 err
= pthread_create(&tid_dequeuer
[i
], NULL
, thr_dequeuer
,
339 &count_dequeuer
[2 * i
]);
348 for (i
= 0; i
< duration
; i
++) {
351 fwrite(".", sizeof(char), 1, stdout
);
358 for (i
= 0; i
< nr_enqueuers
; i
++) {
359 err
= pthread_join(tid_enqueuer
[i
], &tret
);
362 tot_enqueues
+= count_enqueuer
[2 * i
];
363 tot_successful_enqueues
+= count_enqueuer
[2 * i
+ 1];
365 for (i
= 0; i
< nr_dequeuers
; i
++) {
366 err
= pthread_join(tid_dequeuer
[i
], &tret
);
369 tot_dequeues
+= count_dequeuer
[2 * i
];
370 tot_successful_dequeues
+= count_dequeuer
[2 * i
+ 1];
373 test_end(&q
, &end_dequeues
);
375 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
376 tot_enqueues
, tot_dequeues
);
377 printf_verbose("total number of successful enqueues : %llu, "
378 "successful dequeues %llu\n",
379 tot_successful_enqueues
, tot_successful_dequeues
);
380 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
382 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
383 "successful enqueues %12llu successful dequeues %12llu "
384 "end_dequeues %llu nr_ops %12llu\n",
385 argv
[0], duration
, nr_enqueuers
, wdelay
,
386 nr_dequeuers
, rduration
, tot_enqueues
, tot_dequeues
,
387 tot_successful_enqueues
,
388 tot_successful_dequeues
, end_dequeues
,
389 tot_enqueues
+ tot_dequeues
);
390 if (tot_successful_enqueues
!= tot_successful_dequeues
+ end_dequeues
)
391 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
392 "succ. dequeues + end dequeues %llu.\n",
393 tot_successful_enqueues
,
394 tot_successful_dequeues
+ end_dequeues
);
397 free(count_enqueuer
);
398 free(count_dequeuer
);