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.
25 #include "../config.h"
32 #include <sys/types.h>
39 #include <urcu/arch.h>
40 #include <urcu/tls-compat.h>
47 /* hardcoded number of CPUs */
50 #if defined(_syscall0)
51 _syscall0(pid_t
, gettid
)
52 #elif defined(__NR_gettid)
53 static inline pid_t
gettid(void)
55 return syscall(__NR_gettid
);
58 #warning "use pid as tid"
59 static inline pid_t
gettid(void)
65 #ifndef DYNAMIC_LINK_TEST
69 /* Remove deprecation warnings from test build. */
70 #define CDS_WFQ_DEPRECATED
73 #include <urcu/wfqueue.h>
75 static volatile int test_go
, test_stop
;
77 static unsigned long rduration
;
79 static unsigned long duration
;
81 /* read-side C.S. duration, in loops */
82 static unsigned long wdelay
;
84 static inline void loop_sleep(unsigned long loops
)
90 static int verbose_mode
;
92 #define printf_verbose(fmt, args...) \
98 static unsigned int cpu_affinities
[NR_CPUS
];
99 static unsigned int next_aff
= 0;
100 static int use_affinity
= 0;
102 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
104 static void set_affinity(void)
106 #if HAVE_SCHED_SETAFFINITY
109 #endif /* HAVE_SCHED_SETAFFINITY */
114 #if HAVE_SCHED_SETAFFINITY
115 ret
= pthread_mutex_lock(&affinity_mutex
);
117 perror("Error in pthread mutex lock");
120 cpu
= cpu_affinities
[next_aff
++];
121 ret
= pthread_mutex_unlock(&affinity_mutex
);
123 perror("Error in pthread mutex unlock");
129 #if SCHED_SETAFFINITY_ARGS == 2
130 sched_setaffinity(0, &mask
);
132 sched_setaffinity(0, sizeof(mask
), &mask
);
134 #endif /* HAVE_SCHED_SETAFFINITY */
138 * returns 0 if test should end.
140 static int test_duration_dequeue(void)
145 static int test_duration_enqueue(void)
150 static DEFINE_URCU_TLS(unsigned long long, nr_dequeues
);
151 static DEFINE_URCU_TLS(unsigned long long, nr_enqueues
);
153 static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues
);
154 static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues
);
156 static unsigned int nr_enqueuers
;
157 static unsigned int nr_dequeuers
;
159 static struct cds_wfq_queue q
;
161 void *thr_enqueuer(void *_count
)
163 unsigned long long *count
= _count
;
165 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
166 "enqueuer", (unsigned long) pthread_self(),
167 (unsigned long) gettid());
177 struct cds_wfq_node
*node
= malloc(sizeof(*node
));
180 cds_wfq_node_init(node
);
181 cds_wfq_enqueue(&q
, node
);
182 URCU_TLS(nr_successful_enqueues
)++;
184 if (caa_unlikely(wdelay
))
187 URCU_TLS(nr_enqueues
)++;
188 if (caa_unlikely(!test_duration_enqueue()))
192 count
[0] = URCU_TLS(nr_enqueues
);
193 count
[1] = URCU_TLS(nr_successful_enqueues
);
194 printf_verbose("enqueuer thread_end, thread id : %lx, tid %lu, "
195 "enqueues %llu successful_enqueues %llu\n",
197 (unsigned long) gettid(),
198 URCU_TLS(nr_enqueues
), URCU_TLS(nr_successful_enqueues
));
203 void *thr_dequeuer(void *_count
)
205 unsigned long long *count
= _count
;
207 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
208 "dequeuer", (unsigned long) pthread_self(),
209 (unsigned long) gettid());
219 struct cds_wfq_node
*node
= cds_wfq_dequeue_blocking(&q
);
223 URCU_TLS(nr_successful_dequeues
)++;
226 URCU_TLS(nr_dequeues
)++;
227 if (caa_unlikely(!test_duration_dequeue()))
229 if (caa_unlikely(rduration
))
230 loop_sleep(rduration
);
233 printf_verbose("dequeuer thread_end, thread id : %lx, tid %lu, "
234 "dequeues %llu, successful_dequeues %llu\n",
236 (unsigned long) gettid(),
237 URCU_TLS(nr_dequeues
), URCU_TLS(nr_successful_dequeues
));
238 count
[0] = URCU_TLS(nr_dequeues
);
239 count
[1] = URCU_TLS(nr_successful_dequeues
);
243 void test_end(struct cds_wfq_queue
*q
, unsigned long long *nr_dequeues
)
245 struct cds_wfq_node
*node
;
248 node
= cds_wfq_dequeue_blocking(q
);
256 void show_usage(int argc
, char **argv
)
258 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s)", argv
[0]);
259 printf(" [-d delay] (enqueuer period (in loops))");
260 printf(" [-c duration] (dequeuer period (in loops))");
261 printf(" [-v] (verbose output)");
262 printf(" [-a cpu#] [-a cpu#]... (affinity)");
266 int main(int argc
, char **argv
)
269 pthread_t
*tid_enqueuer
, *tid_dequeuer
;
271 unsigned long long *count_enqueuer
, *count_dequeuer
;
272 unsigned long long tot_enqueues
= 0, tot_dequeues
= 0;
273 unsigned long long tot_successful_enqueues
= 0,
274 tot_successful_dequeues
= 0;
275 unsigned long long end_dequeues
= 0;
279 show_usage(argc
, argv
);
283 err
= sscanf(argv
[1], "%u", &nr_dequeuers
);
285 show_usage(argc
, argv
);
289 err
= sscanf(argv
[2], "%u", &nr_enqueuers
);
291 show_usage(argc
, argv
);
295 err
= sscanf(argv
[3], "%lu", &duration
);
297 show_usage(argc
, argv
);
301 for (i
= 4; i
< argc
; i
++) {
302 if (argv
[i
][0] != '-')
304 switch (argv
[i
][1]) {
307 show_usage(argc
, argv
);
311 cpu_affinities
[next_aff
++] = a
;
313 printf_verbose("Adding CPU %d affinity\n", a
);
317 show_usage(argc
, argv
);
320 rduration
= atol(argv
[++i
]);
324 show_usage(argc
, argv
);
327 wdelay
= atol(argv
[++i
]);
335 printf_verbose("running test for %lu seconds, %u enqueuers, "
337 duration
, nr_enqueuers
, nr_dequeuers
);
338 printf_verbose("Writer delay : %lu loops.\n", rduration
);
339 printf_verbose("Reader duration : %lu loops.\n", wdelay
);
340 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
341 "main", (unsigned long) pthread_self(),
342 (unsigned long) gettid());
344 tid_enqueuer
= malloc(sizeof(*tid_enqueuer
) * nr_enqueuers
);
345 tid_dequeuer
= malloc(sizeof(*tid_dequeuer
) * nr_dequeuers
);
346 count_enqueuer
= malloc(2 * sizeof(*count_enqueuer
) * nr_enqueuers
);
347 count_dequeuer
= malloc(2 * sizeof(*count_dequeuer
) * nr_dequeuers
);
352 for (i
= 0; i
< nr_enqueuers
; i
++) {
353 err
= pthread_create(&tid_enqueuer
[i
], NULL
, thr_enqueuer
,
354 &count_enqueuer
[2 * i
]);
358 for (i
= 0; i
< nr_dequeuers
; i
++) {
359 err
= pthread_create(&tid_dequeuer
[i
], NULL
, thr_dequeuer
,
360 &count_dequeuer
[2 * i
]);
369 for (i
= 0; i
< duration
; i
++) {
377 for (i
= 0; i
< nr_enqueuers
; i
++) {
378 err
= pthread_join(tid_enqueuer
[i
], &tret
);
381 tot_enqueues
+= count_enqueuer
[2 * i
];
382 tot_successful_enqueues
+= count_enqueuer
[2 * i
+ 1];
384 for (i
= 0; i
< nr_dequeuers
; i
++) {
385 err
= pthread_join(tid_dequeuer
[i
], &tret
);
388 tot_dequeues
+= count_dequeuer
[2 * i
];
389 tot_successful_dequeues
+= count_dequeuer
[2 * i
+ 1];
392 test_end(&q
, &end_dequeues
);
394 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
395 tot_enqueues
, tot_dequeues
);
396 printf_verbose("total number of successful enqueues : %llu, "
397 "successful dequeues %llu\n",
398 tot_successful_enqueues
, tot_successful_dequeues
);
399 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
401 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
402 "successful enqueues %12llu successful dequeues %12llu "
403 "end_dequeues %llu nr_ops %12llu\n",
404 argv
[0], duration
, nr_enqueuers
, wdelay
,
405 nr_dequeuers
, rduration
, tot_enqueues
, tot_dequeues
,
406 tot_successful_enqueues
,
407 tot_successful_dequeues
, end_dequeues
,
408 tot_enqueues
+ tot_dequeues
);
409 if (tot_successful_enqueues
!= tot_successful_dequeues
+ end_dequeues
)
410 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
411 "succ. dequeues + end dequeues %llu.\n",
412 tot_successful_enqueues
,
413 tot_successful_dequeues
+ end_dequeues
);
415 free(count_enqueuer
);
416 free(count_dequeuer
);