4 * Userspace RCU library - batch memory reclamation with kernel API
6 * Copyright (c) 2010 Paul E. McKenney <paulmck@linux.vnet.ibm.com>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
38 #include "urcu/wfqueue.h"
39 #include "urcu-call-rcu.h"
40 #include "urcu-pointer.h"
41 #include "urcu/list.h"
42 #include "urcu/futex.h"
44 /* Data structure that identifies a call_rcu thread. */
46 struct call_rcu_data
{
47 struct cds_wfq_queue cbs
;
50 unsigned long qlen
; /* maintained for debugging. */
53 struct cds_list_head list
;
54 } __attribute__((aligned(CAA_CACHE_LINE_SIZE
)));
57 * List of all call_rcu_data structures to keep valgrind happy.
58 * Protected by call_rcu_mutex.
61 CDS_LIST_HEAD(call_rcu_data_list
);
63 /* Link a thread using call_rcu() to its call_rcu thread. */
65 static __thread
struct call_rcu_data
*thread_call_rcu_data
;
68 * Guard call_rcu thread creation and atfork handlers.
70 static pthread_mutex_t call_rcu_mutex
= PTHREAD_MUTEX_INITIALIZER
;
72 /* If a given thread does not have its own call_rcu thread, this is default. */
74 static struct call_rcu_data
*default_call_rcu_data
;
77 * If the sched_getcpu() and sysconf(_SC_NPROCESSORS_CONF) calls are
78 * available, then we can have call_rcu threads assigned to individual
79 * CPUs rather than only to specific threads.
82 #if defined(HAVE_SCHED_GETCPU) && defined(HAVE_SYSCONF)
85 * Pointer to array of pointers to per-CPU call_rcu_data structures
86 * and # CPUs. per_cpu_call_rcu_data is a RCU-protected pointer to an
87 * array of RCU-protected pointers to call_rcu_data. call_rcu acts as a
88 * RCU read-side and reads per_cpu_call_rcu_data and the per-cpu pointer
89 * without mutex. The call_rcu_mutex protects updates.
92 static struct call_rcu_data
**per_cpu_call_rcu_data
;
95 static void maxcpus_reset(void)
100 /* Allocate the array if it has not already been allocated. */
102 static void alloc_cpu_call_rcu_data(void)
104 struct call_rcu_data
**p
;
105 static int warned
= 0;
109 maxcpus
= sysconf(_SC_NPROCESSORS_CONF
);
113 p
= malloc(maxcpus
* sizeof(*per_cpu_call_rcu_data
));
115 memset(p
, '\0', maxcpus
* sizeof(*per_cpu_call_rcu_data
));
116 rcu_set_pointer(&per_cpu_call_rcu_data
, p
);
119 fprintf(stderr
, "[error] liburcu: unable to allocate per-CPU pointer array\n");
125 #else /* #if defined(HAVE_SCHED_GETCPU) && defined(HAVE_SYSCONF) */
128 * per_cpu_call_rcu_data should be constant, but some functions below, used both
129 * for cases where cpu number is available and not available, assume it it not
132 static struct call_rcu_data
**per_cpu_call_rcu_data
= NULL
;
133 static const long maxcpus
= -1;
135 static void maxcpus_reset(void)
139 static void alloc_cpu_call_rcu_data(void)
143 static int sched_getcpu(void)
148 #endif /* #else #if defined(HAVE_SCHED_GETCPU) && defined(HAVE_SYSCONF) */
150 /* Acquire the specified pthread mutex. */
152 static void call_rcu_lock(pthread_mutex_t
*pmp
)
154 if (pthread_mutex_lock(pmp
) != 0) {
155 perror("pthread_mutex_lock");
160 /* Release the specified pthread mutex. */
162 static void call_rcu_unlock(pthread_mutex_t
*pmp
)
164 if (pthread_mutex_unlock(pmp
) != 0) {
165 perror("pthread_mutex_unlock");
170 #if HAVE_SCHED_SETAFFINITY
172 int set_thread_cpu_affinity(struct call_rcu_data
*crdp
)
176 if (crdp
->cpu_affinity
< 0)
180 CPU_SET(crdp
->cpu_affinity
, &mask
);
181 #if SCHED_SETAFFINITY_ARGS == 2
182 return sched_setaffinity(0, &mask
);
184 return sched_setaffinity(0, sizeof(mask
), &mask
);
189 int set_thread_cpu_affinity(struct call_rcu_data
*crdp
)
195 static void call_rcu_wait(struct call_rcu_data
*crdp
)
197 /* Read call_rcu list before read futex */
199 if (uatomic_read(&crdp
->futex
) == -1)
200 futex_async(&crdp
->futex
, FUTEX_WAIT
, -1,
204 static void call_rcu_wake_up(struct call_rcu_data
*crdp
)
206 /* Write to call_rcu list before reading/writing futex */
208 if (caa_unlikely(uatomic_read(&crdp
->futex
) == -1)) {
209 uatomic_set(&crdp
->futex
, 0);
210 futex_async(&crdp
->futex
, FUTEX_WAKE
, 1,
215 /* This is the code run by each call_rcu thread. */
217 static void *call_rcu_thread(void *arg
)
219 unsigned long cbcount
;
220 struct cds_wfq_node
*cbs
;
221 struct cds_wfq_node
**cbs_tail
;
222 struct call_rcu_data
*crdp
= (struct call_rcu_data
*)arg
;
223 struct rcu_head
*rhp
;
224 int rt
= !!(uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_RT
);
226 if (set_thread_cpu_affinity(crdp
) != 0) {
227 perror("pthread_setaffinity_np");
232 * If callbacks take a read-side lock, we need to be registered.
234 rcu_register_thread();
236 thread_call_rcu_data
= crdp
;
238 uatomic_dec(&crdp
->futex
);
239 /* Decrement futex before reading call_rcu list */
243 if (uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_PAUSE
) {
245 * Pause requested. Become quiescent: remove
246 * ourself from all global lists, and don't
247 * process any callback. The callback lists may
248 * still be non-empty though.
250 rcu_unregister_thread();
251 cmm_smp_mb__before_uatomic_or();
252 uatomic_or(&crdp
->flags
, URCU_CALL_RCU_PAUSED
);
253 while ((uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_PAUSE
) != 0)
255 rcu_register_thread();
258 if (&crdp
->cbs
.head
!= _CMM_LOAD_SHARED(crdp
->cbs
.tail
)) {
259 while ((cbs
= _CMM_LOAD_SHARED(crdp
->cbs
.head
)) == NULL
)
261 _CMM_STORE_SHARED(crdp
->cbs
.head
, NULL
);
262 cbs_tail
= (struct cds_wfq_node
**)
263 uatomic_xchg(&crdp
->cbs
.tail
, &crdp
->cbs
.head
);
267 while (cbs
->next
== NULL
&&
268 &cbs
->next
!= cbs_tail
)
270 if (cbs
== &crdp
->cbs
.dummy
) {
274 rhp
= (struct rcu_head
*)cbs
;
278 } while (cbs
!= NULL
);
279 uatomic_sub(&crdp
->qlen
, cbcount
);
281 if (uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_STOP
)
283 rcu_thread_offline();
286 == _CMM_LOAD_SHARED(crdp
->cbs
.tail
)) {
289 uatomic_dec(&crdp
->futex
);
291 * Decrement futex before reading
305 * Read call_rcu list before write futex.
308 uatomic_set(&crdp
->futex
, 0);
310 uatomic_or(&crdp
->flags
, URCU_CALL_RCU_STOPPED
);
311 rcu_unregister_thread();
316 * Create both a call_rcu thread and the corresponding call_rcu_data
317 * structure, linking the structure in as specified. Caller must hold
321 static void call_rcu_data_init(struct call_rcu_data
**crdpp
,
325 struct call_rcu_data
*crdp
;
327 crdp
= malloc(sizeof(*crdp
));
329 fprintf(stderr
, "Out of memory.\n");
332 memset(crdp
, '\0', sizeof(*crdp
));
333 cds_wfq_init(&crdp
->cbs
);
337 cds_list_add(&crdp
->list
, &call_rcu_data_list
);
338 crdp
->cpu_affinity
= cpu_affinity
;
339 cmm_smp_mb(); /* Structure initialized before pointer is planted. */
341 if (pthread_create(&crdp
->tid
, NULL
, call_rcu_thread
, crdp
) != 0) {
342 perror("pthread_create");
348 * Return a pointer to the call_rcu_data structure for the specified
349 * CPU, returning NULL if there is none. We cannot automatically
350 * created it because the platform we are running on might not define
353 * The call to this function and use of the returned call_rcu_data
354 * should be protected by RCU read-side lock.
357 struct call_rcu_data
*get_cpu_call_rcu_data(int cpu
)
359 static int warned
= 0;
360 struct call_rcu_data
**pcpu_crdp
;
362 pcpu_crdp
= rcu_dereference(per_cpu_call_rcu_data
);
363 if (pcpu_crdp
== NULL
)
365 if (!warned
&& maxcpus
> 0 && (cpu
< 0 || maxcpus
<= cpu
)) {
366 fprintf(stderr
, "[error] liburcu: get CPU # out of range\n");
369 if (cpu
< 0 || maxcpus
<= cpu
)
371 return rcu_dereference(pcpu_crdp
[cpu
]);
375 * Return the tid corresponding to the call_rcu thread whose
376 * call_rcu_data structure is specified.
379 pthread_t
get_call_rcu_thread(struct call_rcu_data
*crdp
)
385 * Create a call_rcu_data structure (with thread) and return a pointer.
388 static struct call_rcu_data
*__create_call_rcu_data(unsigned long flags
,
391 struct call_rcu_data
*crdp
;
393 call_rcu_data_init(&crdp
, flags
, cpu_affinity
);
397 struct call_rcu_data
*create_call_rcu_data(unsigned long flags
,
400 struct call_rcu_data
*crdp
;
402 call_rcu_lock(&call_rcu_mutex
);
403 crdp
= __create_call_rcu_data(flags
, cpu_affinity
);
404 call_rcu_unlock(&call_rcu_mutex
);
409 * Set the specified CPU to use the specified call_rcu_data structure.
411 * Use NULL to remove a CPU's call_rcu_data structure, but it is
412 * the caller's responsibility to dispose of the removed structure.
413 * Use get_cpu_call_rcu_data() to obtain a pointer to the old structure
414 * (prior to NULLing it out, of course).
416 * The caller must wait for a grace-period to pass between return from
417 * set_cpu_call_rcu_data() and call to call_rcu_data_free() passing the
418 * previous call rcu data as argument.
421 int set_cpu_call_rcu_data(int cpu
, struct call_rcu_data
*crdp
)
423 static int warned
= 0;
425 call_rcu_lock(&call_rcu_mutex
);
426 alloc_cpu_call_rcu_data();
427 if (cpu
< 0 || maxcpus
<= cpu
) {
429 fprintf(stderr
, "[error] liburcu: set CPU # out of range\n");
432 call_rcu_unlock(&call_rcu_mutex
);
437 if (per_cpu_call_rcu_data
== NULL
) {
438 call_rcu_unlock(&call_rcu_mutex
);
443 if (per_cpu_call_rcu_data
[cpu
] != NULL
&& crdp
!= NULL
) {
444 call_rcu_unlock(&call_rcu_mutex
);
449 rcu_set_pointer(&per_cpu_call_rcu_data
[cpu
], crdp
);
450 call_rcu_unlock(&call_rcu_mutex
);
455 * Return a pointer to the default call_rcu_data structure, creating
456 * one if need be. Because we never free call_rcu_data structures,
457 * we don't need to be in an RCU read-side critical section.
460 struct call_rcu_data
*get_default_call_rcu_data(void)
462 if (default_call_rcu_data
!= NULL
)
463 return rcu_dereference(default_call_rcu_data
);
464 call_rcu_lock(&call_rcu_mutex
);
465 if (default_call_rcu_data
!= NULL
) {
466 call_rcu_unlock(&call_rcu_mutex
);
467 return default_call_rcu_data
;
469 call_rcu_data_init(&default_call_rcu_data
, 0, -1);
470 call_rcu_unlock(&call_rcu_mutex
);
471 return default_call_rcu_data
;
475 * Return the call_rcu_data structure that applies to the currently
476 * running thread. Any call_rcu_data structure assigned specifically
477 * to this thread has first priority, followed by any call_rcu_data
478 * structure assigned to the CPU on which the thread is running,
479 * followed by the default call_rcu_data structure. If there is not
480 * yet a default call_rcu_data structure, one will be created.
482 * Calls to this function and use of the returned call_rcu_data should
483 * be protected by RCU read-side lock.
485 struct call_rcu_data
*get_call_rcu_data(void)
487 struct call_rcu_data
*crd
;
489 if (thread_call_rcu_data
!= NULL
)
490 return thread_call_rcu_data
;
493 crd
= get_cpu_call_rcu_data(sched_getcpu());
498 return get_default_call_rcu_data();
502 * Return a pointer to this task's call_rcu_data if there is one.
505 struct call_rcu_data
*get_thread_call_rcu_data(void)
507 return thread_call_rcu_data
;
511 * Set this task's call_rcu_data structure as specified, regardless
512 * of whether or not this task already had one. (This allows switching
513 * to and from real-time call_rcu threads, for example.)
515 * Use NULL to remove a thread's call_rcu_data structure, but it is
516 * the caller's responsibility to dispose of the removed structure.
517 * Use get_thread_call_rcu_data() to obtain a pointer to the old structure
518 * (prior to NULLing it out, of course).
521 void set_thread_call_rcu_data(struct call_rcu_data
*crdp
)
523 thread_call_rcu_data
= crdp
;
527 * Create a separate call_rcu thread for each CPU. This does not
528 * replace a pre-existing call_rcu thread -- use the set_cpu_call_rcu_data()
529 * function if you want that behavior. Should be paired with
530 * free_all_cpu_call_rcu_data() to teardown these call_rcu worker
534 int create_all_cpu_call_rcu_data(unsigned long flags
)
537 struct call_rcu_data
*crdp
;
540 call_rcu_lock(&call_rcu_mutex
);
541 alloc_cpu_call_rcu_data();
542 call_rcu_unlock(&call_rcu_mutex
);
547 if (per_cpu_call_rcu_data
== NULL
) {
551 for (i
= 0; i
< maxcpus
; i
++) {
552 call_rcu_lock(&call_rcu_mutex
);
553 if (get_cpu_call_rcu_data(i
)) {
554 call_rcu_unlock(&call_rcu_mutex
);
557 crdp
= __create_call_rcu_data(flags
, i
);
559 call_rcu_unlock(&call_rcu_mutex
);
563 call_rcu_unlock(&call_rcu_mutex
);
564 if ((ret
= set_cpu_call_rcu_data(i
, crdp
)) != 0) {
565 call_rcu_data_free(crdp
);
567 /* it has been created by other thread */
578 * Wake up the call_rcu thread corresponding to the specified
579 * call_rcu_data structure.
581 static void wake_call_rcu_thread(struct call_rcu_data
*crdp
)
583 if (!(_CMM_LOAD_SHARED(crdp
->flags
) & URCU_CALL_RCU_RT
))
584 call_rcu_wake_up(crdp
);
588 * Schedule a function to be invoked after a following grace period.
589 * This is the only function that must be called -- the others are
590 * only present to allow applications to tune their use of RCU for
591 * maximum performance.
593 * Note that unless a call_rcu thread has not already been created,
594 * the first invocation of call_rcu() will create one. So, if you
595 * need the first invocation of call_rcu() to be fast, make sure
596 * to create a call_rcu thread first. One way to accomplish this is
597 * "get_call_rcu_data();", and another is create_all_cpu_call_rcu_data().
599 * call_rcu must be called by registered RCU read-side threads.
602 void call_rcu(struct rcu_head
*head
,
603 void (*func
)(struct rcu_head
*head
))
605 struct call_rcu_data
*crdp
;
607 cds_wfq_node_init(&head
->next
);
609 /* Holding rcu read-side lock across use of per-cpu crdp */
611 crdp
= get_call_rcu_data();
612 cds_wfq_enqueue(&crdp
->cbs
, &head
->next
);
613 uatomic_inc(&crdp
->qlen
);
614 wake_call_rcu_thread(crdp
);
619 * Free up the specified call_rcu_data structure, terminating the
620 * associated call_rcu thread. The caller must have previously
621 * removed the call_rcu_data structure from per-thread or per-CPU
622 * usage. For example, set_cpu_call_rcu_data(cpu, NULL) for per-CPU
623 * call_rcu_data structures or set_thread_call_rcu_data(NULL) for
624 * per-thread call_rcu_data structures.
626 * We silently refuse to free up the default call_rcu_data structure
627 * because that is where we put any leftover callbacks. Note that
628 * the possibility of self-spawning callbacks makes it impossible
629 * to execute all the callbacks in finite time without putting any
630 * newly spawned callbacks somewhere else. The "somewhere else" of
631 * last resort is the default call_rcu_data structure.
633 * We also silently refuse to free NULL pointers. This simplifies
636 * The caller must wait for a grace-period to pass between return from
637 * set_cpu_call_rcu_data() and call to call_rcu_data_free() passing the
638 * previous call rcu data as argument.
640 void call_rcu_data_free(struct call_rcu_data
*crdp
)
642 struct cds_wfq_node
*cbs
;
643 struct cds_wfq_node
**cbs_tail
;
644 struct cds_wfq_node
**cbs_endprev
;
646 if (crdp
== NULL
|| crdp
== default_call_rcu_data
) {
649 if ((uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_STOPPED
) == 0) {
650 uatomic_or(&crdp
->flags
, URCU_CALL_RCU_STOP
);
651 wake_call_rcu_thread(crdp
);
652 while ((uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_STOPPED
) == 0)
655 if (&crdp
->cbs
.head
!= _CMM_LOAD_SHARED(crdp
->cbs
.tail
)) {
656 while ((cbs
= _CMM_LOAD_SHARED(crdp
->cbs
.head
)) == NULL
)
658 _CMM_STORE_SHARED(crdp
->cbs
.head
, NULL
);
659 cbs_tail
= (struct cds_wfq_node
**)
660 uatomic_xchg(&crdp
->cbs
.tail
, &crdp
->cbs
.head
);
661 /* Create default call rcu data if need be */
662 (void) get_default_call_rcu_data();
663 cbs_endprev
= (struct cds_wfq_node
**)
664 uatomic_xchg(&default_call_rcu_data
->cbs
.tail
,
666 _CMM_STORE_SHARED(*cbs_endprev
, cbs
);
667 uatomic_add(&default_call_rcu_data
->qlen
,
668 uatomic_read(&crdp
->qlen
));
669 wake_call_rcu_thread(default_call_rcu_data
);
672 call_rcu_lock(&call_rcu_mutex
);
673 cds_list_del(&crdp
->list
);
674 call_rcu_unlock(&call_rcu_mutex
);
680 * Clean up all the per-CPU call_rcu threads.
682 void free_all_cpu_call_rcu_data(void)
685 struct call_rcu_data
**crdp
;
686 static int warned
= 0;
691 crdp
= malloc(sizeof(*crdp
) * maxcpus
);
694 fprintf(stderr
, "[error] liburcu: unable to allocate per-CPU pointer array\n");
700 for (cpu
= 0; cpu
< maxcpus
; cpu
++) {
701 crdp
[cpu
] = get_cpu_call_rcu_data(cpu
);
702 if (crdp
[cpu
] == NULL
)
704 set_cpu_call_rcu_data(cpu
, NULL
);
707 * Wait for call_rcu sites acting as RCU readers of the
708 * call_rcu_data to become quiescent.
711 for (cpu
= 0; cpu
< maxcpus
; cpu
++) {
712 if (crdp
[cpu
] == NULL
)
714 call_rcu_data_free(crdp
[cpu
]);
720 * Acquire the call_rcu_mutex in order to ensure that the child sees
721 * all of the call_rcu() data structures in a consistent state. Ensure
722 * that all call_rcu threads are in a quiescent state across fork.
723 * Suitable for pthread_atfork() and friends.
725 void call_rcu_before_fork(void)
727 struct call_rcu_data
*crdp
;
729 call_rcu_lock(&call_rcu_mutex
);
731 cds_list_for_each_entry(crdp
, &call_rcu_data_list
, list
) {
732 uatomic_or(&crdp
->flags
, URCU_CALL_RCU_PAUSE
);
733 cmm_smp_mb__after_uatomic_or();
734 wake_call_rcu_thread(crdp
);
736 cds_list_for_each_entry(crdp
, &call_rcu_data_list
, list
) {
737 while ((uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_PAUSED
) == 0)
743 * Clean up call_rcu data structures in the parent of a successful fork()
744 * that is not followed by exec() in the child. Suitable for
745 * pthread_atfork() and friends.
747 void call_rcu_after_fork_parent(void)
749 struct call_rcu_data
*crdp
;
751 cds_list_for_each_entry(crdp
, &call_rcu_data_list
, list
)
752 uatomic_and(&crdp
->flags
, ~URCU_CALL_RCU_PAUSE
);
753 call_rcu_unlock(&call_rcu_mutex
);
757 * Clean up call_rcu data structures in the child of a successful fork()
758 * that is not followed by exec(). Suitable for pthread_atfork() and
761 void call_rcu_after_fork_child(void)
763 struct call_rcu_data
*crdp
, *next
;
765 /* Release the mutex. */
766 call_rcu_unlock(&call_rcu_mutex
);
768 /* Do nothing when call_rcu() has not been used */
769 if (cds_list_empty(&call_rcu_data_list
))
773 * Allocate a new default call_rcu_data structure in order
774 * to get a working call_rcu thread to go with it.
776 default_call_rcu_data
= NULL
;
777 (void)get_default_call_rcu_data();
779 /* Cleanup call_rcu_data pointers before use */
781 free(per_cpu_call_rcu_data
);
782 rcu_set_pointer(&per_cpu_call_rcu_data
, NULL
);
783 thread_call_rcu_data
= NULL
;
786 * Dispose of all of the rest of the call_rcu_data structures.
787 * Leftover call_rcu callbacks will be merged into the new
788 * default call_rcu thread queue.
790 cds_list_for_each_entry_safe(crdp
, next
, &call_rcu_data_list
, list
) {
791 if (crdp
== default_call_rcu_data
)
793 uatomic_set(&crdp
->flags
, URCU_CALL_RCU_STOPPED
);
794 call_rcu_data_free(crdp
);