4 * Userspace RCU library - example RCU-based lock-free stack
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
49 /* Remove deprecation warnings from test build. */
50 #define CDS_LFS_RCU_DEPRECATED
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
;
135 struct cds_lfs_node_rcu list
;
139 static struct cds_lfs_stack_rcu s
;
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());
150 rcu_register_thread();
158 struct test
*node
= malloc(sizeof(*node
));
161 cds_lfs_node_init_rcu(&node
->list
);
162 /* No rcu read-side is needed for push */
163 cds_lfs_push_rcu(&s
, &node
->list
);
164 URCU_TLS(nr_successful_enqueues
)++;
166 if (caa_unlikely(wdelay
))
169 URCU_TLS(nr_enqueues
)++;
170 if (caa_unlikely(!test_duration_enqueue()))
174 rcu_unregister_thread();
176 count
[0] = URCU_TLS(nr_enqueues
);
177 count
[1] = URCU_TLS(nr_successful_enqueues
);
178 printf_verbose("enqueuer thread_end, tid %lu, "
179 "enqueues %llu successful_enqueues %llu\n",
180 urcu_get_thread_id(),
181 URCU_TLS(nr_enqueues
),
182 URCU_TLS(nr_successful_enqueues
));
188 void free_node_cb(struct rcu_head
*head
)
191 caa_container_of(head
, struct test
, rcu
);
195 void *thr_dequeuer(void *_count
)
197 unsigned long long *count
= _count
;
199 printf_verbose("thread_begin %s, tid %lu\n",
200 "dequeuer", urcu_get_thread_id());
204 rcu_register_thread();
212 struct cds_lfs_node_rcu
*snode
;
215 snode
= cds_lfs_pop_rcu(&s
);
220 node
= caa_container_of(snode
, struct test
, list
);
221 call_rcu(&node
->rcu
, free_node_cb
);
222 URCU_TLS(nr_successful_dequeues
)++;
224 URCU_TLS(nr_dequeues
)++;
225 if (caa_unlikely(!test_duration_dequeue()))
227 if (caa_unlikely(rduration
))
228 loop_sleep(rduration
);
231 rcu_unregister_thread();
233 printf_verbose("dequeuer thread_end, tid %lu, "
234 "dequeues %llu, successful_dequeues %llu\n",
235 urcu_get_thread_id(),
236 URCU_TLS(nr_dequeues
),
237 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_lfs_stack_rcu
*s
, unsigned long long *nr_dequeues
)
245 struct cds_lfs_node_rcu
*snode
;
248 snode
= cds_lfs_pop_rcu(s
);
252 node
= caa_container_of(snode
, struct test
, list
);
259 void show_usage(int argc
, char **argv
)
261 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
263 printf("OPTIONS:\n");
264 printf(" [-d delay] (enqueuer period (in loops))\n");
265 printf(" [-c duration] (dequeuer period (in loops))\n");
266 printf(" [-v] (verbose output)\n");
267 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
271 int main(int argc
, char **argv
)
274 pthread_t
*tid_enqueuer
, *tid_dequeuer
;
276 unsigned long long *count_enqueuer
, *count_dequeuer
;
277 unsigned long long tot_enqueues
= 0, tot_dequeues
= 0;
278 unsigned long long tot_successful_enqueues
= 0,
279 tot_successful_dequeues
= 0;
280 unsigned long long end_dequeues
= 0;
285 show_usage(argc
, argv
);
289 err
= sscanf(argv
[1], "%u", &nr_dequeuers
);
291 show_usage(argc
, argv
);
295 err
= sscanf(argv
[2], "%u", &nr_enqueuers
);
297 show_usage(argc
, argv
);
301 err
= sscanf(argv
[3], "%lu", &duration
);
303 show_usage(argc
, argv
);
307 for (i
= 4; i
< argc
; i
++) {
308 if (argv
[i
][0] != '-')
310 switch (argv
[i
][1]) {
313 show_usage(argc
, argv
);
317 cpu_affinities
[next_aff
++] = a
;
319 printf_verbose("Adding CPU %d affinity\n", a
);
323 show_usage(argc
, argv
);
326 rduration
= atol(argv
[++i
]);
330 show_usage(argc
, argv
);
333 wdelay
= atol(argv
[++i
]);
341 printf_verbose("running test for %lu seconds, %u enqueuers, "
343 duration
, nr_enqueuers
, nr_dequeuers
);
344 printf_verbose("Writer delay : %lu loops.\n", rduration
);
345 printf_verbose("Reader duration : %lu loops.\n", wdelay
);
346 printf_verbose("thread %-6s, tid %lu\n",
347 "main", urcu_get_thread_id());
349 tid_enqueuer
= calloc(nr_enqueuers
, sizeof(*tid_enqueuer
));
350 tid_dequeuer
= calloc(nr_dequeuers
, sizeof(*tid_dequeuer
));
351 count_enqueuer
= calloc(nr_enqueuers
, 2 * sizeof(*count_enqueuer
));
352 count_dequeuer
= calloc(nr_dequeuers
, 2 * sizeof(*count_dequeuer
));
353 cds_lfs_init_rcu(&s
);
354 err
= create_all_cpu_call_rcu_data(0);
356 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
361 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
362 err
= pthread_create(&tid_enqueuer
[i_thr
], NULL
, thr_enqueuer
,
363 &count_enqueuer
[2 * i_thr
]);
367 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
368 err
= pthread_create(&tid_dequeuer
[i_thr
], NULL
, thr_dequeuer
,
369 &count_dequeuer
[2 * i_thr
]);
378 for (i_thr
= 0; i_thr
< duration
; i_thr
++) {
381 fwrite(".", sizeof(char), 1, stdout
);
388 for (i_thr
= 0; i_thr
< nr_enqueuers
; i_thr
++) {
389 err
= pthread_join(tid_enqueuer
[i_thr
], &tret
);
392 tot_enqueues
+= count_enqueuer
[2 * i_thr
];
393 tot_successful_enqueues
+= count_enqueuer
[2 * i_thr
+ 1];
395 for (i_thr
= 0; i_thr
< nr_dequeuers
; i_thr
++) {
396 err
= pthread_join(tid_dequeuer
[i_thr
], &tret
);
399 tot_dequeues
+= count_dequeuer
[2 * i_thr
];
400 tot_successful_dequeues
+= count_dequeuer
[2 * i_thr
+ 1];
403 test_end(&s
, &end_dequeues
);
405 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
406 tot_enqueues
, tot_dequeues
);
407 printf_verbose("total number of successful enqueues : %llu, "
408 "successful dequeues %llu\n",
409 tot_successful_enqueues
, tot_successful_dequeues
);
410 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
412 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
413 "successful enqueues %12llu successful dequeues %12llu "
414 "end_dequeues %llu nr_ops %12llu\n",
415 argv
[0], duration
, nr_enqueuers
, wdelay
,
416 nr_dequeuers
, rduration
, tot_enqueues
, tot_dequeues
,
417 tot_successful_enqueues
,
418 tot_successful_dequeues
, end_dequeues
,
419 tot_enqueues
+ tot_dequeues
);
420 if (tot_successful_enqueues
!= tot_successful_dequeues
+ end_dequeues
)
421 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
422 "succ. dequeues + end dequeues %llu.\n",
423 tot_successful_enqueues
,
424 tot_successful_dequeues
+ end_dequeues
);
426 free_all_cpu_call_rcu_data();
427 free(count_enqueuer
);
428 free(count_dequeuer
);