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
36 #include "compat-getcpu.h"
37 #include <urcu/assert.h>
38 #include <urcu/wfcqueue.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 #include "urcu-utils.h"
47 #include "compat-smp.h"
49 #define SET_AFFINITY_CHECK_PERIOD (1U << 8) /* 256 */
50 #define SET_AFFINITY_CHECK_PERIOD_MASK (SET_AFFINITY_CHECK_PERIOD - 1)
52 /* Data structure that identifies a call_rcu thread. */
54 struct call_rcu_data
{
56 * We do not align head on a different cache-line than tail
57 * mainly because call_rcu callback-invocation threads use
58 * batching ("splice") to get an entire list of callbacks, which
59 * effectively empties the queue, and requires to touch the tail
62 struct cds_wfcq_tail cbs_tail
;
63 struct cds_wfcq_head cbs_head
;
66 unsigned long qlen
; /* maintained for debugging. */
69 unsigned long gp_count
;
70 struct cds_list_head list
;
71 } __attribute__((aligned(CAA_CACHE_LINE_SIZE
)));
73 struct call_rcu_completion
{
79 struct call_rcu_completion_work
{
81 struct call_rcu_completion
*completion
;
85 * List of all call_rcu_data structures to keep valgrind happy.
86 * Protected by call_rcu_mutex.
89 static CDS_LIST_HEAD(call_rcu_data_list
);
91 /* Link a thread using call_rcu() to its call_rcu thread. */
93 static DEFINE_URCU_TLS(struct call_rcu_data
*, thread_call_rcu_data
);
96 * Guard call_rcu thread creation and atfork handlers.
98 static pthread_mutex_t call_rcu_mutex
= PTHREAD_MUTEX_INITIALIZER
;
100 /* If a given thread does not have its own call_rcu thread, this is default. */
102 static struct call_rcu_data
*default_call_rcu_data
;
104 static struct urcu_atfork
*registered_rculfhash_atfork
;
107 * If the sched_getcpu() and sysconf(_SC_NPROCESSORS_CONF) calls are
108 * available, then we can have call_rcu threads assigned to individual
109 * CPUs rather than only to specific threads.
112 #if defined(HAVE_SYSCONF) && (defined(HAVE_SCHED_GETCPU) || defined(HAVE_GETCPUID))
115 * Pointer to array of pointers to per-CPU call_rcu_data structures
116 * and # CPUs. per_cpu_call_rcu_data is a RCU-protected pointer to an
117 * array of RCU-protected pointers to call_rcu_data. call_rcu acts as a
118 * RCU read-side and reads per_cpu_call_rcu_data and the per-cpu pointer
119 * without mutex. The call_rcu_mutex protects updates.
122 static struct call_rcu_data
**per_cpu_call_rcu_data
;
123 static long cpus_array_len
;
125 static void cpus_array_len_reset(void)
130 /* Allocate the array if it has not already been allocated. */
132 static void alloc_cpu_call_rcu_data(void)
134 struct call_rcu_data
**p
;
135 static int warned
= 0;
137 if (cpus_array_len
!= 0)
139 cpus_array_len
= get_possible_cpus_array_len();
140 if (cpus_array_len
<= 0) {
143 p
= malloc(cpus_array_len
* sizeof(*per_cpu_call_rcu_data
));
145 memset(p
, '\0', cpus_array_len
* sizeof(*per_cpu_call_rcu_data
));
146 rcu_set_pointer(&per_cpu_call_rcu_data
, p
);
149 fprintf(stderr
, "[error] liburcu: unable to allocate per-CPU pointer array\n");
155 #else /* #if defined(HAVE_SYSCONF) && defined(HAVE_SCHED_GETCPU) */
158 * per_cpu_call_rcu_data should be constant, but some functions below, used both
159 * for cases where cpu number is available and not available, assume it it not
162 static struct call_rcu_data
**per_cpu_call_rcu_data
= NULL
;
163 static const long cpus_array_len
= -1;
165 static void cpus_array_len_reset(void)
169 static void alloc_cpu_call_rcu_data(void)
173 #endif /* #else #if defined(HAVE_SYSCONF) && defined(HAVE_SCHED_GETCPU) */
175 /* Acquire the specified pthread mutex. */
177 static void call_rcu_lock(pthread_mutex_t
*pmp
)
181 ret
= pthread_mutex_lock(pmp
);
186 /* Release the specified pthread mutex. */
188 static void call_rcu_unlock(pthread_mutex_t
*pmp
)
192 ret
= pthread_mutex_unlock(pmp
);
198 * Periodically retry setting CPU affinity if we migrate.
199 * Losing affinity can be caused by CPU hotunplug/hotplug, or by
202 #ifdef HAVE_SCHED_SETAFFINITY
204 int set_thread_cpu_affinity(struct call_rcu_data
*crdp
)
209 if (crdp
->cpu_affinity
< 0)
211 if (++crdp
->gp_count
& SET_AFFINITY_CHECK_PERIOD_MASK
)
213 if (urcu_sched_getcpu() == crdp
->cpu_affinity
)
217 CPU_SET(crdp
->cpu_affinity
, &mask
);
218 ret
= sched_setaffinity(0, sizeof(mask
), &mask
);
221 * EINVAL is fine: can be caused by hotunplugged CPUs, or by
222 * cpuset(7). This is why we should always retry if we detect
225 if (ret
&& errno
== EINVAL
) {
233 int set_thread_cpu_affinity(struct call_rcu_data
*crdp
__attribute__((unused
)))
239 static void call_rcu_wait(struct call_rcu_data
*crdp
)
241 /* Read call_rcu list before read futex */
243 while (uatomic_read(&crdp
->futex
) == -1) {
244 if (!futex_async(&crdp
->futex
, FUTEX_WAIT
, -1, NULL
, NULL
, 0)) {
246 * Prior queued wakeups queued by unrelated code
247 * using the same address can cause futex wait to
248 * return 0 even through the futex value is still
249 * -1 (spurious wakeups). Check the value again
250 * in user-space to validate whether it really
257 /* Value already changed. */
260 /* Retry if interrupted by signal. */
261 break; /* Get out of switch. Check again. */
263 /* Unexpected error. */
269 static void call_rcu_wake_up(struct call_rcu_data
*crdp
)
271 /* Write to call_rcu list before reading/writing futex */
273 if (caa_unlikely(uatomic_read(&crdp
->futex
) == -1)) {
274 uatomic_set(&crdp
->futex
, 0);
275 if (futex_async(&crdp
->futex
, FUTEX_WAKE
, 1,
281 static void call_rcu_completion_wait(struct call_rcu_completion
*completion
)
283 /* Read completion barrier count before read futex */
285 while (uatomic_read(&completion
->futex
) == -1) {
286 if (!futex_async(&completion
->futex
, FUTEX_WAIT
, -1, NULL
, NULL
, 0)) {
288 * Prior queued wakeups queued by unrelated code
289 * using the same address can cause futex wait to
290 * return 0 even through the futex value is still
291 * -1 (spurious wakeups). Check the value again
292 * in user-space to validate whether it really
299 /* Value already changed. */
302 /* Retry if interrupted by signal. */
303 break; /* Get out of switch. Check again. */
305 /* Unexpected error. */
311 static void call_rcu_completion_wake_up(struct call_rcu_completion
*completion
)
313 /* Write to completion barrier count before reading/writing futex */
315 if (caa_unlikely(uatomic_read(&completion
->futex
) == -1)) {
316 uatomic_set(&completion
->futex
, 0);
317 if (futex_async(&completion
->futex
, FUTEX_WAKE
, 1,
323 /* This is the code run by each call_rcu thread. */
325 static void *call_rcu_thread(void *arg
)
327 unsigned long cbcount
;
328 struct call_rcu_data
*crdp
= (struct call_rcu_data
*) arg
;
329 int rt
= !!(uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_RT
);
331 if (set_thread_cpu_affinity(crdp
))
335 * If callbacks take a read-side lock, we need to be registered.
337 rcu_register_thread();
339 URCU_TLS(thread_call_rcu_data
) = crdp
;
341 uatomic_dec(&crdp
->futex
);
342 /* Decrement futex before reading call_rcu list */
346 struct cds_wfcq_head cbs_tmp_head
;
347 struct cds_wfcq_tail cbs_tmp_tail
;
348 struct cds_wfcq_node
*cbs
, *cbs_tmp_n
;
349 enum cds_wfcq_ret splice_ret
;
351 if (set_thread_cpu_affinity(crdp
))
354 if (uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_PAUSE
) {
356 * Pause requested. Become quiescent: remove
357 * ourself from all global lists, and don't
358 * process any callback. The callback lists may
359 * still be non-empty though.
361 rcu_unregister_thread();
362 cmm_smp_mb__before_uatomic_or();
363 uatomic_or(&crdp
->flags
, URCU_CALL_RCU_PAUSED
);
364 while ((uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_PAUSE
) != 0)
365 (void) poll(NULL
, 0, 1);
366 uatomic_and(&crdp
->flags
, ~URCU_CALL_RCU_PAUSED
);
367 cmm_smp_mb__after_uatomic_and();
368 rcu_register_thread();
371 cds_wfcq_init(&cbs_tmp_head
, &cbs_tmp_tail
);
372 splice_ret
= __cds_wfcq_splice_blocking(&cbs_tmp_head
,
373 &cbs_tmp_tail
, &crdp
->cbs_head
, &crdp
->cbs_tail
);
374 urcu_posix_assert(splice_ret
!= CDS_WFCQ_RET_WOULDBLOCK
);
375 urcu_posix_assert(splice_ret
!= CDS_WFCQ_RET_DEST_NON_EMPTY
);
376 if (splice_ret
!= CDS_WFCQ_RET_SRC_EMPTY
) {
379 __cds_wfcq_for_each_blocking_safe(&cbs_tmp_head
,
380 &cbs_tmp_tail
, cbs
, cbs_tmp_n
) {
381 struct rcu_head
*rhp
;
383 rhp
= caa_container_of(cbs
,
384 struct rcu_head
, next
);
388 uatomic_sub(&crdp
->qlen
, cbcount
);
390 if (uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_STOP
)
392 rcu_thread_offline();
394 if (cds_wfcq_empty(&crdp
->cbs_head
,
397 (void) poll(NULL
, 0, 10);
398 uatomic_dec(&crdp
->futex
);
400 * Decrement futex before reading
405 (void) poll(NULL
, 0, 10);
408 (void) poll(NULL
, 0, 10);
414 * Read call_rcu list before write futex.
417 uatomic_set(&crdp
->futex
, 0);
419 uatomic_or(&crdp
->flags
, URCU_CALL_RCU_STOPPED
);
420 rcu_unregister_thread();
425 * Create both a call_rcu thread and the corresponding call_rcu_data
426 * structure, linking the structure in as specified. Caller must hold
430 static void call_rcu_data_init(struct call_rcu_data
**crdpp
,
434 struct call_rcu_data
*crdp
;
436 sigset_t newmask
, oldmask
;
438 crdp
= malloc(sizeof(*crdp
));
441 memset(crdp
, '\0', sizeof(*crdp
));
442 cds_wfcq_init(&crdp
->cbs_head
, &crdp
->cbs_tail
);
446 cds_list_add(&crdp
->list
, &call_rcu_data_list
);
447 crdp
->cpu_affinity
= cpu_affinity
;
449 cmm_smp_mb(); /* Structure initialized before pointer is planted. */
452 ret
= sigfillset(&newmask
);
453 urcu_posix_assert(!ret
);
454 ret
= pthread_sigmask(SIG_BLOCK
, &newmask
, &oldmask
);
455 urcu_posix_assert(!ret
);
457 ret
= pthread_create(&crdp
->tid
, NULL
, call_rcu_thread
, crdp
);
461 ret
= pthread_sigmask(SIG_SETMASK
, &oldmask
, NULL
);
462 urcu_posix_assert(!ret
);
466 * Return a pointer to the call_rcu_data structure for the specified
467 * CPU, returning NULL if there is none. We cannot automatically
468 * created it because the platform we are running on might not define
469 * urcu_sched_getcpu().
471 * The call to this function and use of the returned call_rcu_data
472 * should be protected by RCU read-side lock.
475 struct call_rcu_data
*get_cpu_call_rcu_data(int cpu
)
477 static int warned
= 0;
478 struct call_rcu_data
**pcpu_crdp
;
480 pcpu_crdp
= rcu_dereference(per_cpu_call_rcu_data
);
481 if (pcpu_crdp
== NULL
)
483 if (!warned
&& cpus_array_len
> 0 && (cpu
< 0 || cpus_array_len
<= cpu
)) {
484 fprintf(stderr
, "[error] liburcu: get CPU # out of range\n");
487 if (cpu
< 0 || cpus_array_len
<= cpu
)
489 return rcu_dereference(pcpu_crdp
[cpu
]);
493 * Return the tid corresponding to the call_rcu thread whose
494 * call_rcu_data structure is specified.
497 pthread_t
get_call_rcu_thread(struct call_rcu_data
*crdp
)
503 * Create a call_rcu_data structure (with thread) and return a pointer.
506 static struct call_rcu_data
*__create_call_rcu_data(unsigned long flags
,
509 struct call_rcu_data
*crdp
;
511 call_rcu_data_init(&crdp
, flags
, cpu_affinity
);
515 struct call_rcu_data
*create_call_rcu_data(unsigned long flags
,
518 struct call_rcu_data
*crdp
;
520 call_rcu_lock(&call_rcu_mutex
);
521 crdp
= __create_call_rcu_data(flags
, cpu_affinity
);
522 call_rcu_unlock(&call_rcu_mutex
);
527 * Set the specified CPU to use the specified call_rcu_data structure.
529 * Use NULL to remove a CPU's call_rcu_data structure, but it is
530 * the caller's responsibility to dispose of the removed structure.
531 * Use get_cpu_call_rcu_data() to obtain a pointer to the old structure
532 * (prior to NULLing it out, of course).
534 * The caller must wait for a grace-period to pass between return from
535 * set_cpu_call_rcu_data() and call to call_rcu_data_free() passing the
536 * previous call rcu data as argument.
539 int set_cpu_call_rcu_data(int cpu
, struct call_rcu_data
*crdp
)
541 static int warned
= 0;
543 call_rcu_lock(&call_rcu_mutex
);
544 alloc_cpu_call_rcu_data();
545 if (cpu
< 0 || cpus_array_len
<= cpu
) {
547 fprintf(stderr
, "[error] liburcu: set CPU # out of range\n");
550 call_rcu_unlock(&call_rcu_mutex
);
555 if (per_cpu_call_rcu_data
== NULL
) {
556 call_rcu_unlock(&call_rcu_mutex
);
561 if (per_cpu_call_rcu_data
[cpu
] != NULL
&& crdp
!= NULL
) {
562 call_rcu_unlock(&call_rcu_mutex
);
567 rcu_set_pointer(&per_cpu_call_rcu_data
[cpu
], crdp
);
568 call_rcu_unlock(&call_rcu_mutex
);
573 * Return a pointer to the default call_rcu_data structure, creating
574 * one if need be. Because we never free call_rcu_data structures,
575 * we don't need to be in an RCU read-side critical section.
578 struct call_rcu_data
*get_default_call_rcu_data(void)
580 if (default_call_rcu_data
!= NULL
)
581 return rcu_dereference(default_call_rcu_data
);
582 call_rcu_lock(&call_rcu_mutex
);
583 if (default_call_rcu_data
!= NULL
) {
584 call_rcu_unlock(&call_rcu_mutex
);
585 return default_call_rcu_data
;
587 call_rcu_data_init(&default_call_rcu_data
, 0, -1);
588 call_rcu_unlock(&call_rcu_mutex
);
589 return default_call_rcu_data
;
593 * Return the call_rcu_data structure that applies to the currently
594 * running thread. Any call_rcu_data structure assigned specifically
595 * to this thread has first priority, followed by any call_rcu_data
596 * structure assigned to the CPU on which the thread is running,
597 * followed by the default call_rcu_data structure. If there is not
598 * yet a default call_rcu_data structure, one will be created.
600 * Calls to this function and use of the returned call_rcu_data should
601 * be protected by RCU read-side lock.
603 struct call_rcu_data
*get_call_rcu_data(void)
605 struct call_rcu_data
*crd
;
607 if (URCU_TLS(thread_call_rcu_data
) != NULL
)
608 return URCU_TLS(thread_call_rcu_data
);
610 if (cpus_array_len
> 0) {
611 crd
= get_cpu_call_rcu_data(urcu_sched_getcpu());
616 return get_default_call_rcu_data();
620 * Return a pointer to this task's call_rcu_data if there is one.
623 struct call_rcu_data
*get_thread_call_rcu_data(void)
625 return URCU_TLS(thread_call_rcu_data
);
629 * Set this task's call_rcu_data structure as specified, regardless
630 * of whether or not this task already had one. (This allows switching
631 * to and from real-time call_rcu threads, for example.)
633 * Use NULL to remove a thread's call_rcu_data structure, but it is
634 * the caller's responsibility to dispose of the removed structure.
635 * Use get_thread_call_rcu_data() to obtain a pointer to the old structure
636 * (prior to NULLing it out, of course).
639 void set_thread_call_rcu_data(struct call_rcu_data
*crdp
)
641 URCU_TLS(thread_call_rcu_data
) = crdp
;
645 * Create a separate call_rcu thread for each CPU. This does not
646 * replace a pre-existing call_rcu thread -- use the set_cpu_call_rcu_data()
647 * function if you want that behavior. Should be paired with
648 * free_all_cpu_call_rcu_data() to teardown these call_rcu worker
652 int create_all_cpu_call_rcu_data(unsigned long flags
)
655 struct call_rcu_data
*crdp
;
658 call_rcu_lock(&call_rcu_mutex
);
659 alloc_cpu_call_rcu_data();
660 call_rcu_unlock(&call_rcu_mutex
);
661 if (cpus_array_len
<= 0) {
665 if (per_cpu_call_rcu_data
== NULL
) {
669 for (i
= 0; i
< cpus_array_len
; i
++) {
670 call_rcu_lock(&call_rcu_mutex
);
671 if (get_cpu_call_rcu_data(i
)) {
672 call_rcu_unlock(&call_rcu_mutex
);
675 crdp
= __create_call_rcu_data(flags
, i
);
677 call_rcu_unlock(&call_rcu_mutex
);
681 call_rcu_unlock(&call_rcu_mutex
);
682 if ((ret
= set_cpu_call_rcu_data(i
, crdp
)) != 0) {
683 call_rcu_data_free(crdp
);
685 /* it has been created by other thread */
696 * Wake up the call_rcu thread corresponding to the specified
697 * call_rcu_data structure.
699 static void wake_call_rcu_thread(struct call_rcu_data
*crdp
)
701 if (!(_CMM_LOAD_SHARED(crdp
->flags
) & URCU_CALL_RCU_RT
))
702 call_rcu_wake_up(crdp
);
705 static void _call_rcu(struct rcu_head
*head
,
706 void (*func
)(struct rcu_head
*head
),
707 struct call_rcu_data
*crdp
)
709 cds_wfcq_node_init(&head
->next
);
711 cds_wfcq_enqueue(&crdp
->cbs_head
, &crdp
->cbs_tail
, &head
->next
);
712 uatomic_inc(&crdp
->qlen
);
713 wake_call_rcu_thread(crdp
);
717 * Schedule a function to be invoked after a following grace period.
718 * This is the only function that must be called -- the others are
719 * only present to allow applications to tune their use of RCU for
720 * maximum performance.
722 * Note that unless a call_rcu thread has not already been created,
723 * the first invocation of call_rcu() will create one. So, if you
724 * need the first invocation of call_rcu() to be fast, make sure
725 * to create a call_rcu thread first. One way to accomplish this is
726 * "get_call_rcu_data();", and another is create_all_cpu_call_rcu_data().
728 * call_rcu must be called by registered RCU read-side threads.
730 void call_rcu(struct rcu_head
*head
,
731 void (*func
)(struct rcu_head
*head
))
733 struct call_rcu_data
*crdp
;
735 /* Holding rcu read-side lock across use of per-cpu crdp */
737 crdp
= get_call_rcu_data();
738 _call_rcu(head
, func
, crdp
);
743 * Free up the specified call_rcu_data structure, terminating the
744 * associated call_rcu thread. The caller must have previously
745 * removed the call_rcu_data structure from per-thread or per-CPU
746 * usage. For example, set_cpu_call_rcu_data(cpu, NULL) for per-CPU
747 * call_rcu_data structures or set_thread_call_rcu_data(NULL) for
748 * per-thread call_rcu_data structures.
750 * We silently refuse to free up the default call_rcu_data structure
751 * because that is where we put any leftover callbacks. Note that
752 * the possibility of self-spawning callbacks makes it impossible
753 * to execute all the callbacks in finite time without putting any
754 * newly spawned callbacks somewhere else. The "somewhere else" of
755 * last resort is the default call_rcu_data structure.
757 * We also silently refuse to free NULL pointers. This simplifies
760 * The caller must wait for a grace-period to pass between return from
761 * set_cpu_call_rcu_data() and call to call_rcu_data_free() passing the
762 * previous call rcu data as argument.
764 * Note: introducing __cds_wfcq_splice_blocking() in this function fixed
765 * a list corruption bug in the 0.7.x series. The equivalent fix
766 * appeared in 0.6.8 for the stable-0.6 branch.
768 void call_rcu_data_free(struct call_rcu_data
*crdp
)
770 if (crdp
== NULL
|| crdp
== default_call_rcu_data
) {
773 if ((uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_STOPPED
) == 0) {
774 uatomic_or(&crdp
->flags
, URCU_CALL_RCU_STOP
);
775 wake_call_rcu_thread(crdp
);
776 while ((uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_STOPPED
) == 0)
777 (void) poll(NULL
, 0, 1);
779 call_rcu_lock(&call_rcu_mutex
);
780 if (!cds_wfcq_empty(&crdp
->cbs_head
, &crdp
->cbs_tail
)) {
781 call_rcu_unlock(&call_rcu_mutex
);
782 /* Create default call rcu data if need be. */
783 /* CBs queued here will be handed to the default list. */
784 (void) get_default_call_rcu_data();
785 call_rcu_lock(&call_rcu_mutex
);
786 __cds_wfcq_splice_blocking(&default_call_rcu_data
->cbs_head
,
787 &default_call_rcu_data
->cbs_tail
,
788 &crdp
->cbs_head
, &crdp
->cbs_tail
);
789 uatomic_add(&default_call_rcu_data
->qlen
,
790 uatomic_read(&crdp
->qlen
));
791 wake_call_rcu_thread(default_call_rcu_data
);
794 cds_list_del(&crdp
->list
);
795 call_rcu_unlock(&call_rcu_mutex
);
801 * Clean up all the per-CPU call_rcu threads.
803 void free_all_cpu_call_rcu_data(void)
806 struct call_rcu_data
**crdp
;
807 static int warned
= 0;
809 if (cpus_array_len
<= 0)
812 crdp
= malloc(sizeof(*crdp
) * cpus_array_len
);
815 fprintf(stderr
, "[error] liburcu: unable to allocate per-CPU pointer array\n");
821 for (cpu
= 0; cpu
< cpus_array_len
; cpu
++) {
822 crdp
[cpu
] = get_cpu_call_rcu_data(cpu
);
823 if (crdp
[cpu
] == NULL
)
825 set_cpu_call_rcu_data(cpu
, NULL
);
828 * Wait for call_rcu sites acting as RCU readers of the
829 * call_rcu_data to become quiescent.
832 for (cpu
= 0; cpu
< cpus_array_len
; cpu
++) {
833 if (crdp
[cpu
] == NULL
)
835 call_rcu_data_free(crdp
[cpu
]);
841 void free_completion(struct urcu_ref
*ref
)
843 struct call_rcu_completion
*completion
;
845 completion
= caa_container_of(ref
, struct call_rcu_completion
, ref
);
850 void _rcu_barrier_complete(struct rcu_head
*head
)
852 struct call_rcu_completion_work
*work
;
853 struct call_rcu_completion
*completion
;
855 work
= caa_container_of(head
, struct call_rcu_completion_work
, head
);
856 completion
= work
->completion
;
857 if (!uatomic_sub_return(&completion
->barrier_count
, 1))
858 call_rcu_completion_wake_up(completion
);
859 urcu_ref_put(&completion
->ref
, free_completion
);
864 * Wait for all in-flight call_rcu callbacks to complete execution.
866 void rcu_barrier(void)
868 struct call_rcu_data
*crdp
;
869 struct call_rcu_completion
*completion
;
873 /* Put in offline state in QSBR. */
874 was_online
= _rcu_read_ongoing();
876 rcu_thread_offline();
878 * Calling a rcu_barrier() within a RCU read-side critical
879 * section is an error.
881 if (_rcu_read_ongoing()) {
882 static int warned
= 0;
885 fprintf(stderr
, "[error] liburcu: rcu_barrier() called from within RCU read-side critical section.\n");
891 completion
= calloc(sizeof(*completion
), 1);
895 call_rcu_lock(&call_rcu_mutex
);
896 cds_list_for_each_entry(crdp
, &call_rcu_data_list
, list
)
899 /* Referenced by rcu_barrier() and each call_rcu thread. */
900 urcu_ref_set(&completion
->ref
, count
+ 1);
901 completion
->barrier_count
= count
;
903 cds_list_for_each_entry(crdp
, &call_rcu_data_list
, list
) {
904 struct call_rcu_completion_work
*work
;
906 work
= calloc(sizeof(*work
), 1);
909 work
->completion
= completion
;
910 _call_rcu(&work
->head
, _rcu_barrier_complete
, crdp
);
912 call_rcu_unlock(&call_rcu_mutex
);
916 uatomic_dec(&completion
->futex
);
917 /* Decrement futex before reading barrier_count */
919 if (!uatomic_read(&completion
->barrier_count
))
921 call_rcu_completion_wait(completion
);
924 urcu_ref_put(&completion
->ref
, free_completion
);
932 * Acquire the call_rcu_mutex in order to ensure that the child sees
933 * all of the call_rcu() data structures in a consistent state. Ensure
934 * that all call_rcu threads are in a quiescent state across fork.
935 * Suitable for pthread_atfork() and friends.
937 void call_rcu_before_fork(void)
939 struct call_rcu_data
*crdp
;
940 struct urcu_atfork
*atfork
;
942 call_rcu_lock(&call_rcu_mutex
);
944 atfork
= registered_rculfhash_atfork
;
946 atfork
->before_fork(atfork
->priv
);
948 cds_list_for_each_entry(crdp
, &call_rcu_data_list
, list
) {
949 uatomic_or(&crdp
->flags
, URCU_CALL_RCU_PAUSE
);
950 cmm_smp_mb__after_uatomic_or();
951 wake_call_rcu_thread(crdp
);
953 cds_list_for_each_entry(crdp
, &call_rcu_data_list
, list
) {
954 while ((uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_PAUSED
) == 0)
955 (void) poll(NULL
, 0, 1);
960 * Clean up call_rcu data structures in the parent of a successful fork()
961 * that is not followed by exec() in the child. Suitable for
962 * pthread_atfork() and friends.
964 void call_rcu_after_fork_parent(void)
966 struct call_rcu_data
*crdp
;
967 struct urcu_atfork
*atfork
;
969 cds_list_for_each_entry(crdp
, &call_rcu_data_list
, list
)
970 uatomic_and(&crdp
->flags
, ~URCU_CALL_RCU_PAUSE
);
971 cds_list_for_each_entry(crdp
, &call_rcu_data_list
, list
) {
972 while ((uatomic_read(&crdp
->flags
) & URCU_CALL_RCU_PAUSED
) != 0)
973 (void) poll(NULL
, 0, 1);
975 atfork
= registered_rculfhash_atfork
;
977 atfork
->after_fork_parent(atfork
->priv
);
978 call_rcu_unlock(&call_rcu_mutex
);
982 * Clean up call_rcu data structures in the child of a successful fork()
983 * that is not followed by exec(). Suitable for pthread_atfork() and
986 void call_rcu_after_fork_child(void)
988 struct call_rcu_data
*crdp
, *next
;
989 struct urcu_atfork
*atfork
;
991 /* Release the mutex. */
992 call_rcu_unlock(&call_rcu_mutex
);
994 atfork
= registered_rculfhash_atfork
;
996 atfork
->after_fork_child(atfork
->priv
);
998 /* Do nothing when call_rcu() has not been used */
999 if (cds_list_empty(&call_rcu_data_list
))
1003 * Allocate a new default call_rcu_data structure in order
1004 * to get a working call_rcu thread to go with it.
1006 default_call_rcu_data
= NULL
;
1007 (void)get_default_call_rcu_data();
1009 /* Cleanup call_rcu_data pointers before use */
1010 cpus_array_len_reset();
1011 free(per_cpu_call_rcu_data
);
1012 rcu_set_pointer(&per_cpu_call_rcu_data
, NULL
);
1013 URCU_TLS(thread_call_rcu_data
) = NULL
;
1016 * Dispose of all of the rest of the call_rcu_data structures.
1017 * Leftover call_rcu callbacks will be merged into the new
1018 * default call_rcu thread queue.
1020 cds_list_for_each_entry_safe(crdp
, next
, &call_rcu_data_list
, list
) {
1021 if (crdp
== default_call_rcu_data
)
1023 uatomic_set(&crdp
->flags
, URCU_CALL_RCU_STOPPED
);
1024 call_rcu_data_free(crdp
);
1028 void urcu_register_rculfhash_atfork(struct urcu_atfork
*atfork
)
1030 if (CMM_LOAD_SHARED(registered_rculfhash_atfork
))
1032 call_rcu_lock(&call_rcu_mutex
);
1033 if (!registered_rculfhash_atfork
)
1034 registered_rculfhash_atfork
= atfork
;
1035 call_rcu_unlock(&call_rcu_mutex
);
1039 * This unregistration function is deprecated, meant only for internal
1042 __attribute__((noreturn
))
1043 void urcu_unregister_rculfhash_atfork(struct urcu_atfork
*atfork
__attribute__((unused
)))