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
;
142 void *thr_enqueuer(void *_count
)
144 unsigned long long *count
= _count
;
146 printf_verbose("thread_begin %s, tid %lu\n",
147 "enqueuer", urcu_get_thread_id());
157 struct cds_wfq_node
*node
= malloc(sizeof(*node
));
160 cds_wfq_node_init(node
);
161 cds_wfq_enqueue(&q
, node
);
162 URCU_TLS(nr_successful_enqueues
)++;
164 if (caa_unlikely(wdelay
))
167 URCU_TLS(nr_enqueues
)++;
168 if (caa_unlikely(!test_duration_enqueue()))
172 count
[0] = URCU_TLS(nr_enqueues
);
173 count
[1] = URCU_TLS(nr_successful_enqueues
);
174 printf_verbose("enqueuer thread_end, tid %lu, "
175 "enqueues %llu successful_enqueues %llu\n",
176 urcu_get_thread_id(),
177 URCU_TLS(nr_enqueues
),
178 URCU_TLS(nr_successful_enqueues
));
184 void *thr_dequeuer(void *_count
)
186 unsigned long long *count
= _count
;
188 printf_verbose("thread_begin %s, tid %lu\n",
189 "dequeuer", urcu_get_thread_id());
199 struct cds_wfq_node
*node
= cds_wfq_dequeue_blocking(&q
);
203 URCU_TLS(nr_successful_dequeues
)++;
206 URCU_TLS(nr_dequeues
)++;
207 if (caa_unlikely(!test_duration_dequeue()))
209 if (caa_unlikely(rduration
))
210 loop_sleep(rduration
);
213 printf_verbose("dequeuer thread_end, tid %lu, "
214 "dequeues %llu, successful_dequeues %llu\n",
215 urcu_get_thread_id(),
216 URCU_TLS(nr_dequeues
),
217 URCU_TLS(nr_successful_dequeues
));
218 count
[0] = URCU_TLS(nr_dequeues
);
219 count
[1] = URCU_TLS(nr_successful_dequeues
);
224 void test_end(unsigned long long *nr_dequeues_l
)
226 struct cds_wfq_node
*node
;
229 node
= cds_wfq_dequeue_blocking(&q
);
238 void show_usage(char **argv
)
240 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
242 printf("OPTIONS:\n");
243 printf(" [-d delay] (enqueuer period (in loops))\n");
244 printf(" [-c duration] (dequeuer period (in loops))\n");
245 printf(" [-v] (verbose output)\n");
246 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
250 int main(int argc
, char **argv
)
253 pthread_t
*tid_enqueuer
, *tid_dequeuer
;
255 unsigned long long *count_enqueuer
, *count_dequeuer
;
256 unsigned long long tot_enqueues
= 0, tot_dequeues
= 0;
257 unsigned long long tot_successful_enqueues
= 0,
258 tot_successful_dequeues
= 0;
259 unsigned long long end_dequeues
= 0;
268 err
= sscanf(argv
[1], "%u", &nr_dequeuers
);
274 err
= sscanf(argv
[2], "%u", &nr_enqueuers
);
280 err
= sscanf(argv
[3], "%lu", &duration
);
286 for (i
= 4; i
< argc
; i
++) {
287 if (argv
[i
][0] != '-')
289 switch (argv
[i
][1]) {
296 cpu_affinities
[next_aff
++] = a
;
298 printf_verbose("Adding CPU %d affinity\n", a
);
305 rduration
= atol(argv
[++i
]);
312 wdelay
= atol(argv
[++i
]);
320 printf_verbose("running test for %lu seconds, %u enqueuers, "
322 duration
, nr_enqueuers
, nr_dequeuers
);
323 printf_verbose("Writer delay : %lu loops.\n", rduration
);
324 printf_verbose("Reader duration : %lu loops.\n", wdelay
);
325 printf_verbose("thread %-6s, tid %lu\n",
326 "main", urcu_get_thread_id());
328 tid_enqueuer
= calloc(nr_enqueuers
, sizeof(*tid_enqueuer
));
329 tid_dequeuer
= calloc(nr_dequeuers
, sizeof(*tid_dequeuer
));
330 count_enqueuer
= calloc(nr_enqueuers
, 2 * sizeof(*count_enqueuer
));
331 count_dequeuer
= calloc(nr_dequeuers
, 2 * sizeof(*count_dequeuer
));
336 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
337 err
= pthread_create(&tid_enqueuer
[i_thr
], NULL
, thr_enqueuer
,
338 &count_enqueuer
[2 * i_thr
]);
342 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
343 err
= pthread_create(&tid_dequeuer
[i_thr
], NULL
, thr_dequeuer
,
344 &count_dequeuer
[2 * i_thr
]);
353 for (i_thr
= 0; i_thr
< duration
; i_thr
++) {
356 fwrite(".", sizeof(char), 1, stdout
);
363 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
364 err
= pthread_join(tid_enqueuer
[i_thr
], &tret
);
367 tot_enqueues
+= count_enqueuer
[2 * i_thr
];
368 tot_successful_enqueues
+= count_enqueuer
[2 * i_thr
+ 1];
370 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
371 err
= pthread_join(tid_dequeuer
[i_thr
], &tret
);
374 tot_dequeues
+= count_dequeuer
[2 * i_thr
];
375 tot_successful_dequeues
+= count_dequeuer
[2 * i_thr
+ 1];
378 test_end(&end_dequeues
);
380 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
381 tot_enqueues
, tot_dequeues
);
382 printf_verbose("total number of successful enqueues : %llu, "
383 "successful dequeues %llu\n",
384 tot_successful_enqueues
, tot_successful_dequeues
);
385 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
387 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
388 "successful enqueues %12llu successful dequeues %12llu "
389 "end_dequeues %llu nr_ops %12llu\n",
390 argv
[0], duration
, nr_enqueuers
, wdelay
,
391 nr_dequeuers
, rduration
, tot_enqueues
, tot_dequeues
,
392 tot_successful_enqueues
,
393 tot_successful_dequeues
, end_dequeues
,
394 tot_enqueues
+ tot_dequeues
);
395 if (tot_successful_enqueues
!= tot_successful_dequeues
+ end_dequeues
)
396 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
397 "succ. dequeues + end dequeues %llu.\n",
398 tot_successful_enqueues
,
399 tot_successful_dequeues
+ end_dequeues
);
402 free(count_enqueuer
);
403 free(count_dequeuer
);