*
* Userspace RCU header
*
- * Copyright February 2009 - Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
- *
- * Credits for Paul E. McKenney <paulmck@linux.vnet.ibm.com>
- * for inspiration coming from the Linux kernel RCU and rcu-preempt.
+ * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
+ * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
*
* LGPL-compatible code should include this header with :
*
* #define _LGPL_SOURCE
* #include <urcu.h>
*
- * Distributed under LGPLv2.1
+ * 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 <stdlib.h>
#include <pthread.h>
+/*
+ * See urcu-pointer.h and urcu-pointer-static.h for pointer publication headers.
+ */
+#include <urcu-pointer.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*
+ * Important !
+ *
+ * Each thread containing read-side critical sections must be registered
+ * with rcu_register_thread() before calling rcu_read_lock().
+ * rcu_unregister_thread() should be called before the thread exits.
+ */
+
#ifdef _LGPL_SOURCE
#include <urcu-static.h>
* Should only be used in LGPL-compatible code.
*/
-#define rcu_dereference _rcu_dereference
-#define rcu_read_lock _rcu_read_lock
-#define rcu_read_unlock _rcu_read_unlock
-
-#define rcu_assign_pointer _rcu_assign_pointer
-#define rcu_xchg_pointer _rcu_xchg_pointer
-#define rcu_publish_content _rcu_publish_content
+/*
+ * 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.
+ */
+#define rcu_read_lock() _rcu_read_lock()
+#define rcu_read_unlock() _rcu_read_unlock()
#else /* !_LGPL_SOURCE */
/*
* library wrappers to be used by non-LGPL compatible source code.
+ * See LGPL-only urcu-pointer-static.h for documentation.
*/
extern void rcu_read_lock(void);
extern void rcu_read_unlock(void);
-extern void *rcu_dereference(void *p);
-
-extern void *rcu_assign_pointer_sym(void **p, void *v);
-
-#define rcu_assign_pointer(p, v) \
- rcu_assign_pointer_sym((void **)(p), (v))
-
-extern void *rcu_xchg_pointer_sym(void **p, void *v);
-#define rcu_xchg_pointer(p, v) \
- rcu_xchg_pointer_sym((void **)(p), (v))
-
-extern void *rcu_publish_content_sym(void **p, void *v);
-#define rcu_publish_content(p, v) \
- rcu_publish_content_sym((void **)(p), (v))
-
#endif /* !_LGPL_SOURCE */
extern void synchronize_rcu(void);
extern void rcu_register_thread(void);
extern void rcu_unregister_thread(void);
+/*
+ * Explicit urcu initialization, for "early" use within library constructors.
+ */
+extern void urcu_init(void);
+
+#ifdef __cplusplus
+}
+#endif
+
#endif /* _URCU_H */