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.
25 #include "../config.h"
32 #include <sys/types.h>
39 #include <urcu/arch.h>
40 #include <urcu/tls-compat.h>
42 #include "thread-id.h"
44 /* hardcoded number of CPUs */
47 #ifndef DYNAMIC_LINK_TEST
52 /* Remove deprecation warnings from test build. */
53 #define CDS_LFS_RCU_DEPRECATED
57 static volatile int test_go
, test_stop
;
59 static unsigned long rduration
;
61 static unsigned long duration
;
63 /* read-side C.S. duration, in loops */
64 static unsigned long wdelay
;
66 static inline void loop_sleep(unsigned long loops
)
72 static int verbose_mode
;
74 #define printf_verbose(fmt, args...) \
80 static unsigned int cpu_affinities
[NR_CPUS
];
81 static unsigned int next_aff
= 0;
82 static int use_affinity
= 0;
84 pthread_mutex_t affinity_mutex
= PTHREAD_MUTEX_INITIALIZER
;
86 static void set_affinity(void)
95 #if HAVE_SCHED_SETAFFINITY
96 ret
= pthread_mutex_lock(&affinity_mutex
);
98 perror("Error in pthread mutex lock");
101 cpu
= cpu_affinities
[next_aff
++];
102 ret
= pthread_mutex_unlock(&affinity_mutex
);
104 perror("Error in pthread mutex unlock");
110 #if SCHED_SETAFFINITY_ARGS == 2
111 sched_setaffinity(0, &mask
);
113 sched_setaffinity(0, sizeof(mask
), &mask
);
115 #endif /* HAVE_SCHED_SETAFFINITY */
119 * returns 0 if test should end.
121 static int test_duration_dequeue(void)
126 static int test_duration_enqueue(void)
131 static DEFINE_URCU_TLS(unsigned long long, nr_dequeues
);
132 static DEFINE_URCU_TLS(unsigned long long, nr_enqueues
);
134 static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues
);
135 static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues
);
137 static unsigned int nr_enqueuers
;
138 static unsigned int nr_dequeuers
;
141 struct cds_lfs_node_rcu list
;
145 static struct cds_lfs_stack_rcu s
;
147 void *thr_enqueuer(void *_count
)
149 unsigned long long *count
= _count
;
151 printf_verbose("thread_begin %s, tid %lu\n",
152 "enqueuer", urcu_get_thread_id());
156 rcu_register_thread();
164 struct test
*node
= malloc(sizeof(*node
));
167 cds_lfs_node_init_rcu(&node
->list
);
168 /* No rcu read-side is needed for push */
169 cds_lfs_push_rcu(&s
, &node
->list
);
170 URCU_TLS(nr_successful_enqueues
)++;
172 if (caa_unlikely(wdelay
))
175 URCU_TLS(nr_enqueues
)++;
176 if (caa_unlikely(!test_duration_enqueue()))
180 rcu_unregister_thread();
182 count
[0] = URCU_TLS(nr_enqueues
);
183 count
[1] = URCU_TLS(nr_successful_enqueues
);
184 printf_verbose("enqueuer thread_end, tid %lu, "
185 "enqueues %llu successful_enqueues %llu\n",
186 urcu_get_thread_id(),
187 URCU_TLS(nr_enqueues
),
188 URCU_TLS(nr_successful_enqueues
));
194 void free_node_cb(struct rcu_head
*head
)
197 caa_container_of(head
, struct test
, rcu
);
201 void *thr_dequeuer(void *_count
)
203 unsigned long long *count
= _count
;
205 printf_verbose("thread_begin %s, tid %lu\n",
206 "dequeuer", urcu_get_thread_id());
210 rcu_register_thread();
218 struct cds_lfs_node_rcu
*snode
;
221 snode
= cds_lfs_pop_rcu(&s
);
226 node
= caa_container_of(snode
, struct test
, list
);
227 call_rcu(&node
->rcu
, free_node_cb
);
228 URCU_TLS(nr_successful_dequeues
)++;
230 URCU_TLS(nr_dequeues
)++;
231 if (caa_unlikely(!test_duration_dequeue()))
233 if (caa_unlikely(rduration
))
234 loop_sleep(rduration
);
237 rcu_unregister_thread();
239 printf_verbose("dequeuer thread_end, tid %lu, "
240 "dequeues %llu, successful_dequeues %llu\n",
241 urcu_get_thread_id(),
242 URCU_TLS(nr_dequeues
),
243 URCU_TLS(nr_successful_dequeues
));
244 count
[0] = URCU_TLS(nr_dequeues
);
245 count
[1] = URCU_TLS(nr_successful_dequeues
);
249 void test_end(struct cds_lfs_stack_rcu
*s
, unsigned long long *nr_dequeues
)
251 struct cds_lfs_node_rcu
*snode
;
254 snode
= cds_lfs_pop_rcu(s
);
258 node
= caa_container_of(snode
, struct test
, list
);
265 void show_usage(int argc
, char **argv
)
267 printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
269 printf("OPTIONS:\n");
270 printf(" [-d delay] (enqueuer period (in loops))\n");
271 printf(" [-c duration] (dequeuer period (in loops))\n");
272 printf(" [-v] (verbose output)\n");
273 printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
277 int main(int argc
, char **argv
)
280 pthread_t
*tid_enqueuer
, *tid_dequeuer
;
282 unsigned long long *count_enqueuer
, *count_dequeuer
;
283 unsigned long long tot_enqueues
= 0, tot_dequeues
= 0;
284 unsigned long long tot_successful_enqueues
= 0,
285 tot_successful_dequeues
= 0;
286 unsigned long long end_dequeues
= 0;
290 show_usage(argc
, argv
);
294 err
= sscanf(argv
[1], "%u", &nr_dequeuers
);
296 show_usage(argc
, argv
);
300 err
= sscanf(argv
[2], "%u", &nr_enqueuers
);
302 show_usage(argc
, argv
);
306 err
= sscanf(argv
[3], "%lu", &duration
);
308 show_usage(argc
, argv
);
312 for (i
= 4; i
< argc
; i
++) {
313 if (argv
[i
][0] != '-')
315 switch (argv
[i
][1]) {
318 show_usage(argc
, argv
);
322 cpu_affinities
[next_aff
++] = a
;
324 printf_verbose("Adding CPU %d affinity\n", a
);
328 show_usage(argc
, argv
);
331 rduration
= atol(argv
[++i
]);
335 show_usage(argc
, argv
);
338 wdelay
= atol(argv
[++i
]);
346 printf_verbose("running test for %lu seconds, %u enqueuers, "
348 duration
, nr_enqueuers
, nr_dequeuers
);
349 printf_verbose("Writer delay : %lu loops.\n", rduration
);
350 printf_verbose("Reader duration : %lu loops.\n", wdelay
);
351 printf_verbose("thread %-6s, tid %lu\n",
352 "main", urcu_get_thread_id());
354 tid_enqueuer
= malloc(sizeof(*tid_enqueuer
) * nr_enqueuers
);
355 tid_dequeuer
= malloc(sizeof(*tid_dequeuer
) * nr_dequeuers
);
356 count_enqueuer
= malloc(2 * sizeof(*count_enqueuer
) * nr_enqueuers
);
357 count_dequeuer
= malloc(2 * sizeof(*count_dequeuer
) * nr_dequeuers
);
358 cds_lfs_init_rcu(&s
);
359 err
= create_all_cpu_call_rcu_data(0);
361 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
366 for (i
= 0; i
< nr_enqueuers
; i
++) {
367 err
= pthread_create(&tid_enqueuer
[i
], NULL
, thr_enqueuer
,
368 &count_enqueuer
[2 * i
]);
372 for (i
= 0; i
< nr_dequeuers
; i
++) {
373 err
= pthread_create(&tid_dequeuer
[i
], NULL
, thr_dequeuer
,
374 &count_dequeuer
[2 * i
]);
383 for (i
= 0; i
< duration
; i
++) {
391 for (i
= 0; i
< nr_enqueuers
; i
++) {
392 err
= pthread_join(tid_enqueuer
[i
], &tret
);
395 tot_enqueues
+= count_enqueuer
[2 * i
];
396 tot_successful_enqueues
+= count_enqueuer
[2 * i
+ 1];
398 for (i
= 0; i
< nr_dequeuers
; i
++) {
399 err
= pthread_join(tid_dequeuer
[i
], &tret
);
402 tot_dequeues
+= count_dequeuer
[2 * i
];
403 tot_successful_dequeues
+= count_dequeuer
[2 * i
+ 1];
406 test_end(&s
, &end_dequeues
);
408 printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
409 tot_enqueues
, tot_dequeues
);
410 printf_verbose("total number of successful enqueues : %llu, "
411 "successful dequeues %llu\n",
412 tot_successful_enqueues
, tot_successful_dequeues
);
413 printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
415 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
416 "successful enqueues %12llu successful dequeues %12llu "
417 "end_dequeues %llu nr_ops %12llu\n",
418 argv
[0], duration
, nr_enqueuers
, wdelay
,
419 nr_dequeuers
, rduration
, tot_enqueues
, tot_dequeues
,
420 tot_successful_enqueues
,
421 tot_successful_dequeues
, end_dequeues
,
422 tot_enqueues
+ tot_dequeues
);
423 if (tot_successful_enqueues
!= tot_successful_dequeues
+ end_dequeues
)
424 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
425 "succ. dequeues + end dequeues %llu.\n",
426 tot_successful_enqueues
,
427 tot_successful_dequeues
+ end_dequeues
);
429 free_all_cpu_call_rcu_data();
430 free(count_enqueuer
);
431 free(count_dequeuer
);