urcu-pointer: create specific objects and headers to deal with RCU pointers

[urcu.git] / urcu.h

diff --git a/urcu.h b/urcu.h
index a0aac2195feea64a90043866950cfe0322eb0df7..69c06e409ddaf2bb95d96d27ae6d9369b777d40b 100644 (file)
--- a/urcu.h
+++ b/urcu.h
@@ -34,6 +34,11 @@
 #include <stdlib.h>
 #include <pthread.h>
 
+/*
+ * See urcu-pointer.h and urcu-pointer-static.h for pointer publication headers.
+ */
+#include <urcu-pointer.h>
+
 /*
  * Important !
  *
@@ -51,43 +56,27 @@
  * 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_cmpxchg_pointer    _rcu_cmpxchg_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_cmpxchg_pointer_sym(void **p, void *old, void *_new);
-#define rcu_cmpxchg_pointer(p, old, _new)              \
-       rcu_cmpxchg_pointer_sym((void **)(p), (old), (_new))
-
-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);