X-Git-Url: http://git.liburcu.org/?p=userspace-rcu.git;a=blobdiff_plain;f=src%2Furcu.h;fp=src%2Furcu.h;h=85d4a4cdd47db666dfc4cee9c9e80d0879c5c956;hp=0000000000000000000000000000000000000000;hb=6893800a4d1cc14dff0395ddcd660a5138db183d;hpb=a59f39055b5ecb77b68cf78b9839aa9e8e4ec332 diff --git a/src/urcu.h b/src/urcu.h new file mode 100644 index 0000000..85d4a4c --- /dev/null +++ b/src/urcu.h @@ -0,0 +1,137 @@ +#ifndef _URCU_H +#define _URCU_H + +/* + * urcu.h + * + * Userspace RCU header + * + * Copyright (c) 2009 Mathieu Desnoyers + * Copyright (c) 2009 Paul E. McKenney, IBM Corporation. + * + * LGPL-compatible code should include this header with : + * + * #define _LGPL_SOURCE + * #include + * + * 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. + */ + +#include +#include + +/* + * See urcu-pointer.h and urcu/static/urcu-pointer.h for pointer + * publication headers. + */ +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +/* + * Important ! + * + * 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. + */ + +#ifdef _LGPL_SOURCE + +#include + +/* + * Mappings for static use of the userspace RCU library. + * Should only be used in LGPL-compatible code. + */ + +/* + * 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 + +#else /* !_LGPL_SOURCE */ + +/* + * library wrappers to be used by non-LGPL compatible source code. + * See LGPL-only urcu/static/urcu-pointer.h for documentation. + */ + +extern void rcu_read_lock(void); +extern void rcu_read_unlock(void); +extern int rcu_read_ongoing(void); + +#endif /* !_LGPL_SOURCE */ + +extern void synchronize_rcu(void); + +/* + * Reader thread registration. + */ +extern void rcu_register_thread(void); +extern void rcu_unregister_thread(void); + +/* + * Explicit rcu initialization, for "early" use within library constructors. + */ +extern void rcu_init(void); + +/* + * Q.S. reporting are no-ops for these URCU flavors. + */ +static inline void rcu_quiescent_state(void) +{ +} + +static inline void rcu_thread_offline(void) +{ +} + +static inline void rcu_thread_online(void) +{ +} + +#ifdef __cplusplus +} +#endif + +#include +#include +#include + +#endif /* _URCU_H */