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>
39 #include "thread-id.h"
41 /* hardcoded number of CPUs */
44 #ifndef DYNAMIC_LINK_TEST
48 /* Remove deprecation warnings from test build. */
49 #define CDS_WFQ_DEPRECATED
52 #include <urcu/wfqueue.h>
54 static volatile int test_go
, test_stop
;
56 static unsigned long rduration
;
58 static unsigned long duration
;
60 /* read-side C.S. duration, in loops */
61 static unsigned long wdelay
;
63 static inline void loop_sleep(unsigned long loops
)
69 static int verbose_mode
;
71 #define printf_verbose(fmt, args...) \
77 static unsigned int cpu_affinities
[NR_CPUS
];
78 static unsigned int next_aff
= 0;
79 static int use_affinity
= 0;
81 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
83 static void set_affinity(void)
85 #if HAVE_SCHED_SETAFFINITY
88 #endif /* HAVE_SCHED_SETAFFINITY */
93 #if HAVE_SCHED_SETAFFINITY
94 ret
= pthread_mutex_lock(&affinity_mutex
);
96 perror("Error in pthread mutex lock");
99 cpu
= cpu_affinities
[next_aff
++];
100 ret
= pthread_mutex_unlock(&affinity_mutex
);
102 perror("Error in pthread mutex unlock");
108 sched_setaffinity(0, sizeof(mask
), &mask
);
109 #endif /* HAVE_SCHED_SETAFFINITY */
113 * returns 0 if test should end.
115 static int test_duration_dequeue(void)
120 static int test_duration_enqueue(void)
125 static DEFINE_URCU_TLS(unsigned long long, nr_dequeues
);
126 static DEFINE_URCU_TLS(unsigned long long, nr_enqueues
);
128 static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues
);
129 static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues
);
131 static unsigned int nr_enqueuers
;
132 static unsigned int nr_dequeuers
;
134 static struct cds_wfq_queue q
;
136 void *thr_enqueuer(void *_count
)
138 unsigned long long *count
= _count
;
140 printf_verbose("thread_begin %s, tid %lu\n",
141 "enqueuer", urcu_get_thread_id());
151 struct cds_wfq_node
*node
= malloc(sizeof(*node
));
154 cds_wfq_node_init(node
);
155 cds_wfq_enqueue(&q
, node
);
156 URCU_TLS(nr_successful_enqueues
)++;
158 if (caa_unlikely(wdelay
))
161 URCU_TLS(nr_enqueues
)++;
162 if (caa_unlikely(!test_duration_enqueue()))
166 count
[0] = URCU_TLS(nr_enqueues
);
167 count
[1] = URCU_TLS(nr_successful_enqueues
);
168 printf_verbose("enqueuer thread_end, tid %lu, "
169 "enqueues %llu successful_enqueues %llu\n",
170 urcu_get_thread_id(),
171 URCU_TLS(nr_enqueues
),
172 URCU_TLS(nr_successful_enqueues
));
177 void *thr_dequeuer(void *_count
)
179 unsigned long long *count
= _count
;
181 printf_verbose("thread_begin %s, tid %lu\n",
182 "dequeuer", urcu_get_thread_id());
192 struct cds_wfq_node
*node
= cds_wfq_dequeue_blocking(&q
);
196 URCU_TLS(nr_successful_dequeues
)++;
199 URCU_TLS(nr_dequeues
)++;
200 if (caa_unlikely(!test_duration_dequeue()))
202 if (caa_unlikely(rduration
))
203 loop_sleep(rduration
);
206 printf_verbose("dequeuer thread_end, tid %lu, "
207 "dequeues %llu, successful_dequeues %llu\n",
208 urcu_get_thread_id(),
209 URCU_TLS(nr_dequeues
),
210 URCU_TLS(nr_successful_dequeues
));
211 count
[0] = URCU_TLS(nr_dequeues
);
212 count
[1] = URCU_TLS(nr_successful_dequeues
);
216 void test_end(struct cds_wfq_queue
*q
, unsigned long long *nr_dequeues
)
218 struct cds_wfq_node
*node
;
221 node
= cds_wfq_dequeue_blocking(q
);
229 void show_usage(int argc
, char **argv
)
231 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
233 printf("OPTIONS:\n");
234 printf(" [-d delay] (enqueuer period (in loops))\n");
235 printf(" [-c duration] (dequeuer period (in loops))\n");
236 printf(" [-v] (verbose output)\n");
237 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
241 int main(int argc
, char **argv
)
244 pthread_t
*tid_enqueuer
, *tid_dequeuer
;
246 unsigned long long *count_enqueuer
, *count_dequeuer
;
247 unsigned long long tot_enqueues
= 0, tot_dequeues
= 0;
248 unsigned long long tot_successful_enqueues
= 0,
249 tot_successful_dequeues
= 0;
250 unsigned long long end_dequeues
= 0;
255 show_usage(argc
, argv
);
259 err
= sscanf(argv
[1], "%u", &nr_dequeuers
);
261 show_usage(argc
, argv
);
265 err
= sscanf(argv
[2], "%u", &nr_enqueuers
);
267 show_usage(argc
, argv
);
271 err
= sscanf(argv
[3], "%lu", &duration
);
273 show_usage(argc
, argv
);
277 for (i
= 4; i
< argc
; i
++) {
278 if (argv
[i
][0] != '-')
280 switch (argv
[i
][1]) {
283 show_usage(argc
, argv
);
287 cpu_affinities
[next_aff
++] = a
;
289 printf_verbose("Adding CPU %d affinity\n", a
);
293 show_usage(argc
, argv
);
296 rduration
= atol(argv
[++i
]);
300 show_usage(argc
, argv
);
303 wdelay
= atol(argv
[++i
]);
311 printf_verbose("running test for %lu seconds, %u enqueuers, "
313 duration
, nr_enqueuers
, nr_dequeuers
);
314 printf_verbose("Writer delay : %lu loops.\n", rduration
);
315 printf_verbose("Reader duration : %lu loops.\n", wdelay
);
316 printf_verbose("thread %-6s, tid %lu\n",
317 "main", urcu_get_thread_id());
319 tid_enqueuer
= calloc(nr_enqueuers
, sizeof(*tid_enqueuer
));
320 tid_dequeuer
= calloc(nr_dequeuers
, sizeof(*tid_dequeuer
));
321 count_enqueuer
= calloc(nr_enqueuers
, 2 * sizeof(*count_enqueuer
));
322 count_dequeuer
= calloc(nr_dequeuers
, 2 * sizeof(*count_dequeuer
));
327 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
328 err
= pthread_create(&tid_enqueuer
[i_thr
], NULL
, thr_enqueuer
,
329 &count_enqueuer
[2 * i_thr
]);
333 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
334 err
= pthread_create(&tid_dequeuer
[i_thr
], NULL
, thr_dequeuer
,
335 &count_dequeuer
[2 * i_thr
]);
344 for (i_thr
= 0; i_thr
< duration
; i_thr
++) {
347 fwrite(".", sizeof(char), 1, stdout
);
354 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
355 err
= pthread_join(tid_enqueuer
[i_thr
], &tret
);
358 tot_enqueues
+= count_enqueuer
[2 * i_thr
];
359 tot_successful_enqueues
+= count_enqueuer
[2 * i_thr
+ 1];
361 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
362 err
= pthread_join(tid_dequeuer
[i_thr
], &tret
);
365 tot_dequeues
+= count_dequeuer
[2 * i_thr
];
366 tot_successful_dequeues
+= count_dequeuer
[2 * i_thr
+ 1];
369 test_end(&q
, &end_dequeues
);
371 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
372 tot_enqueues
, tot_dequeues
);
373 printf_verbose("total number of successful enqueues : %llu, "
374 "successful dequeues %llu\n",
375 tot_successful_enqueues
, tot_successful_dequeues
);
376 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
378 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
379 "successful enqueues %12llu successful dequeues %12llu "
380 "end_dequeues %llu nr_ops %12llu\n",
381 argv
[0], duration
, nr_enqueuers
, wdelay
,
382 nr_dequeuers
, rduration
, tot_enqueues
, tot_dequeues
,
383 tot_successful_enqueues
,
384 tot_successful_dequeues
, end_dequeues
,
385 tot_enqueues
+ tot_dequeues
);
386 if (tot_successful_enqueues
!= tot_successful_dequeues
+ end_dequeues
)
387 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
388 "succ. dequeues + end dequeues %llu.\n",
389 tot_successful_enqueues
,
390 tot_successful_dequeues
+ end_dequeues
);
393 free(count_enqueuer
);
394 free(count_dequeuer
);