4 * Userspace RCU library - example RCU-based lock-free concurrent 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>
40 #include <urcu/arch.h>
41 #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 #include <urcu/wfcqueue.h>
71 static volatile int test_go
, test_stop
;
73 static unsigned long rduration
;
75 static unsigned long duration
;
77 /* read-side C.S. duration, in loops */
78 static unsigned long wdelay
;
80 static inline void loop_sleep(unsigned long loops
)
86 static int verbose_mode
;
88 #define printf_verbose(fmt, args...) \
94 static unsigned int cpu_affinities
[NR_CPUS
];
95 static unsigned int next_aff
= 0;
96 static int use_affinity
= 0;
98 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
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)
106 static void set_affinity(void)
115 #if HAVE_SCHED_SETAFFINITY
116 ret
= pthread_mutex_lock(&affinity_mutex
);
118 perror("Error in pthread mutex lock");
121 cpu
= cpu_affinities
[next_aff
++];
122 ret
= pthread_mutex_unlock(&affinity_mutex
);
124 perror("Error in pthread mutex unlock");
130 #if SCHED_SETAFFINITY_ARGS == 2
131 sched_setaffinity(0, &mask
);
133 sched_setaffinity(0, sizeof(mask
), &mask
);
135 #endif /* HAVE_SCHED_SETAFFINITY */
139 * returns 0 if test should end.
141 static int test_duration_dequeue(void)
146 static int test_duration_enqueue(void)
151 static DEFINE_URCU_TLS(unsigned long long, nr_dequeues
);
152 static DEFINE_URCU_TLS(unsigned long long, nr_enqueues
);
154 static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues
);
155 static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues
);
157 static unsigned int nr_enqueuers
;
158 static unsigned int nr_dequeuers
;
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
;
163 void *thr_enqueuer(void *_count
)
165 unsigned long long *count
= _count
;
167 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
168 "enqueuer", pthread_self(), (unsigned long)gettid());
178 struct cds_wfcq_node
*node
= malloc(sizeof(*node
));
181 cds_wfcq_node_init(node
);
182 cds_wfcq_enqueue(&head
, &tail
, node
);
183 URCU_TLS(nr_successful_enqueues
)++;
185 if (caa_unlikely(wdelay
))
188 URCU_TLS(nr_enqueues
)++;
189 if (caa_unlikely(!test_duration_enqueue()))
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
));
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", pthread_self(), (unsigned long)gettid());
218 struct cds_wfcq_node
*node
=
219 cds_wfcq_dequeue_blocking(&head
, &tail
);
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",
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
);
242 void test_end(unsigned long long *nr_dequeues
)
244 struct cds_wfcq_node
*node
;
247 node
= cds_wfcq_dequeue_blocking(&head
, &tail
);
255 void show_usage(int argc
, char **argv
)
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)");
265 int main(int argc
, char **argv
)
268 pthread_t
*tid_enqueuer
, *tid_dequeuer
;
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;
278 show_usage(argc
, argv
);
282 err
= sscanf(argv
[1], "%u", &nr_dequeuers
);
284 show_usage(argc
, argv
);
288 err
= sscanf(argv
[2], "%u", &nr_enqueuers
);
290 show_usage(argc
, argv
);
294 err
= sscanf(argv
[3], "%lu", &duration
);
296 show_usage(argc
, argv
);
300 for (i
= 4; i
< argc
; i
++) {
301 if (argv
[i
][0] != '-')
303 switch (argv
[i
][1]) {
306 show_usage(argc
, argv
);
310 cpu_affinities
[next_aff
++] = a
;
312 printf_verbose("Adding CPU %d affinity\n", a
);
316 show_usage(argc
, argv
);
319 rduration
= atol(argv
[++i
]);
323 show_usage(argc
, argv
);
326 wdelay
= atol(argv
[++i
]);
334 printf_verbose("running test for %lu seconds, %u enqueuers, "
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());
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
);
350 for (i
= 0; i
< nr_enqueuers
; i
++) {
351 err
= pthread_create(&tid_enqueuer
[i
], NULL
, thr_enqueuer
,
352 &count_enqueuer
[2 * i
]);
356 for (i
= 0; i
< nr_dequeuers
; i
++) {
357 err
= pthread_create(&tid_dequeuer
[i
], NULL
, thr_dequeuer
,
358 &count_dequeuer
[2 * i
]);
367 for (i
= 0; i
< duration
; i
++) {
375 for (i
= 0; i
< nr_enqueuers
; i
++) {
376 err
= pthread_join(tid_enqueuer
[i
], &tret
);
379 tot_enqueues
+= count_enqueuer
[2 * i
];
380 tot_successful_enqueues
+= count_enqueuer
[2 * i
+ 1];
382 for (i
= 0; i
< nr_dequeuers
; i
++) {
383 err
= pthread_join(tid_dequeuer
[i
], &tret
);
386 tot_dequeues
+= count_dequeuer
[2 * i
];
387 tot_successful_dequeues
+= count_dequeuer
[2 * i
+ 1];
390 test_end(&end_dequeues
);
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 "
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
);
413 free(count_enqueuer
);
414 free(count_dequeuer
);