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"
43 #include "urcu/tls-compat.h"
46 /* Data structure that identifies a call_rcu thread. */
48 struct call_rcu_data
{
49 struct cds_wfq_queue cbs
;
52 unsigned long qlen
; /* maintained for debugging. */
55 struct cds_list_head list
;
56 } __attribute__((aligned(CAA_CACHE_LINE_SIZE
)));
59 * List of all call_rcu_data structures to keep valgrind happy.
60 * Protected by call_rcu_mutex.
63 CDS_LIST_HEAD(call_rcu_data_list
);
65 /* Link a thread using call_rcu() to its call_rcu thread. */
67 static DEFINE_URCU_TLS(struct call_rcu_data
*, thread_call_rcu_data
);
70 * Guard call_rcu thread creation and atfork handlers.
72 static pthread_mutex_t call_rcu_mutex
= PTHREAD_MUTEX_INITIALIZER
;
74 /* If a given thread does not have its own call_rcu thread, this is default. */
76 static struct call_rcu_data
*default_call_rcu_data
;
79 * If the sched_getcpu() and sysconf(_SC_NPROCESSORS_CONF) calls are
80 * available, then we can have call_rcu threads assigned to individual
81 * CPUs rather than only to specific threads.
84 #ifdef HAVE_SCHED_GETCPU
86 static int urcu_sched_getcpu(void)
88 return sched_getcpu();
91 #else /* #ifdef HAVE_SCHED_GETCPU */
93 static int urcu_sched_getcpu(void)
98 #endif /* #else #ifdef HAVE_SCHED_GETCPU */
100 #if defined(HAVE_SYSCONF) && defined(HAVE_SCHED_GETCPU)
103 * Pointer to array of pointers to per-CPU call_rcu_data structures
104 * and # CPUs. per_cpu_call_rcu_data is a RCU-protected pointer to an
105 * array of RCU-protected pointers to call_rcu_data. call_rcu acts as a
106 * RCU read-side and reads per_cpu_call_rcu_data and the per-cpu pointer
107 * without mutex. The call_rcu_mutex protects updates.
110 static struct call_rcu_data
**per_cpu_call_rcu_data
;
113 static void maxcpus_reset(void)
118 /* Allocate the array if it has not already been allocated. */
120 static void alloc_cpu_call_rcu_data(void)
122 struct call_rcu_data
**p
;
123 static int warned
= 0;
127 maxcpus
= sysconf(_SC_NPROCESSORS_CONF
);
131 p
= malloc(maxcpus
* sizeof(*per_cpu_call_rcu_data
));
133 memset(p
, '\0', maxcpus
* sizeof(*per_cpu_call_rcu_data
));
134 rcu_set_pointer(&per_cpu_call_rcu_data
, p
);
137 fprintf(stderr
, "[error] liburcu: unable to allocate per-CPU pointer array\n");
143 #else /* #if defined(HAVE_SYSCONF) && defined(HAVE_SCHED_GETCPU) */
146 * per_cpu_call_rcu_data should be constant, but some functions below, used both
147 * for cases where cpu number is available and not available, assume it it not
150 static struct call_rcu_data
**per_cpu_call_rcu_data
= NULL
;
151 static const long maxcpus
= -1;
153 static void maxcpus_reset(void)
157 static void alloc_cpu_call_rcu_data(void)
161 #endif /* #else #if defined(HAVE_SYSCONF) && defined(HAVE_SCHED_GETCPU) */
163 /* Acquire the specified pthread mutex. */
165 static void call_rcu_lock(pthread_mutex_t
*pmp
)
169 ret
= pthread_mutex_lock(pmp
);
174 /* Release the specified pthread mutex. */
176 static void call_rcu_unlock(pthread_mutex_t
*pmp
)
180 ret
= pthread_mutex_unlock(pmp
);
185 #if HAVE_SCHED_SETAFFINITY
187 int set_thread_cpu_affinity(struct call_rcu_data
*crdp
)
191 if (crdp
->cpu_affinity
< 0)
195 CPU_SET(crdp
->cpu_affinity
, &mask
);
196 #if SCHED_SETAFFINITY_ARGS == 2
197 return sched_setaffinity(0, &mask
);
199 return sched_setaffinity(0, sizeof(mask
), &mask
);
204 int set_thread_cpu_affinity(struct call_rcu_data
*crdp
)
210 static void call_rcu_wait(struct call_rcu_data
*crdp
)
212 /* Read call_rcu list before read futex */
214 if (uatomic_read(&crdp
->futex
) == -1)
215 futex_async(&crdp
->futex
, FUTEX_WAIT
, -1,
219 static void call_rcu_wake_up(struct call_rcu_data
*crdp
)
221 /* Write to call_rcu list before reading/writing futex */
223 if (caa_unlikely(uatomic_read(&crdp
->futex
) == -1)) {
224 uatomic_set(&crdp
->futex
, 0);
225 futex_async(&crdp
->futex
, FUTEX_WAKE
, 1,
230 /* This is the code run by each call_rcu thread. */
232 static void *call_rcu_thread(void *arg
)
234 unsigned long cbcount
;
235 struct cds_wfq_node
*cbs
;
236 struct cds_wfq_node
**cbs_tail
;
237 struct call_rcu_data
*crdp
= (struct call_rcu_data
*)arg
;
238 struct rcu_head
*rhp
;
239 int rt
= !!(uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_RT
);
242 ret
= set_thread_cpu_affinity(crdp
);
247 * If callbacks take a read-side lock, we need to be registered.
249 rcu_register_thread();
251 URCU_TLS(thread_call_rcu_data
) = crdp
;
253 uatomic_dec(&crdp
->futex
);
254 /* Decrement futex before reading call_rcu list */
258 if (uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_PAUSE
) {
260 * Pause requested. Become quiescent: remove
261 * ourself from all global lists, and don't
262 * process any callback. The callback lists may
263 * still be non-empty though.
265 rcu_unregister_thread();
266 cmm_smp_mb__before_uatomic_or();
267 uatomic_or(&crdp
->flags
, URCU_CALL_RCU_PAUSED
);
268 while ((uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_PAUSE
) != 0)
270 rcu_register_thread();
273 if (&crdp
->cbs
.head
!= _CMM_LOAD_SHARED(crdp
->cbs
.tail
)) {
274 while ((cbs
= _CMM_LOAD_SHARED(crdp
->cbs
.head
)) == NULL
)
276 _CMM_STORE_SHARED(crdp
->cbs
.head
, NULL
);
277 cbs_tail
= (struct cds_wfq_node
**)
278 uatomic_xchg(&crdp
->cbs
.tail
, &crdp
->cbs
.head
);
282 while (cbs
->next
== NULL
&&
283 &cbs
->next
!= cbs_tail
)
285 if (cbs
== &crdp
->cbs
.dummy
) {
289 rhp
= (struct rcu_head
*)cbs
;
293 } while (cbs
!= NULL
);
294 uatomic_sub(&crdp
->qlen
, cbcount
);
296 if (uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_STOP
)
298 rcu_thread_offline();
301 == _CMM_LOAD_SHARED(crdp
->cbs
.tail
)) {
304 uatomic_dec(&crdp
->futex
);
306 * Decrement futex before reading
320 * Read call_rcu list before write futex.
323 uatomic_set(&crdp
->futex
, 0);
325 uatomic_or(&crdp
->flags
, URCU_CALL_RCU_STOPPED
);
326 rcu_unregister_thread();
331 * Create both a call_rcu thread and the corresponding call_rcu_data
332 * structure, linking the structure in as specified. Caller must hold
336 static void call_rcu_data_init(struct call_rcu_data
**crdpp
,
340 struct call_rcu_data
*crdp
;
343 crdp
= malloc(sizeof(*crdp
));
346 memset(crdp
, '\0', sizeof(*crdp
));
347 cds_wfq_init(&crdp
->cbs
);
351 cds_list_add(&crdp
->list
, &call_rcu_data_list
);
352 crdp
->cpu_affinity
= cpu_affinity
;
353 cmm_smp_mb(); /* Structure initialized before pointer is planted. */
355 ret
= pthread_create(&crdp
->tid
, NULL
, call_rcu_thread
, crdp
);
361 * Return a pointer to the call_rcu_data structure for the specified
362 * CPU, returning NULL if there is none. We cannot automatically
363 * created it because the platform we are running on might not define
364 * urcu_sched_getcpu().
366 * The call to this function and use of the returned call_rcu_data
367 * should be protected by RCU read-side lock.
370 struct call_rcu_data
*get_cpu_call_rcu_data(int cpu
)
372 static int warned
= 0;
373 struct call_rcu_data
**pcpu_crdp
;
375 pcpu_crdp
= rcu_dereference(per_cpu_call_rcu_data
);
376 if (pcpu_crdp
== NULL
)
378 if (!warned
&& maxcpus
> 0 && (cpu
< 0 || maxcpus
<= cpu
)) {
379 fprintf(stderr
, "[error] liburcu: get CPU # out of range\n");
382 if (cpu
< 0 || maxcpus
<= cpu
)
384 return rcu_dereference(pcpu_crdp
[cpu
]);
388 * Return the tid corresponding to the call_rcu thread whose
389 * call_rcu_data structure is specified.
392 pthread_t
get_call_rcu_thread(struct call_rcu_data
*crdp
)
398 * Create a call_rcu_data structure (with thread) and return a pointer.
401 static struct call_rcu_data
*__create_call_rcu_data(unsigned long flags
,
404 struct call_rcu_data
*crdp
;
406 call_rcu_data_init(&crdp
, flags
, cpu_affinity
);
410 struct call_rcu_data
*create_call_rcu_data(unsigned long flags
,
413 struct call_rcu_data
*crdp
;
415 call_rcu_lock(&call_rcu_mutex
);
416 crdp
= __create_call_rcu_data(flags
, cpu_affinity
);
417 call_rcu_unlock(&call_rcu_mutex
);
422 * Set the specified CPU to use the specified call_rcu_data structure.
424 * Use NULL to remove a CPU's call_rcu_data structure, but it is
425 * the caller's responsibility to dispose of the removed structure.
426 * Use get_cpu_call_rcu_data() to obtain a pointer to the old structure
427 * (prior to NULLing it out, of course).
429 * The caller must wait for a grace-period to pass between return from
430 * set_cpu_call_rcu_data() and call to call_rcu_data_free() passing the
431 * previous call rcu data as argument.
434 int set_cpu_call_rcu_data(int cpu
, struct call_rcu_data
*crdp
)
436 static int warned
= 0;
438 call_rcu_lock(&call_rcu_mutex
);
439 alloc_cpu_call_rcu_data();
440 if (cpu
< 0 || maxcpus
<= cpu
) {
442 fprintf(stderr
, "[error] liburcu: set CPU # out of range\n");
445 call_rcu_unlock(&call_rcu_mutex
);
450 if (per_cpu_call_rcu_data
== NULL
) {
451 call_rcu_unlock(&call_rcu_mutex
);
456 if (per_cpu_call_rcu_data
[cpu
] != NULL
&& crdp
!= NULL
) {
457 call_rcu_unlock(&call_rcu_mutex
);
462 rcu_set_pointer(&per_cpu_call_rcu_data
[cpu
], crdp
);
463 call_rcu_unlock(&call_rcu_mutex
);
468 * Return a pointer to the default call_rcu_data structure, creating
469 * one if need be. Because we never free call_rcu_data structures,
470 * we don't need to be in an RCU read-side critical section.
473 struct call_rcu_data
*get_default_call_rcu_data(void)
475 if (default_call_rcu_data
!= NULL
)
476 return rcu_dereference(default_call_rcu_data
);
477 call_rcu_lock(&call_rcu_mutex
);
478 if (default_call_rcu_data
!= NULL
) {
479 call_rcu_unlock(&call_rcu_mutex
);
480 return default_call_rcu_data
;
482 call_rcu_data_init(&default_call_rcu_data
, 0, -1);
483 call_rcu_unlock(&call_rcu_mutex
);
484 return default_call_rcu_data
;
488 * Return the call_rcu_data structure that applies to the currently
489 * running thread. Any call_rcu_data structure assigned specifically
490 * to this thread has first priority, followed by any call_rcu_data
491 * structure assigned to the CPU on which the thread is running,
492 * followed by the default call_rcu_data structure. If there is not
493 * yet a default call_rcu_data structure, one will be created.
495 * Calls to this function and use of the returned call_rcu_data should
496 * be protected by RCU read-side lock.
498 struct call_rcu_data
*get_call_rcu_data(void)
500 struct call_rcu_data
*crd
;
502 if (URCU_TLS(thread_call_rcu_data
) != NULL
)
503 return URCU_TLS(thread_call_rcu_data
);
506 crd
= get_cpu_call_rcu_data(urcu_sched_getcpu());
511 return get_default_call_rcu_data();
515 * Return a pointer to this task's call_rcu_data if there is one.
518 struct call_rcu_data
*get_thread_call_rcu_data(void)
520 return URCU_TLS(thread_call_rcu_data
);
524 * Set this task's call_rcu_data structure as specified, regardless
525 * of whether or not this task already had one. (This allows switching
526 * to and from real-time call_rcu threads, for example.)
528 * Use NULL to remove a thread's call_rcu_data structure, but it is
529 * the caller's responsibility to dispose of the removed structure.
530 * Use get_thread_call_rcu_data() to obtain a pointer to the old structure
531 * (prior to NULLing it out, of course).
534 void set_thread_call_rcu_data(struct call_rcu_data
*crdp
)
536 URCU_TLS(thread_call_rcu_data
) = crdp
;
540 * Create a separate call_rcu thread for each CPU. This does not
541 * replace a pre-existing call_rcu thread -- use the set_cpu_call_rcu_data()
542 * function if you want that behavior. Should be paired with
543 * free_all_cpu_call_rcu_data() to teardown these call_rcu worker
547 int create_all_cpu_call_rcu_data(unsigned long flags
)
550 struct call_rcu_data
*crdp
;
553 call_rcu_lock(&call_rcu_mutex
);
554 alloc_cpu_call_rcu_data();
555 call_rcu_unlock(&call_rcu_mutex
);
560 if (per_cpu_call_rcu_data
== NULL
) {
564 for (i
= 0; i
< maxcpus
; i
++) {
565 call_rcu_lock(&call_rcu_mutex
);
566 if (get_cpu_call_rcu_data(i
)) {
567 call_rcu_unlock(&call_rcu_mutex
);
570 crdp
= __create_call_rcu_data(flags
, i
);
572 call_rcu_unlock(&call_rcu_mutex
);
576 call_rcu_unlock(&call_rcu_mutex
);
577 if ((ret
= set_cpu_call_rcu_data(i
, crdp
)) != 0) {
578 call_rcu_data_free(crdp
);
580 /* it has been created by other thread */
591 * Wake up the call_rcu thread corresponding to the specified
592 * call_rcu_data structure.
594 static void wake_call_rcu_thread(struct call_rcu_data
*crdp
)
596 if (!(_CMM_LOAD_SHARED(crdp
->flags
) & URCU_CALL_RCU_RT
))
597 call_rcu_wake_up(crdp
);
601 * Schedule a function to be invoked after a following grace period.
602 * This is the only function that must be called -- the others are
603 * only present to allow applications to tune their use of RCU for
604 * maximum performance.
606 * Note that unless a call_rcu thread has not already been created,
607 * the first invocation of call_rcu() will create one. So, if you
608 * need the first invocation of call_rcu() to be fast, make sure
609 * to create a call_rcu thread first. One way to accomplish this is
610 * "get_call_rcu_data();", and another is create_all_cpu_call_rcu_data().
612 * call_rcu must be called by registered RCU read-side threads.
615 void call_rcu(struct rcu_head
*head
,
616 void (*func
)(struct rcu_head
*head
))
618 struct call_rcu_data
*crdp
;
620 cds_wfq_node_init(&head
->next
);
622 /* Holding rcu read-side lock across use of per-cpu crdp */
624 crdp
= get_call_rcu_data();
625 cds_wfq_enqueue(&crdp
->cbs
, &head
->next
);
626 uatomic_inc(&crdp
->qlen
);
627 wake_call_rcu_thread(crdp
);
632 * Free up the specified call_rcu_data structure, terminating the
633 * associated call_rcu thread. The caller must have previously
634 * removed the call_rcu_data structure from per-thread or per-CPU
635 * usage. For example, set_cpu_call_rcu_data(cpu, NULL) for per-CPU
636 * call_rcu_data structures or set_thread_call_rcu_data(NULL) for
637 * per-thread call_rcu_data structures.
639 * We silently refuse to free up the default call_rcu_data structure
640 * because that is where we put any leftover callbacks. Note that
641 * the possibility of self-spawning callbacks makes it impossible
642 * to execute all the callbacks in finite time without putting any
643 * newly spawned callbacks somewhere else. The "somewhere else" of
644 * last resort is the default call_rcu_data structure.
646 * We also silently refuse to free NULL pointers. This simplifies
649 * The caller must wait for a grace-period to pass between return from
650 * set_cpu_call_rcu_data() and call to call_rcu_data_free() passing the
651 * previous call rcu data as argument.
653 void call_rcu_data_free(struct call_rcu_data
*crdp
)
655 struct cds_wfq_node
*cbs
;
656 struct cds_wfq_node
**cbs_tail
;
657 struct cds_wfq_node
**cbs_endprev
;
659 if (crdp
== NULL
|| crdp
== default_call_rcu_data
) {
662 if ((uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_STOPPED
) == 0) {
663 uatomic_or(&crdp
->flags
, URCU_CALL_RCU_STOP
);
664 wake_call_rcu_thread(crdp
);
665 while ((uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_STOPPED
) == 0)
668 if (&crdp
->cbs
.head
!= _CMM_LOAD_SHARED(crdp
->cbs
.tail
)) {
669 while ((cbs
= _CMM_LOAD_SHARED(crdp
->cbs
.head
)) == NULL
)
671 _CMM_STORE_SHARED(crdp
->cbs
.head
, NULL
);
672 cbs_tail
= (struct cds_wfq_node
**)
673 uatomic_xchg(&crdp
->cbs
.tail
, &crdp
->cbs
.head
);
674 /* Create default call rcu data if need be */
675 (void) get_default_call_rcu_data();
676 cbs_endprev
= (struct cds_wfq_node
**)
677 uatomic_xchg(&default_call_rcu_data
->cbs
.tail
,
679 _CMM_STORE_SHARED(*cbs_endprev
, cbs
);
680 uatomic_add(&default_call_rcu_data
->qlen
,
681 uatomic_read(&crdp
->qlen
));
682 wake_call_rcu_thread(default_call_rcu_data
);
685 call_rcu_lock(&call_rcu_mutex
);
686 cds_list_del(&crdp
->list
);
687 call_rcu_unlock(&call_rcu_mutex
);
693 * Clean up all the per-CPU call_rcu threads.
695 void free_all_cpu_call_rcu_data(void)
698 struct call_rcu_data
**crdp
;
699 static int warned
= 0;
704 crdp
= malloc(sizeof(*crdp
) * maxcpus
);
707 fprintf(stderr
, "[error] liburcu: unable to allocate per-CPU pointer array\n");
713 for (cpu
= 0; cpu
< maxcpus
; cpu
++) {
714 crdp
[cpu
] = get_cpu_call_rcu_data(cpu
);
715 if (crdp
[cpu
] == NULL
)
717 set_cpu_call_rcu_data(cpu
, NULL
);
720 * Wait for call_rcu sites acting as RCU readers of the
721 * call_rcu_data to become quiescent.
724 for (cpu
= 0; cpu
< maxcpus
; cpu
++) {
725 if (crdp
[cpu
] == NULL
)
727 call_rcu_data_free(crdp
[cpu
]);
733 * Acquire the call_rcu_mutex in order to ensure that the child sees
734 * all of the call_rcu() data structures in a consistent state. Ensure
735 * that all call_rcu threads are in a quiescent state across fork.
736 * Suitable for pthread_atfork() and friends.
738 void call_rcu_before_fork(void)
740 struct call_rcu_data
*crdp
;
742 call_rcu_lock(&call_rcu_mutex
);
744 cds_list_for_each_entry(crdp
, &call_rcu_data_list
, list
) {
745 uatomic_or(&crdp
->flags
, URCU_CALL_RCU_PAUSE
);
746 cmm_smp_mb__after_uatomic_or();
747 wake_call_rcu_thread(crdp
);
749 cds_list_for_each_entry(crdp
, &call_rcu_data_list
, list
) {
750 while ((uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_PAUSED
) == 0)
756 * Clean up call_rcu data structures in the parent of a successful fork()
757 * that is not followed by exec() in the child. Suitable for
758 * pthread_atfork() and friends.
760 void call_rcu_after_fork_parent(void)
762 struct call_rcu_data
*crdp
;
764 cds_list_for_each_entry(crdp
, &call_rcu_data_list
, list
)
765 uatomic_and(&crdp
->flags
, ~URCU_CALL_RCU_PAUSE
);
766 call_rcu_unlock(&call_rcu_mutex
);
770 * Clean up call_rcu data structures in the child of a successful fork()
771 * that is not followed by exec(). Suitable for pthread_atfork() and
774 void call_rcu_after_fork_child(void)
776 struct call_rcu_data
*crdp
, *next
;
778 /* Release the mutex. */
779 call_rcu_unlock(&call_rcu_mutex
);
781 /* Do nothing when call_rcu() has not been used */
782 if (cds_list_empty(&call_rcu_data_list
))
786 * Allocate a new default call_rcu_data structure in order
787 * to get a working call_rcu thread to go with it.
789 default_call_rcu_data
= NULL
;
790 (void)get_default_call_rcu_data();
792 /* Cleanup call_rcu_data pointers before use */
794 free(per_cpu_call_rcu_data
);
795 rcu_set_pointer(&per_cpu_call_rcu_data
, NULL
);
796 URCU_TLS(thread_call_rcu_data
) = NULL
;
799 * Dispose of all of the rest of the call_rcu_data structures.
800 * Leftover call_rcu callbacks will be merged into the new
801 * default call_rcu thread queue.
803 cds_list_for_each_entry_safe(crdp
, next
, &call_rcu_data_list
, list
) {
804 if (crdp
== default_call_rcu_data
)
806 uatomic_set(&crdp
->flags
, URCU_CALL_RCU_STOPPED
);
807 call_rcu_data_free(crdp
);