X-Git-Url: http://git.liburcu.org/?p=urcu.git;a=blobdiff_plain;f=urcu.h;h=85d4a4cdd47db666dfc4cee9c9e80d0879c5c956;hp=2aa35977036d9432884206983c21b6bc686b9cf0;hb=2af1c19e6a553878fcb2a5106f050d5ed7ac0f54;hpb=cf380c2fd2f85e3fba4826991fb748255bdc9b76 diff --git a/urcu.h b/urcu.h index 2aa3597..85d4a4c 100644 --- a/urcu.h +++ b/urcu.h @@ -6,142 +6,132 @@ * * Userspace RCU header * - * Copyright February 2009 - Mathieu Desnoyers + * Copyright (c) 2009 Mathieu Desnoyers + * Copyright (c) 2009 Paul E. McKenney, IBM Corporation. * - * Credits for Paul e. McKenney - * for inspiration coming from the Linux kernel RCU and rcu-preempt. + * LGPL-compatible code should include this header with : * - * The barrier, mb, rmb, wmb, atomic_inc, smp_read_barrier_depends, ACCESS_ONCE - * and rcu_dereference primitives come from the Linux kernel. + * #define _LGPL_SOURCE + * #include * - * Distributed under GPLv2 + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + * + * IBM's contributions to this file may be relicensed under LGPLv2 or later. */ -/* The "volatile" is due to gcc bugs */ -#define barrier() __asm__ __volatile__("": : :"memory") +#include +#include -/* x86 32/64 specific */ -#define mb() asm volatile("mfence":::"memory") -#define rmb() asm volatile("lfence":::"memory") -#define wmb() asm volatile("sfence" ::: "memory") +/* + * See urcu-pointer.h and urcu/static/urcu-pointer.h for pointer + * publication headers. + */ +#include -static inline void atomic_inc(int *v) -{ - asm volatile("lock; incl %0" - : "+m" (*v)); -} +#ifdef __cplusplus +extern "C" { +#endif -/* Nop everywhere except on alpha. */ -#define smp_read_barrier_depends() +#include /* - * Prevent the compiler from merging or refetching accesses. The compiler - * is also forbidden from reordering successive instances of ACCESS_ONCE(), - * but only when the compiler is aware of some particular ordering. One way - * to make the compiler aware of ordering is to put the two invocations of - * ACCESS_ONCE() in different C statements. + * Important ! * - * This macro does absolutely -nothing- to prevent the CPU from reordering, - * merging, or refetching absolutely anything at any time. Its main intended - * use is to mediate communication between process-level code and irq/NMI - * handlers, all running on the same CPU. + * Each thread containing read-side critical sections must be registered + * with rcu_register_thread_mb() before calling rcu_read_lock_mb(). + * rcu_unregister_thread_mb() should be called before the thread exits. */ -#define ACCESS_ONCE(x) (*(volatile typeof(x) *)&(x)) -/** - * rcu_dereference - fetch an RCU-protected pointer in an - * RCU read-side critical section. This pointer may later - * be safely dereferenced. - * - * Inserts memory barriers on architectures that require them - * (currently only the Alpha), and, more importantly, documents - * exactly which pointers are protected by RCU. - */ +#ifdef _LGPL_SOURCE -#define rcu_dereference(p) ({ \ - typeof(p) _________p1 = ACCESS_ONCE(p); \ - smp_read_barrier_depends(); \ - (_________p1); \ - }) +#include -#define SIGURCU SIGUSR1 +/* + * Mappings for static use of the userspace RCU library. + * Should only be used in LGPL-compatible code. + */ -#ifdef DEBUG_YIELD -#include +/* + * rcu_read_lock() + * rcu_read_unlock() + * + * Mark the beginning and end of a read-side critical section. + * DON'T FORGET TO USE RCU_REGISTER/UNREGISTER_THREAD() FOR EACH THREAD WITH + * READ-SIDE CRITICAL SECTION. + */ +#ifdef RCU_MEMBARRIER +#define rcu_read_lock_memb _rcu_read_lock +#define rcu_read_unlock_memb _rcu_read_unlock +#define rcu_read_ongoing_memb _rcu_read_ongoing +#elif defined(RCU_SIGNAL) +#define rcu_read_lock_sig _rcu_read_lock +#define rcu_read_unlock_sig _rcu_read_unlock +#define rcu_read_ongoing_sig _rcu_read_ongoing +#elif defined(RCU_MB) +#define rcu_read_lock_mb _rcu_read_lock +#define rcu_read_unlock_mb _rcu_read_unlock +#define rcu_read_ongoing_mb _rcu_read_ongoing +#endif -#define YIELD_READ (1 << 0) -#define YIELD_WRITE (1 << 1) +#else /* !_LGPL_SOURCE */ -extern int yield_active; +/* + * library wrappers to be used by non-LGPL compatible source code. + * See LGPL-only urcu/static/urcu-pointer.h for documentation. + */ -static inline void debug_yield_read(void) -{ - if (yield_active & YIELD_READ) - sched_yield(); -} +extern void rcu_read_lock(void); +extern void rcu_read_unlock(void); +extern int rcu_read_ongoing(void); -static inline void debug_yield_write(void) -{ - if (yield_active & YIELD_WRITE) - sched_yield(); -} -#else -static inline void debug_yield_read(void) -{ -} +#endif /* !_LGPL_SOURCE */ -static inline void debug_yield_write(void) -{ -} -#endif +extern void synchronize_rcu(void); -/* Global quiescent period parity */ -extern int urcu_qparity; +/* + * Reader thread registration. + */ +extern void rcu_register_thread(void); +extern void rcu_unregister_thread(void); -extern int __thread urcu_active_readers[2]; +/* + * Explicit rcu initialization, for "early" use within library constructors. + */ +extern void rcu_init(void); -static inline int get_urcu_qparity(void) +/* + * Q.S. reporting are no-ops for these URCU flavors. + */ +static inline void rcu_quiescent_state(void) { - return urcu_qparity; } -/* - * urcu_parity should be declared on the caller's stack. - */ -static inline void rcu_read_lock(int *urcu_parity) +static inline void rcu_thread_offline(void) { - debug_yield_read(); - *urcu_parity = get_urcu_qparity(); - debug_yield_read(); - urcu_active_readers[*urcu_parity]++; - debug_yield_read(); - /* - * Increment active readers count before accessing the pointer. - * See force_mb_all_threads(). - */ - barrier(); - debug_yield_read(); } -static inline void rcu_read_unlock(int *urcu_parity) +static inline void rcu_thread_online(void) { - debug_yield_read(); - barrier(); - debug_yield_read(); - /* - * Finish using rcu before decrementing the pointer. - * See force_mb_all_threads(). - */ - urcu_active_readers[*urcu_parity]--; - debug_yield_read(); } -extern void *urcu_publish_content(void **ptr, void *new); +#ifdef __cplusplus +} +#endif -/* - * Reader thread registration. - */ -extern void urcu_register_thread(void); -extern void urcu_unregister_thread(void); +#include +#include +#include #endif /* _URCU_H */