4 * Userspace RCU library, "bulletproof" version.
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
40 #include <urcu/config.h>
41 #include <urcu/arch.h>
42 #include <urcu/wfcqueue.h>
43 #include <urcu/map/urcu-bp.h>
44 #include <urcu/static/urcu-bp.h>
45 #include <urcu/pointer.h>
46 #include <urcu/tls-compat.h>
49 #include "urcu-utils.h"
52 /* Do not #define _LGPL_SOURCE to ensure we can emit the wrapper symbols */
54 #include <urcu/urcu-bp.h>
58 #define MAP_ANONYMOUS MAP_ANON
63 void *mremap_wrapper(void *old_address
, size_t old_size
,
64 size_t new_size
, int flags
)
66 return mremap(old_address
, old_size
, new_size
, flags
);
70 #define MREMAP_MAYMOVE 1
71 #define MREMAP_FIXED 2
74 * mremap wrapper for non-Linux systems not allowing MAYMOVE.
75 * This is not generic.
78 void *mremap_wrapper(void *old_address
__attribute__((unused
)),
79 size_t old_size
__attribute__((unused
)),
80 size_t new_size
__attribute__((unused
)),
83 assert(!(flags
& MREMAP_MAYMOVE
));
89 /* Sleep delay in ms */
90 #define RCU_SLEEP_DELAY_MS 10
91 #define INIT_NR_THREADS 8
92 #define ARENA_INIT_ALLOC \
93 sizeof(struct registry_chunk) \
94 + INIT_NR_THREADS * sizeof(struct urcu_bp_reader)
97 * Active attempts to check for reader Q.S. before calling sleep().
99 #define RCU_QS_ACTIVE_ATTEMPTS 100
102 int urcu_bp_refcount
;
104 /* If the headers do not support membarrier system call, fall back smp_mb. */
105 #ifdef __NR_membarrier
106 # define membarrier(...) syscall(__NR_membarrier, __VA_ARGS__)
108 # define membarrier(...) -ENOSYS
111 enum membarrier_cmd
{
112 MEMBARRIER_CMD_QUERY
= 0,
113 MEMBARRIER_CMD_SHARED
= (1 << 0),
114 /* reserved for MEMBARRIER_CMD_SHARED_EXPEDITED (1 << 1) */
115 /* reserved for MEMBARRIER_CMD_PRIVATE (1 << 2) */
116 MEMBARRIER_CMD_PRIVATE_EXPEDITED
= (1 << 3),
117 MEMBARRIER_CMD_REGISTER_PRIVATE_EXPEDITED
= (1 << 4),
121 void __attribute__((constructor
)) _urcu_bp_init(void);
123 void __attribute__((destructor
)) urcu_bp_exit(void);
125 #ifndef CONFIG_RCU_FORCE_SYS_MEMBARRIER
126 int urcu_bp_has_sys_membarrier
;
130 * rcu_gp_lock ensures mutual exclusion between threads calling
133 static pthread_mutex_t rcu_gp_lock
= PTHREAD_MUTEX_INITIALIZER
;
135 * rcu_registry_lock ensures mutual exclusion between threads
136 * registering and unregistering themselves to/from the registry, and
137 * with threads reading that registry from synchronize_rcu(). However,
138 * this lock is not held all the way through the completion of awaiting
139 * for the grace period. It is sporadically released between iterations
141 * rcu_registry_lock may nest inside rcu_gp_lock.
143 static pthread_mutex_t rcu_registry_lock
= PTHREAD_MUTEX_INITIALIZER
;
145 static pthread_mutex_t init_lock
= PTHREAD_MUTEX_INITIALIZER
;
146 static int initialized
;
148 static pthread_key_t urcu_bp_key
;
150 struct urcu_bp_gp urcu_bp_gp
= { .ctr
= URCU_BP_GP_COUNT
};
151 URCU_ATTR_ALIAS("urcu_bp_gp") extern struct urcu_bp_gp rcu_gp_bp
;
154 * Pointer to registry elements. Written to only by each individual reader. Read
155 * by both the reader and the writers.
157 DEFINE_URCU_TLS(struct urcu_bp_reader
*, urcu_bp_reader
);
158 DEFINE_URCU_TLS_ALIAS(struct urcu_bp_reader
*, urcu_bp_reader
, rcu_reader_bp
);
160 static CDS_LIST_HEAD(registry
);
162 struct registry_chunk
{
163 size_t data_len
; /* data length */
164 size_t used
; /* amount of data used */
165 struct cds_list_head node
; /* chunk_list node */
169 struct registry_arena
{
170 struct cds_list_head chunk_list
;
173 static struct registry_arena registry_arena
= {
174 .chunk_list
= CDS_LIST_HEAD_INIT(registry_arena
.chunk_list
),
177 /* Saved fork signal mask, protected by rcu_gp_lock */
178 static sigset_t saved_fork_signal_mask
;
180 static void mutex_lock(pthread_mutex_t
*mutex
)
184 #ifndef DISTRUST_SIGNALS_EXTREME
185 ret
= pthread_mutex_lock(mutex
);
188 #else /* #ifndef DISTRUST_SIGNALS_EXTREME */
189 while ((ret
= pthread_mutex_trylock(mutex
)) != 0) {
190 if (ret
!= EBUSY
&& ret
!= EINTR
)
194 #endif /* #else #ifndef DISTRUST_SIGNALS_EXTREME */
197 static void mutex_unlock(pthread_mutex_t
*mutex
)
201 ret
= pthread_mutex_unlock(mutex
);
206 static void smp_mb_master(void)
208 if (caa_likely(urcu_bp_has_sys_membarrier
)) {
209 if (membarrier(MEMBARRIER_CMD_PRIVATE_EXPEDITED
, 0))
217 * Always called with rcu_registry lock held. Releases this lock between
218 * iterations and grabs it again. Holds the lock when it returns.
220 static void wait_for_readers(struct cds_list_head
*input_readers
,
221 struct cds_list_head
*cur_snap_readers
,
222 struct cds_list_head
*qsreaders
)
224 unsigned int wait_loops
= 0;
225 struct urcu_bp_reader
*index
, *tmp
;
228 * Wait for each thread URCU_TLS(urcu_bp_reader).ctr to either
229 * indicate quiescence (not nested), or observe the current
233 if (wait_loops
< RCU_QS_ACTIVE_ATTEMPTS
)
236 cds_list_for_each_entry_safe(index
, tmp
, input_readers
, node
) {
237 switch (urcu_bp_reader_state(&index
->ctr
)) {
238 case URCU_BP_READER_ACTIVE_CURRENT
:
239 if (cur_snap_readers
) {
240 cds_list_move(&index
->node
,
245 case URCU_BP_READER_INACTIVE
:
246 cds_list_move(&index
->node
, qsreaders
);
248 case URCU_BP_READER_ACTIVE_OLD
:
250 * Old snapshot. Leaving node in
251 * input_readers will make us busy-loop
252 * until the snapshot becomes current or
253 * the reader becomes inactive.
259 if (cds_list_empty(input_readers
)) {
262 /* Temporarily unlock the registry lock. */
263 mutex_unlock(&rcu_registry_lock
);
264 if (wait_loops
>= RCU_QS_ACTIVE_ATTEMPTS
)
265 (void) poll(NULL
, 0, RCU_SLEEP_DELAY_MS
);
268 /* Re-lock the registry lock before the next loop. */
269 mutex_lock(&rcu_registry_lock
);
274 void urcu_bp_synchronize_rcu(void)
276 CDS_LIST_HEAD(cur_snap_readers
);
277 CDS_LIST_HEAD(qsreaders
);
278 sigset_t newmask
, oldmask
;
281 ret
= sigfillset(&newmask
);
283 ret
= pthread_sigmask(SIG_BLOCK
, &newmask
, &oldmask
);
286 mutex_lock(&rcu_gp_lock
);
288 mutex_lock(&rcu_registry_lock
);
290 if (cds_list_empty(®istry
))
293 /* All threads should read qparity before accessing data structure
294 * where new ptr points to. */
295 /* Write new ptr before changing the qparity */
299 * Wait for readers to observe original parity or be quiescent.
300 * wait_for_readers() can release and grab again rcu_registry_lock
303 wait_for_readers(®istry
, &cur_snap_readers
, &qsreaders
);
306 * Adding a cmm_smp_mb() which is _not_ formally required, but makes the
307 * model easier to understand. It does not have a big performance impact
308 * anyway, given this is the write-side.
312 /* Switch parity: 0 -> 1, 1 -> 0 */
313 CMM_STORE_SHARED(rcu_gp
.ctr
, rcu_gp
.ctr
^ URCU_BP_GP_CTR_PHASE
);
316 * Must commit qparity update to memory before waiting for other parity
317 * quiescent state. Failure to do so could result in the writer waiting
318 * forever while new readers are always accessing data (no progress).
319 * Ensured by CMM_STORE_SHARED and CMM_LOAD_SHARED.
323 * Adding a cmm_smp_mb() which is _not_ formally required, but makes the
324 * model easier to understand. It does not have a big performance impact
325 * anyway, given this is the write-side.
330 * Wait for readers to observe new parity or be quiescent.
331 * wait_for_readers() can release and grab again rcu_registry_lock
334 wait_for_readers(&cur_snap_readers
, NULL
, &qsreaders
);
337 * Put quiescent reader list back into registry.
339 cds_list_splice(&qsreaders
, ®istry
);
342 * Finish waiting for reader threads before letting the old ptr being
347 mutex_unlock(&rcu_registry_lock
);
348 mutex_unlock(&rcu_gp_lock
);
349 ret
= pthread_sigmask(SIG_SETMASK
, &oldmask
, NULL
);
352 URCU_ATTR_ALIAS("urcu_bp_synchronize_rcu") void synchronize_rcu_bp();
355 * library wrappers to be used by non-LGPL compatible source code.
358 void urcu_bp_read_lock(void)
360 _urcu_bp_read_lock();
362 URCU_ATTR_ALIAS("urcu_bp_read_lock") void rcu_read_lock_bp();
364 void urcu_bp_read_unlock(void)
366 _urcu_bp_read_unlock();
368 URCU_ATTR_ALIAS("urcu_bp_read_unlock") void rcu_read_unlock_bp();
370 int urcu_bp_read_ongoing(void)
372 return _urcu_bp_read_ongoing();
374 URCU_ATTR_ALIAS("urcu_bp_read_ongoing") int rcu_read_ongoing_bp();
377 * Only grow for now. If empty, allocate a ARENA_INIT_ALLOC sized chunk.
378 * Else, try expanding the last chunk. If this fails, allocate a new
379 * chunk twice as big as the last chunk.
380 * Memory used by chunks _never_ moves. A chunk could theoretically be
381 * freed when all "used" slots are released, but we don't do it at this
385 void expand_arena(struct registry_arena
*arena
)
387 struct registry_chunk
*new_chunk
, *last_chunk
;
388 size_t old_chunk_len
, new_chunk_len
;
391 if (cds_list_empty(&arena
->chunk_list
)) {
392 assert(ARENA_INIT_ALLOC
>=
393 sizeof(struct registry_chunk
)
394 + sizeof(struct rcu_reader
));
395 new_chunk_len
= ARENA_INIT_ALLOC
;
396 new_chunk
= (struct registry_chunk
*) mmap(NULL
,
398 PROT_READ
| PROT_WRITE
,
399 MAP_ANONYMOUS
| MAP_PRIVATE
,
401 if (new_chunk
== MAP_FAILED
)
403 memset(new_chunk
, 0, new_chunk_len
);
404 new_chunk
->data_len
=
405 new_chunk_len
- sizeof(struct registry_chunk
);
406 cds_list_add_tail(&new_chunk
->node
, &arena
->chunk_list
);
407 return; /* We're done. */
410 /* Try expanding last chunk. */
411 last_chunk
= cds_list_entry(arena
->chunk_list
.prev
,
412 struct registry_chunk
, node
);
414 last_chunk
->data_len
+ sizeof(struct registry_chunk
);
415 new_chunk_len
= old_chunk_len
<< 1;
417 /* Don't allow memory mapping to move, just expand. */
418 new_chunk
= mremap_wrapper(last_chunk
, old_chunk_len
,
420 if (new_chunk
!= MAP_FAILED
) {
421 /* Should not have moved. */
422 assert(new_chunk
== last_chunk
);
423 memset((char *) last_chunk
+ old_chunk_len
, 0,
424 new_chunk_len
- old_chunk_len
);
425 last_chunk
->data_len
=
426 new_chunk_len
- sizeof(struct registry_chunk
);
427 return; /* We're done. */
430 /* Remap did not succeed, we need to add a new chunk. */
431 new_chunk
= (struct registry_chunk
*) mmap(NULL
,
433 PROT_READ
| PROT_WRITE
,
434 MAP_ANONYMOUS
| MAP_PRIVATE
,
436 if (new_chunk
== MAP_FAILED
)
438 memset(new_chunk
, 0, new_chunk_len
);
439 new_chunk
->data_len
=
440 new_chunk_len
- sizeof(struct registry_chunk
);
441 cds_list_add_tail(&new_chunk
->node
, &arena
->chunk_list
);
445 struct rcu_reader
*arena_alloc(struct registry_arena
*arena
)
447 struct registry_chunk
*chunk
;
448 struct rcu_reader
*rcu_reader_reg
;
449 int expand_done
= 0; /* Only allow to expand once per alloc */
450 size_t len
= sizeof(struct rcu_reader
);
453 cds_list_for_each_entry(chunk
, &arena
->chunk_list
, node
) {
454 if (chunk
->data_len
- chunk
->used
< len
)
457 for (rcu_reader_reg
= (struct rcu_reader
*) &chunk
->data
[0];
458 rcu_reader_reg
< (struct rcu_reader
*) &chunk
->data
[chunk
->data_len
];
460 if (!rcu_reader_reg
->alloc
) {
461 rcu_reader_reg
->alloc
= 1;
463 return rcu_reader_reg
;
477 /* Called with signals off and mutex locked */
479 void add_thread(void)
481 struct rcu_reader
*rcu_reader_reg
;
484 rcu_reader_reg
= arena_alloc(®istry_arena
);
487 ret
= pthread_setspecific(urcu_bp_key
, rcu_reader_reg
);
491 /* Add to registry */
492 rcu_reader_reg
->tid
= pthread_self();
493 assert(rcu_reader_reg
->ctr
== 0);
494 cds_list_add(&rcu_reader_reg
->node
, ®istry
);
496 * Reader threads are pointing to the reader registry. This is
497 * why its memory should never be relocated.
499 URCU_TLS(urcu_bp_reader
) = rcu_reader_reg
;
502 /* Called with mutex locked */
504 void cleanup_thread(struct registry_chunk
*chunk
,
505 struct rcu_reader
*rcu_reader_reg
)
507 rcu_reader_reg
->ctr
= 0;
508 cds_list_del(&rcu_reader_reg
->node
);
509 rcu_reader_reg
->tid
= 0;
510 rcu_reader_reg
->alloc
= 0;
511 chunk
->used
-= sizeof(struct rcu_reader
);
515 struct registry_chunk
*find_chunk(struct rcu_reader
*rcu_reader_reg
)
517 struct registry_chunk
*chunk
;
519 cds_list_for_each_entry(chunk
, ®istry_arena
.chunk_list
, node
) {
520 if (rcu_reader_reg
< (struct rcu_reader
*) &chunk
->data
[0])
522 if (rcu_reader_reg
>= (struct rcu_reader
*) &chunk
->data
[chunk
->data_len
])
529 /* Called with signals off and mutex locked */
531 void remove_thread(struct rcu_reader
*rcu_reader_reg
)
533 cleanup_thread(find_chunk(rcu_reader_reg
), rcu_reader_reg
);
534 URCU_TLS(urcu_bp_reader
) = NULL
;
537 /* Disable signals, take mutex, add to registry */
538 void urcu_bp_register(void)
540 sigset_t newmask
, oldmask
;
543 ret
= sigfillset(&newmask
);
546 ret
= pthread_sigmask(SIG_BLOCK
, &newmask
, &oldmask
);
551 * Check if a signal concurrently registered our thread since
552 * the check in rcu_read_lock().
554 if (URCU_TLS(urcu_bp_reader
))
558 * Take care of early registration before urcu_bp constructor.
562 mutex_lock(&rcu_registry_lock
);
564 mutex_unlock(&rcu_registry_lock
);
566 ret
= pthread_sigmask(SIG_SETMASK
, &oldmask
, NULL
);
570 URCU_ATTR_ALIAS("urcu_bp_register") void rcu_bp_register();
572 void urcu_bp_register_thread(void)
574 if (caa_unlikely(!URCU_TLS(urcu_bp_reader
)))
575 urcu_bp_register(); /* If not yet registered. */
578 /* Disable signals, take mutex, remove from registry */
580 void urcu_bp_unregister(struct rcu_reader
*rcu_reader_reg
)
582 sigset_t newmask
, oldmask
;
585 ret
= sigfillset(&newmask
);
588 ret
= pthread_sigmask(SIG_BLOCK
, &newmask
, &oldmask
);
592 mutex_lock(&rcu_registry_lock
);
593 remove_thread(rcu_reader_reg
);
594 mutex_unlock(&rcu_registry_lock
);
595 ret
= pthread_sigmask(SIG_SETMASK
, &oldmask
, NULL
);
602 * Remove thread from the registry when it exits, and flag it as
603 * destroyed so garbage collection can take care of it.
606 void urcu_bp_thread_exit_notifier(void *rcu_key
)
608 urcu_bp_unregister(rcu_key
);
611 #ifdef CONFIG_RCU_FORCE_SYS_MEMBARRIER
613 void urcu_bp_sys_membarrier_status(bool available
)
620 void urcu_bp_sys_membarrier_status(bool available
)
624 urcu_bp_has_sys_membarrier
= 1;
629 void urcu_bp_sys_membarrier_init(void)
631 bool available
= false;
634 mask
= membarrier(MEMBARRIER_CMD_QUERY
, 0);
636 if (mask
& MEMBARRIER_CMD_PRIVATE_EXPEDITED
) {
637 if (membarrier(MEMBARRIER_CMD_REGISTER_PRIVATE_EXPEDITED
, 0))
642 urcu_bp_sys_membarrier_status(available
);
646 void _urcu_bp_init(void)
648 mutex_lock(&init_lock
);
649 if (!urcu_bp_refcount
++) {
652 ret
= pthread_key_create(&urcu_bp_key
,
653 urcu_bp_thread_exit_notifier
);
656 urcu_bp_sys_membarrier_init();
659 mutex_unlock(&init_lock
);
663 void urcu_bp_exit(void)
665 mutex_lock(&init_lock
);
666 if (!--urcu_bp_refcount
) {
667 struct registry_chunk
*chunk
, *tmp
;
670 cds_list_for_each_entry_safe(chunk
, tmp
,
671 ®istry_arena
.chunk_list
, node
) {
672 munmap((void *) chunk
, chunk
->data_len
673 + sizeof(struct registry_chunk
));
675 CDS_INIT_LIST_HEAD(®istry_arena
.chunk_list
);
676 ret
= pthread_key_delete(urcu_bp_key
);
680 mutex_unlock(&init_lock
);
684 * Holding the rcu_gp_lock and rcu_registry_lock across fork will make
685 * sure we fork() don't race with a concurrent thread executing with
686 * any of those locks held. This ensures that the registry and data
687 * protected by rcu_gp_lock are in a coherent state in the child.
689 void urcu_bp_before_fork(void)
691 sigset_t newmask
, oldmask
;
694 ret
= sigfillset(&newmask
);
696 ret
= pthread_sigmask(SIG_BLOCK
, &newmask
, &oldmask
);
698 mutex_lock(&rcu_gp_lock
);
699 mutex_lock(&rcu_registry_lock
);
700 saved_fork_signal_mask
= oldmask
;
702 URCU_ATTR_ALIAS("urcu_bp_before_fork") void rcu_bp_before_fork();
704 void urcu_bp_after_fork_parent(void)
709 oldmask
= saved_fork_signal_mask
;
710 mutex_unlock(&rcu_registry_lock
);
711 mutex_unlock(&rcu_gp_lock
);
712 ret
= pthread_sigmask(SIG_SETMASK
, &oldmask
, NULL
);
715 URCU_ATTR_ALIAS("urcu_bp_after_fork_parent")
716 void rcu_bp_after_fork_parent(void);
719 * Prune all entries from registry except our own thread. Fits the Linux
720 * fork behavior. Called with rcu_gp_lock and rcu_registry_lock held.
723 void urcu_bp_prune_registry(void)
725 struct registry_chunk
*chunk
;
726 struct urcu_bp_reader
*rcu_reader_reg
;
728 cds_list_for_each_entry(chunk
, ®istry_arena
.chunk_list
, node
) {
729 for (rcu_reader_reg
= (struct urcu_bp_reader
*) &chunk
->data
[0];
730 rcu_reader_reg
< (struct urcu_bp_reader
*) &chunk
->data
[chunk
->data_len
];
732 if (!rcu_reader_reg
->alloc
)
734 if (rcu_reader_reg
->tid
== pthread_self())
736 cleanup_thread(chunk
, rcu_reader_reg
);
741 void urcu_bp_after_fork_child(void)
746 urcu_bp_prune_registry();
747 oldmask
= saved_fork_signal_mask
;
748 mutex_unlock(&rcu_registry_lock
);
749 mutex_unlock(&rcu_gp_lock
);
750 ret
= pthread_sigmask(SIG_SETMASK
, &oldmask
, NULL
);
753 URCU_ATTR_ALIAS("urcu_bp_after_fork_child")
754 void rcu_bp_after_fork_child(void);
756 void *urcu_bp_dereference_sym(void *p
)
758 return _rcu_dereference(p
);
760 URCU_ATTR_ALIAS("urcu_bp_dereference_sym")
761 void *rcu_dereference_sym_bp();
763 void *urcu_bp_set_pointer_sym(void **p
, void *v
)
769 URCU_ATTR_ALIAS("urcu_bp_set_pointer_sym")
770 void *rcu_set_pointer_sym_bp();
772 void *urcu_bp_xchg_pointer_sym(void **p
, void *v
)
775 return uatomic_xchg(p
, v
);
777 URCU_ATTR_ALIAS("urcu_bp_xchg_pointer_sym")
778 void *rcu_xchg_pointer_sym_bp();
780 void *urcu_bp_cmpxchg_pointer_sym(void **p
, void *old
, void *_new
)
783 return uatomic_cmpxchg(p
, old
, _new
);
785 URCU_ATTR_ALIAS("urcu_bp_cmpxchg_pointer_sym")
786 void *rcu_cmpxchg_pointer_sym_bp();
788 DEFINE_RCU_FLAVOR(rcu_flavor
);
789 DEFINE_RCU_FLAVOR_ALIAS(rcu_flavor
, alias_rcu_flavor
);
791 #include "urcu-call-rcu-impl.h"
792 #include "urcu-defer-impl.h"