4 * Userspace RCU library
6 * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library 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 GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 * IBM's contributions to this file may be relicensed under LGPLv2 or later.
26 #define URCU_NO_COMPAT_IDENTIFIERS
29 #define _DEFAULT_SOURCE
41 #include <urcu/config.h>
42 #include <urcu/arch.h>
43 #include <urcu/wfcqueue.h>
44 #include <urcu/map/urcu.h>
45 #include <urcu/static/urcu.h>
46 #include <urcu/pointer.h>
47 #include <urcu/tls-compat.h>
50 #include "urcu-wait.h"
51 #include "urcu-utils.h"
54 /* Do not #define _LGPL_SOURCE to ensure we can emit the wrapper symbols */
56 #include <urcu/urcu.h>
60 * If a reader is really non-cooperative and refuses to commit its
61 * rcu_active_readers count to memory (there is no barrier in the reader
62 * per-se), kick it after 10 loops waiting for it.
64 #define KICK_READER_LOOPS 10
67 * Active attempts to check for reader Q.S. before calling futex().
69 #define RCU_QS_ACTIVE_ATTEMPTS 100
71 /* If the headers do not support membarrier system call, fall back on RCU_MB */
72 #ifdef __NR_membarrier
73 # define membarrier(...) syscall(__NR_membarrier, __VA_ARGS__)
75 # define membarrier(...) -ENOSYS
79 MEMBARRIER_CMD_QUERY
= 0,
80 MEMBARRIER_CMD_SHARED
= (1 << 0),
81 /* reserved for MEMBARRIER_CMD_SHARED_EXPEDITED (1 << 1) */
82 /* reserved for MEMBARRIER_CMD_PRIVATE (1 << 2) */
83 MEMBARRIER_CMD_PRIVATE_EXPEDITED
= (1 << 3),
84 MEMBARRIER_CMD_REGISTER_PRIVATE_EXPEDITED
= (1 << 4),
89 static int urcu_memb_has_sys_membarrier_private_expedited
;
91 #ifndef CONFIG_RCU_FORCE_SYS_MEMBARRIER
93 * Explicitly initialize to zero because we can't alias a non-static
94 * uninitialized variable.
96 int urcu_memb_has_sys_membarrier
= 0;
97 URCU_ATTR_ALIAS("urcu_memb_has_sys_membarrier")
98 extern int rcu_has_sys_membarrier_memb
;
101 void __attribute__((constructor
)) rcu_init(void);
108 URCU_ATTR_ALIAS(urcu_stringify(rcu_init
))
109 void alias_rcu_init(void);
113 static int init_done
;
115 void __attribute__((constructor
)) rcu_init(void);
116 void __attribute__((destructor
)) rcu_exit(void);
120 * rcu_gp_lock ensures mutual exclusion between threads calling
123 static pthread_mutex_t rcu_gp_lock
= PTHREAD_MUTEX_INITIALIZER
;
125 * rcu_registry_lock ensures mutual exclusion between threads
126 * registering and unregistering themselves to/from the registry, and
127 * with threads reading that registry from synchronize_rcu(). However,
128 * this lock is not held all the way through the completion of awaiting
129 * for the grace period. It is sporadically released between iterations
131 * rcu_registry_lock may nest inside rcu_gp_lock.
133 static pthread_mutex_t rcu_registry_lock
= PTHREAD_MUTEX_INITIALIZER
;
134 struct urcu_gp rcu_gp
= { .ctr
= URCU_GP_COUNT
};
135 URCU_ATTR_ALIAS(urcu_stringify(rcu_gp
))
136 extern struct urcu_gp alias_rcu_gp
;
139 * Written to only by each individual reader. Read by both the reader and the
142 DEFINE_URCU_TLS(struct urcu_reader
, rcu_reader
);
143 DEFINE_URCU_TLS_ALIAS(struct urcu_reader
, rcu_reader
, alias_rcu_reader
);
145 static CDS_LIST_HEAD(registry
);
148 * Queue keeping threads awaiting to wait for a grace period. Contains
149 * struct gp_waiters_thread objects.
151 static DEFINE_URCU_WAIT_QUEUE(gp_waiters
);
153 static void mutex_lock(pthread_mutex_t
*mutex
)
157 #ifndef DISTRUST_SIGNALS_EXTREME
158 ret
= pthread_mutex_lock(mutex
);
161 #else /* #ifndef DISTRUST_SIGNALS_EXTREME */
162 while ((ret
= pthread_mutex_trylock(mutex
)) != 0) {
163 if (ret
!= EBUSY
&& ret
!= EINTR
)
165 if (CMM_LOAD_SHARED(URCU_TLS(rcu_reader
).need_mb
)) {
167 _CMM_STORE_SHARED(URCU_TLS(rcu_reader
).need_mb
, 0);
170 (void) poll(NULL
, 0, 10);
172 #endif /* #else #ifndef DISTRUST_SIGNALS_EXTREME */
175 static void mutex_unlock(pthread_mutex_t
*mutex
)
179 ret
= pthread_mutex_unlock(mutex
);
184 #ifdef RCU_MEMBARRIER
185 static void smp_mb_master(void)
187 if (caa_likely(urcu_memb_has_sys_membarrier
)) {
188 if (membarrier(urcu_memb_has_sys_membarrier_private_expedited
?
189 MEMBARRIER_CMD_PRIVATE_EXPEDITED
:
190 MEMBARRIER_CMD_SHARED
, 0))
199 static void smp_mb_master(void)
206 static void force_mb_all_readers(void)
208 struct urcu_reader
*index
;
211 * Ask for each threads to execute a cmm_smp_mb() so we can consider the
212 * compiler barriers around rcu read lock as real memory barriers.
214 if (cds_list_empty(®istry
))
217 * pthread_kill has a cmm_smp_mb(). But beware, we assume it performs
218 * a cache flush on architectures with non-coherent cache. Let's play
219 * safe and don't assume anything : we use cmm_smp_mc() to make sure the
220 * cache flush is enforced.
222 cds_list_for_each_entry(index
, ®istry
, node
) {
223 CMM_STORE_SHARED(index
->need_mb
, 1);
224 pthread_kill(index
->tid
, SIGRCU
);
227 * Wait for sighandler (and thus mb()) to execute on every thread.
229 * Note that the pthread_kill() will never be executed on systems
230 * that correctly deliver signals in a timely manner. However, it
231 * is not uncommon for kernels to have bugs that can result in
232 * lost or unduly delayed signals.
234 * If you are seeing the below pthread_kill() executing much at
235 * all, we suggest testing the underlying kernel and filing the
236 * relevant bug report. For Linux kernels, we recommend getting
237 * the Linux Test Project (LTP).
239 cds_list_for_each_entry(index
, ®istry
, node
) {
240 while (CMM_LOAD_SHARED(index
->need_mb
)) {
241 pthread_kill(index
->tid
, SIGRCU
);
242 (void) poll(NULL
, 0, 1);
245 cmm_smp_mb(); /* read ->need_mb before ending the barrier */
248 static void smp_mb_master(void)
250 force_mb_all_readers();
252 #endif /* #ifdef RCU_SIGNAL */
255 * synchronize_rcu() waiting. Single thread.
256 * Always called with rcu_registry lock held. Releases this lock and
257 * grabs it again. Holds the lock when it returns.
259 static void wait_gp(void)
262 * Read reader_gp before read futex. smp_mb_master() needs to
263 * be called with the rcu registry lock held in RCU_SIGNAL
267 /* Temporarily unlock the registry lock. */
268 mutex_unlock(&rcu_registry_lock
);
269 if (uatomic_read(&rcu_gp
.futex
) != -1)
271 while (futex_async(&rcu_gp
.futex
, FUTEX_WAIT
, -1,
275 /* Value already changed. */
278 /* Retry if interrupted by signal. */
279 break; /* Get out of switch. */
281 /* Unexpected error. */
287 * Re-lock the registry lock before the next loop.
289 mutex_lock(&rcu_registry_lock
);
293 * Always called with rcu_registry lock held. Releases this lock between
294 * iterations and grabs it again. Holds the lock when it returns.
296 static void wait_for_readers(struct cds_list_head
*input_readers
,
297 struct cds_list_head
*cur_snap_readers
,
298 struct cds_list_head
*qsreaders
)
300 unsigned int wait_loops
= 0;
301 struct urcu_reader
*index
, *tmp
;
302 #ifdef HAS_INCOHERENT_CACHES
303 unsigned int wait_gp_loops
= 0;
304 #endif /* HAS_INCOHERENT_CACHES */
307 * Wait for each thread URCU_TLS(rcu_reader).ctr to either
308 * indicate quiescence (not nested), or observe the current
312 if (wait_loops
< RCU_QS_ACTIVE_ATTEMPTS
)
314 if (wait_loops
>= RCU_QS_ACTIVE_ATTEMPTS
) {
315 uatomic_dec(&rcu_gp
.futex
);
316 /* Write futex before read reader_gp */
320 cds_list_for_each_entry_safe(index
, tmp
, input_readers
, node
) {
321 switch (urcu_common_reader_state(&rcu_gp
, &index
->ctr
)) {
322 case URCU_READER_ACTIVE_CURRENT
:
323 if (cur_snap_readers
) {
324 cds_list_move(&index
->node
,
329 case URCU_READER_INACTIVE
:
330 cds_list_move(&index
->node
, qsreaders
);
332 case URCU_READER_ACTIVE_OLD
:
334 * Old snapshot. Leaving node in
335 * input_readers will make us busy-loop
336 * until the snapshot becomes current or
337 * the reader becomes inactive.
343 #ifndef HAS_INCOHERENT_CACHES
344 if (cds_list_empty(input_readers
)) {
345 if (wait_loops
>= RCU_QS_ACTIVE_ATTEMPTS
) {
346 /* Read reader_gp before write futex */
348 uatomic_set(&rcu_gp
.futex
, 0);
352 if (wait_loops
>= RCU_QS_ACTIVE_ATTEMPTS
) {
353 /* wait_gp unlocks/locks registry lock. */
356 /* Temporarily unlock the registry lock. */
357 mutex_unlock(&rcu_registry_lock
);
360 * Re-lock the registry lock before the
363 mutex_lock(&rcu_registry_lock
);
366 #else /* #ifndef HAS_INCOHERENT_CACHES */
368 * BUSY-LOOP. Force the reader thread to commit its
369 * URCU_TLS(rcu_reader).ctr update to memory if we wait
372 if (cds_list_empty(input_readers
)) {
373 if (wait_loops
>= RCU_QS_ACTIVE_ATTEMPTS
) {
374 /* Read reader_gp before write futex */
376 uatomic_set(&rcu_gp
.futex
, 0);
380 if (wait_gp_loops
== KICK_READER_LOOPS
) {
384 if (wait_loops
>= RCU_QS_ACTIVE_ATTEMPTS
) {
385 /* wait_gp unlocks/locks registry lock. */
389 /* Temporarily unlock the registry lock. */
390 mutex_unlock(&rcu_registry_lock
);
393 * Re-lock the registry lock before the
396 mutex_lock(&rcu_registry_lock
);
399 #endif /* #else #ifndef HAS_INCOHERENT_CACHES */
403 void synchronize_rcu(void)
405 CDS_LIST_HEAD(cur_snap_readers
);
406 CDS_LIST_HEAD(qsreaders
);
407 DEFINE_URCU_WAIT_NODE(wait
, URCU_WAIT_WAITING
);
408 struct urcu_waiters waiters
;
411 * Add ourself to gp_waiters queue of threads awaiting to wait
412 * for a grace period. Proceed to perform the grace period only
413 * if we are the first thread added into the queue.
414 * The implicit memory barrier before urcu_wait_add()
415 * orders prior memory accesses of threads put into the wait
416 * queue before their insertion into the wait queue.
418 if (urcu_wait_add(&gp_waiters
, &wait
) != 0) {
419 /* Not first in queue: will be awakened by another thread. */
420 urcu_adaptative_busy_wait(&wait
);
421 /* Order following memory accesses after grace period. */
425 /* We won't need to wake ourself up */
426 urcu_wait_set_state(&wait
, URCU_WAIT_RUNNING
);
428 mutex_lock(&rcu_gp_lock
);
431 * Move all waiters into our local queue.
433 urcu_move_waiters(&waiters
, &gp_waiters
);
435 mutex_lock(&rcu_registry_lock
);
437 if (cds_list_empty(®istry
))
441 * All threads should read qparity before accessing data structure
442 * where new ptr points to. Must be done within rcu_registry_lock
443 * because it iterates on reader threads.
445 /* Write new ptr before changing the qparity */
449 * Wait for readers to observe original parity or be quiescent.
450 * wait_for_readers() can release and grab again rcu_registry_lock
453 wait_for_readers(®istry
, &cur_snap_readers
, &qsreaders
);
456 * Must finish waiting for quiescent state for original parity before
457 * committing next rcu_gp.ctr update to memory. Failure to do so could
458 * result in the writer waiting forever while new readers are always
459 * accessing data (no progress). Enforce compiler-order of load
460 * URCU_TLS(rcu_reader).ctr before store to rcu_gp.ctr.
465 * Adding a cmm_smp_mb() which is _not_ formally required, but makes the
466 * model easier to understand. It does not have a big performance impact
467 * anyway, given this is the write-side.
471 /* Switch parity: 0 -> 1, 1 -> 0 */
472 CMM_STORE_SHARED(rcu_gp
.ctr
, rcu_gp
.ctr
^ URCU_GP_CTR_PHASE
);
475 * Must commit rcu_gp.ctr update to memory before waiting for quiescent
476 * state. Failure to do so could result in the writer waiting forever
477 * while new readers are always accessing data (no progress). Enforce
478 * compiler-order of store to rcu_gp.ctr before load rcu_reader ctr.
484 * Adding a cmm_smp_mb() which is _not_ formally required, but makes the
485 * model easier to understand. It does not have a big performance impact
486 * anyway, given this is the write-side.
491 * Wait for readers to observe new parity or be quiescent.
492 * wait_for_readers() can release and grab again rcu_registry_lock
495 wait_for_readers(&cur_snap_readers
, NULL
, &qsreaders
);
498 * Put quiescent reader list back into registry.
500 cds_list_splice(&qsreaders
, ®istry
);
503 * Finish waiting for reader threads before letting the old ptr
504 * being freed. Must be done within rcu_registry_lock because it
505 * iterates on reader threads.
509 mutex_unlock(&rcu_registry_lock
);
510 mutex_unlock(&rcu_gp_lock
);
513 * Wakeup waiters only after we have completed the grace period
514 * and have ensured the memory barriers at the end of the grace
515 * period have been issued.
517 urcu_wake_all_waiters(&waiters
);
519 URCU_ATTR_ALIAS(urcu_stringify(synchronize_rcu
))
520 void alias_synchronize_rcu();
523 * library wrappers to be used by non-LGPL compatible source code.
526 void rcu_read_lock(void)
530 URCU_ATTR_ALIAS(urcu_stringify(rcu_read_lock
))
531 void alias_rcu_read_lock();
533 void rcu_read_unlock(void)
537 URCU_ATTR_ALIAS(urcu_stringify(rcu_read_unlock
))
538 void alias_rcu_read_unlock();
540 int rcu_read_ongoing(void)
542 return _rcu_read_ongoing();
544 URCU_ATTR_ALIAS(urcu_stringify(rcu_read_ongoing
))
545 void alias_rcu_read_ongoing();
547 void rcu_register_thread(void)
549 URCU_TLS(rcu_reader
).tid
= pthread_self();
550 assert(URCU_TLS(rcu_reader
).need_mb
== 0);
551 assert(!(URCU_TLS(rcu_reader
).ctr
& URCU_GP_CTR_NEST_MASK
));
553 mutex_lock(&rcu_registry_lock
);
554 assert(!URCU_TLS(rcu_reader
).registered
);
555 URCU_TLS(rcu_reader
).registered
= 1;
556 rcu_init(); /* In case gcc does not support constructor attribute */
557 cds_list_add(&URCU_TLS(rcu_reader
).node
, ®istry
);
558 mutex_unlock(&rcu_registry_lock
);
560 URCU_ATTR_ALIAS(urcu_stringify(rcu_register_thread
))
561 void alias_rcu_register_thread();
563 void rcu_unregister_thread(void)
565 mutex_lock(&rcu_registry_lock
);
566 assert(URCU_TLS(rcu_reader
).registered
);
567 URCU_TLS(rcu_reader
).registered
= 0;
568 cds_list_del(&URCU_TLS(rcu_reader
).node
);
569 mutex_unlock(&rcu_registry_lock
);
571 URCU_ATTR_ALIAS(urcu_stringify(rcu_unregister_thread
))
572 void alias_rcu_unregister_thread();
574 #ifdef RCU_MEMBARRIER
576 #ifdef CONFIG_RCU_FORCE_SYS_MEMBARRIER
578 void rcu_sys_membarrier_status(bool available
)
585 void rcu_sys_membarrier_status(bool available
)
589 urcu_memb_has_sys_membarrier
= 1;
594 void rcu_sys_membarrier_init(void)
596 bool available
= false;
599 mask
= membarrier(MEMBARRIER_CMD_QUERY
, 0);
601 if (mask
& MEMBARRIER_CMD_PRIVATE_EXPEDITED
) {
602 if (membarrier(MEMBARRIER_CMD_REGISTER_PRIVATE_EXPEDITED
, 0))
604 urcu_memb_has_sys_membarrier_private_expedited
= 1;
606 } else if (mask
& MEMBARRIER_CMD_SHARED
) {
610 rcu_sys_membarrier_status(available
);
618 rcu_sys_membarrier_init();
620 URCU_ATTR_ALIAS(urcu_stringify(rcu_init
))
621 void alias_rcu_init(void);
625 static void sigrcu_handler(int signo
__attribute__((unused
)),
626 siginfo_t
*siginfo
__attribute__((unused
)),
627 void *context
__attribute__((unused
)))
630 * Executing this cmm_smp_mb() is the only purpose of this signal handler.
631 * It punctually promotes cmm_barrier() into cmm_smp_mb() on every thread it is
635 _CMM_STORE_SHARED(URCU_TLS(rcu_reader
).need_mb
, 0);
640 * rcu_init constructor. Called when the library is linked, but also when
641 * reader threads are calling rcu_register_thread().
642 * Should only be called by a single thread at a given time. This is ensured by
643 * holing the rcu_registry_lock from rcu_register_thread() or by running
644 * at library load time, which should not be executed by multiple
645 * threads nor concurrently with rcu_register_thread() anyway.
649 struct sigaction act
;
656 act
.sa_sigaction
= sigrcu_handler
;
657 act
.sa_flags
= SA_SIGINFO
| SA_RESTART
;
658 sigemptyset(&act
.sa_mask
);
659 ret
= sigaction(SIGRCU
, &act
, NULL
);
663 URCU_ATTR_ALIAS(urcu_stringify(rcu_init
))
664 void alias_rcu_init(void);
669 * Don't unregister the SIGRCU signal handler anymore, because
670 * call_rcu threads could still be using it shortly before the
672 * Assertion disabled because call_rcu threads are now rcu
673 * readers, and left running at exit.
674 * assert(cds_list_empty(®istry));
677 URCU_ATTR_ALIAS(urcu_stringify(rcu_exit
))
678 void alias_rcu_exit(void);
680 #endif /* #ifdef RCU_SIGNAL */
682 DEFINE_RCU_FLAVOR(rcu_flavor
);
683 DEFINE_RCU_FLAVOR_ALIAS(rcu_flavor
, alias_rcu_flavor
);
685 #include "urcu-call-rcu-impl.h"
686 #include "urcu-defer-impl.h"