Use new header locations for includes from urcu code
authorMathieu Desnoyers <mathieu.desnoyers@efficios.com>
Fri, 30 Nov 2018 22:19:44 +0000 (17:19 -0500)
committerMathieu Desnoyers <mathieu.desnoyers@efficios.com>
Wed, 12 Dec 2018 15:18:49 +0000 (10:18 -0500)
This also moves urcu/static/urcu-pointer.h to urcu/static/pointer.h.
Considering that it is not meant to be included directly by library
users, it should not cause any problem.

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
12 files changed:
include/Makefile.am
include/urcu/pointer.h
include/urcu/static/pointer.h [new file with mode: 0644]
include/urcu/static/urcu-pointer.h [deleted file]
include/urcu/urcu-bp.h
include/urcu/urcu-mb.h
include/urcu/urcu-memb.h
include/urcu/urcu-qsbr.h
include/urcu/urcu-signal.h
src/rculfhash.c
src/urcu-pointer.c
src/workqueue.c

index a567f91..34812d4 100644 (file)
@@ -10,7 +10,7 @@ nobase_dist_include_HEADERS = urcu/compiler.h urcu/hlist.h urcu/list.h \
                urcu/map/urcu-signal.h \
                urcu/static/lfstack.h urcu/static/rculfqueue.h \
                urcu/static/rculfstack.h urcu/static/urcu-bp.h \
-               urcu/static/urcu.h urcu/static/urcu-pointer.h \
+               urcu/static/urcu.h urcu/static/pointer.h \
                urcu/static/urcu-qsbr.h urcu/static/wfcqueue.h \
                urcu/static/wfqueue.h urcu/static/wfstack.h \
                urcu/static/urcu-mb.h urcu/static/urcu-memb.h \
index dc1a0da..a670272 100644 (file)
@@ -2,7 +2,7 @@
 #define _URCU_POINTER_H
 
 /*
- * urcu-pointer.h
+ * urcu/pointer.h
  *
  * Userspace RCU header. Operations on pointers.
  *
@@ -36,7 +36,7 @@ extern "C" {
 
 #if defined(_LGPL_SOURCE) || defined(URCU_INLINE_SMALL_FUNCTIONS)
 
-#include <urcu/static/urcu-pointer.h>
+#include <urcu/static/pointer.h>
 
 /*
  * rcu_dereference(ptr)
diff --git a/include/urcu/static/pointer.h b/include/urcu/static/pointer.h
new file mode 100644 (file)
index 0000000..732f8c0
--- /dev/null
@@ -0,0 +1,146 @@
+#ifndef _URCU_POINTER_STATIC_H
+#define _URCU_POINTER_STATIC_H
+
+/*
+ * urcu/static/pointer.h
+ *
+ * Userspace RCU header. Operations on pointers.
+ *
+ * TO BE INCLUDED ONLY IN CODE THAT IS TO BE RECOMPILED ON EACH LIBURCU
+ * RELEASE. See urcu.h for linking dynamically with the userspace rcu library.
+ *
+ * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
+ *
+ * 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 <urcu/compiler.h>
+#include <urcu/arch.h>
+#include <urcu/system.h>
+#include <urcu/uatomic.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * _rcu_dereference - reads (copy) a RCU-protected pointer to a local variable
+ * into a RCU read-side critical section. The pointer can later be safely
+ * dereferenced within the critical section.
+ *
+ * This ensures that the pointer copy is invariant thorough the whole critical
+ * section.
+ *
+ * Inserts memory barriers on architectures that require them (currently only
+ * Alpha) and documents which pointers are protected by RCU.
+ *
+ * The compiler memory barrier in CMM_LOAD_SHARED() ensures that value-speculative
+ * optimizations (e.g. VSS: Value Speculation Scheduling) does not perform the
+ * data read before the pointer read by speculating the value of the pointer.
+ * Correct ordering is ensured because the pointer is read as a volatile access.
+ * This acts as a global side-effect operation, which forbids reordering of
+ * dependent memory operations. Note that such concern about dependency-breaking
+ * optimizations will eventually be taken care of by the "memory_order_consume"
+ * addition to forthcoming C++ standard.
+ *
+ * Should match rcu_assign_pointer() or rcu_xchg_pointer().
+ *
+ * This macro is less than 10 lines long.  The intent is that this macro
+ * meets the 10-line criterion in LGPL, allowing this function to be
+ * expanded directly in non-LGPL code.
+ */
+#define _rcu_dereference(p)                                            \
+                               __extension__                           \
+                               ({                                      \
+                               __typeof__(p) _________p1 = CMM_LOAD_SHARED(p); \
+                               cmm_smp_read_barrier_depends();         \
+                               (_________p1);                          \
+                               })
+
+/**
+ * _rcu_cmpxchg_pointer - same as rcu_assign_pointer, but tests if the pointer
+ * is as expected by "old". If succeeds, returns the previous pointer to the
+ * data structure, which can be safely freed after waiting for a quiescent state
+ * using synchronize_rcu(). If fails (unexpected value), returns old (which
+ * should not be freed !).
+ *
+ * uatomic_cmpxchg() acts as both release and acquire barriers.
+ *
+ * This macro is less than 10 lines long.  The intent is that this macro
+ * meets the 10-line criterion in LGPL, allowing this function to be
+ * expanded directly in non-LGPL code.
+ */
+#define _rcu_cmpxchg_pointer(p, old, _new)                             \
+       __extension__                                                   \
+       ({                                                              \
+               __typeof__(*p) _________pold = (old);                   \
+               __typeof__(*p) _________pnew = (_new);                  \
+               uatomic_cmpxchg(p, _________pold, _________pnew);       \
+       })
+
+/**
+ * _rcu_xchg_pointer - same as rcu_assign_pointer, but returns the previous
+ * pointer to the data structure, which can be safely freed after waiting for a
+ * quiescent state using synchronize_rcu().
+ *
+ * uatomic_xchg() acts as both release and acquire barriers.
+ *
+ * This macro is less than 10 lines long.  The intent is that this macro
+ * meets the 10-line criterion in LGPL, allowing this function to be
+ * expanded directly in non-LGPL code.
+ */
+#define _rcu_xchg_pointer(p, v)                                \
+       __extension__                                   \
+       ({                                              \
+               __typeof__(*p) _________pv = (v);       \
+               uatomic_xchg(p, _________pv);           \
+       })
+
+
+#define _rcu_set_pointer(p, v)                         \
+       do {                                            \
+               __typeof__(*p) _________pv = (v);       \
+               if (!__builtin_constant_p(v) ||         \
+                   ((v) != NULL))                      \
+                       cmm_wmb();                              \
+               uatomic_set(p, _________pv);            \
+       } while (0)
+
+/**
+ * _rcu_assign_pointer - assign (publicize) a pointer to a new data structure
+ * meant to be read by RCU read-side critical sections. Returns the assigned
+ * value.
+ *
+ * Documents which pointers will be dereferenced by RCU read-side critical
+ * sections and adds the required memory barriers on architectures requiring
+ * them. It also makes sure the compiler does not reorder code initializing the
+ * data structure before its publication.
+ *
+ * Should match rcu_dereference().
+ *
+ * This macro is less than 10 lines long.  The intent is that this macro
+ * meets the 10-line criterion in LGPL, allowing this function to be
+ * expanded directly in non-LGPL code.
+ */
+#define _rcu_assign_pointer(p, v)      _rcu_set_pointer(&(p), v)
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _URCU_POINTER_STATIC_H */
diff --git a/include/urcu/static/urcu-pointer.h b/include/urcu/static/urcu-pointer.h
deleted file mode 100644 (file)
index 6e120fc..0000000
+++ /dev/null
@@ -1,146 +0,0 @@
-#ifndef _URCU_POINTER_STATIC_H
-#define _URCU_POINTER_STATIC_H
-
-/*
- * urcu-pointer-static.h
- *
- * Userspace RCU header. Operations on pointers.
- *
- * TO BE INCLUDED ONLY IN CODE THAT IS TO BE RECOMPILED ON EACH LIBURCU
- * RELEASE. See urcu.h for linking dynamically with the userspace rcu library.
- *
- * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
- * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
- *
- * 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 <urcu/compiler.h>
-#include <urcu/arch.h>
-#include <urcu/system.h>
-#include <urcu/uatomic.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- * _rcu_dereference - reads (copy) a RCU-protected pointer to a local variable
- * into a RCU read-side critical section. The pointer can later be safely
- * dereferenced within the critical section.
- *
- * This ensures that the pointer copy is invariant thorough the whole critical
- * section.
- *
- * Inserts memory barriers on architectures that require them (currently only
- * Alpha) and documents which pointers are protected by RCU.
- *
- * The compiler memory barrier in CMM_LOAD_SHARED() ensures that value-speculative
- * optimizations (e.g. VSS: Value Speculation Scheduling) does not perform the
- * data read before the pointer read by speculating the value of the pointer.
- * Correct ordering is ensured because the pointer is read as a volatile access.
- * This acts as a global side-effect operation, which forbids reordering of
- * dependent memory operations. Note that such concern about dependency-breaking
- * optimizations will eventually be taken care of by the "memory_order_consume"
- * addition to forthcoming C++ standard.
- *
- * Should match rcu_assign_pointer() or rcu_xchg_pointer().
- *
- * This macro is less than 10 lines long.  The intent is that this macro
- * meets the 10-line criterion in LGPL, allowing this function to be
- * expanded directly in non-LGPL code.
- */
-#define _rcu_dereference(p)                                            \
-                               __extension__                           \
-                               ({                                      \
-                               __typeof__(p) _________p1 = CMM_LOAD_SHARED(p); \
-                               cmm_smp_read_barrier_depends();         \
-                               (_________p1);                          \
-                               })
-
-/**
- * _rcu_cmpxchg_pointer - same as rcu_assign_pointer, but tests if the pointer
- * is as expected by "old". If succeeds, returns the previous pointer to the
- * data structure, which can be safely freed after waiting for a quiescent state
- * using synchronize_rcu(). If fails (unexpected value), returns old (which
- * should not be freed !).
- *
- * uatomic_cmpxchg() acts as both release and acquire barriers.
- *
- * This macro is less than 10 lines long.  The intent is that this macro
- * meets the 10-line criterion in LGPL, allowing this function to be
- * expanded directly in non-LGPL code.
- */
-#define _rcu_cmpxchg_pointer(p, old, _new)                             \
-       __extension__                                                   \
-       ({                                                              \
-               __typeof__(*p) _________pold = (old);                   \
-               __typeof__(*p) _________pnew = (_new);                  \
-               uatomic_cmpxchg(p, _________pold, _________pnew);       \
-       })
-
-/**
- * _rcu_xchg_pointer - same as rcu_assign_pointer, but returns the previous
- * pointer to the data structure, which can be safely freed after waiting for a
- * quiescent state using synchronize_rcu().
- *
- * uatomic_xchg() acts as both release and acquire barriers.
- *
- * This macro is less than 10 lines long.  The intent is that this macro
- * meets the 10-line criterion in LGPL, allowing this function to be
- * expanded directly in non-LGPL code.
- */
-#define _rcu_xchg_pointer(p, v)                                \
-       __extension__                                   \
-       ({                                              \
-               __typeof__(*p) _________pv = (v);       \
-               uatomic_xchg(p, _________pv);           \
-       })
-
-
-#define _rcu_set_pointer(p, v)                         \
-       do {                                            \
-               __typeof__(*p) _________pv = (v);       \
-               if (!__builtin_constant_p(v) ||         \
-                   ((v) != NULL))                      \
-                       cmm_wmb();                              \
-               uatomic_set(p, _________pv);            \
-       } while (0)
-
-/**
- * _rcu_assign_pointer - assign (publicize) a pointer to a new data structure
- * meant to be read by RCU read-side critical sections. Returns the assigned
- * value.
- *
- * Documents which pointers will be dereferenced by RCU read-side critical
- * sections and adds the required memory barriers on architectures requiring
- * them. It also makes sure the compiler does not reorder code initializing the
- * data structure before its publication.
- *
- * Should match rcu_dereference().
- *
- * This macro is less than 10 lines long.  The intent is that this macro
- * meets the 10-line criterion in LGPL, allowing this function to be
- * expanded directly in non-LGPL code.
- */
-#define _rcu_assign_pointer(p, v)      _rcu_set_pointer(&(p), v)
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* _URCU_POINTER_STATIC_H */
index 7b00aaa..d3d122d 100644 (file)
@@ -52,10 +52,10 @@ extern "C" {
  */
 
 /*
- * See urcu-pointer.h and urcu/static/urcu-pointer.h for pointer
+ * See urcu/pointer.h and urcu/static/pointer.h for pointer
  * publication headers.
  */
-#include <urcu-pointer.h>
+#include <urcu/pointer.h>
 
 #ifdef _LGPL_SOURCE
 
@@ -85,7 +85,7 @@ extern "C" {
 
 /*
  * library wrappers to be used by non-LGPL compatible source code.
- * See LGPL-only urcu/static/urcu-pointer.h for documentation.
+ * See LGPL-only urcu/static/pointer.h for documentation.
  */
 
 extern void urcu_bp_read_lock(void);
@@ -184,9 +184,9 @@ static inline void urcu_bp_thread_online(void)
 }
 #endif
 
-#include <urcu-call-rcu.h>
-#include <urcu-defer.h>
-#include <urcu-flavor.h>
+#include <urcu/call-rcu.h>
+#include <urcu/defer.h>
+#include <urcu/flavor.h>
 
 #ifndef URCU_API_MAP
 #include <urcu/map/clear.h>
index 2000375..ab485f1 100644 (file)
 #include <pthread.h>
 
 /*
- * See urcu-pointer.h and urcu/static/urcu-pointer.h for pointer
+ * See urcu/pointer.h and urcu/static/pointer.h for pointer
  * publication headers.
  */
-#include <urcu-pointer.h>
+#include <urcu/pointer.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -79,7 +79,7 @@ extern "C" {
 
 /*
  * library wrappers to be used by non-LGPL compatible source code.
- * See LGPL-only urcu/static/urcu-pointer.h for documentation.
+ * See LGPL-only urcu/static/pointer.h for documentation.
  */
 
 extern void urcu_mb_read_lock(void);
@@ -120,9 +120,9 @@ static inline void urcu_mb_thread_online(void)
 }
 #endif
 
-#include <urcu-call-rcu.h>
-#include <urcu-defer.h>
-#include <urcu-flavor.h>
+#include <urcu/call-rcu.h>
+#include <urcu/defer.h>
+#include <urcu/flavor.h>
 
 #ifndef URCU_API_MAP
 #include <urcu/map/clear.h>
index c0fffe8..c11c93e 100644 (file)
 #include <pthread.h>
 
 /*
- * See urcu-pointer.h and urcu/static/urcu-pointer.h for pointer
+ * See urcu/pointer.h and urcu/static/pointer.h for pointer
  * publication headers.
  */
-#include <urcu-pointer.h>
+#include <urcu/pointer.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -79,7 +79,7 @@ extern "C" {
 
 /*
  * library wrappers to be used by non-LGPL compatible source code.
- * See LGPL-only urcu/static/urcu-pointer.h for documentation.
+ * See LGPL-only urcu/static/pointer.h for documentation.
  */
 
 extern void urcu_memb_read_lock(void);
@@ -120,9 +120,9 @@ static inline void urcu_memb_thread_online(void)
 }
 #endif
 
-#include <urcu-call-rcu.h>
-#include <urcu-defer.h>
-#include <urcu-flavor.h>
+#include <urcu/call-rcu.h>
+#include <urcu/defer.h>
+#include <urcu/flavor.h>
 
 #ifndef URCU_API_MAP
 #include <urcu/map/clear.h>
index 041db21..28e6065 100644 (file)
 #include <pthread.h>
 
 /*
- * See urcu-pointer.h and urcu/static/urcu-pointer.h for pointer
+ * See urcu/pointer.h and urcu/static/pointer.h for pointer
  * publication headers.
  */
-#include <urcu-pointer.h>
+#include <urcu/pointer.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -133,9 +133,9 @@ extern void urcu_qsbr_unregister_thread(void);
 }
 #endif
 
-#include <urcu-call-rcu.h>
-#include <urcu-defer.h>
-#include <urcu-flavor.h>
+#include <urcu/call-rcu.h>
+#include <urcu/defer.h>
+#include <urcu/flavor.h>
 
 #ifndef URCU_API_MAP
 #include <urcu/map/clear.h>
index 8c36450..59c5d01 100644 (file)
 #include <pthread.h>
 
 /*
- * See urcu-pointer.h and urcu/static/urcu-pointer.h for pointer
+ * See urcu/pointer.h and urcu/static/pointer.h for pointer
  * publication headers.
  */
-#include <urcu-pointer.h>
+#include <urcu/pointer.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -79,7 +79,7 @@ extern "C" {
 
 /*
  * library wrappers to be used by non-LGPL compatible source code.
- * See LGPL-only urcu/static/urcu-pointer.h for documentation.
+ * See LGPL-only urcu/static/pointer.h for documentation.
  */
 
 extern void urcu_signal_read_lock(void);
@@ -120,9 +120,9 @@ static inline void urcu_signal_thread_online(void)
 }
 #endif
 
-#include <urcu-call-rcu.h>
-#include <urcu-defer.h>
-#include <urcu-flavor.h>
+#include <urcu/call-rcu.h>
+#include <urcu/defer.h>
+#include <urcu/flavor.h>
 
 #ifndef URCU_API_MAP
 #include <urcu/map/clear.h>
index fed33e4..b63a0a6 100644 (file)
 #include <unistd.h>
 
 #include "compat-getcpu.h"
-#include <urcu-pointer.h>
-#include <urcu-call-rcu.h>
-#include <urcu-flavor.h>
+#include <urcu/pointer.h>
+#include <urcu/call-rcu.h>
+#include <urcu/flavor.h>
 #include <urcu/arch.h>
 #include <urcu/uatomic.h>
 #include <urcu/compiler.h>
index 61e35da..d0854ac 100644 (file)
@@ -26,9 +26,9 @@
 
 #include <urcu/uatomic.h>
 
-#include "urcu/static/urcu-pointer.h"
+#include <urcu/static/pointer.h>
 /* Do not #define _LGPL_SOURCE to ensure we can emit the wrapper symbols */
-#include "urcu-pointer.h"
+#include <urcu/pointer.h>
 
 extern void synchronize_rcu(void);
 
index 14957a0..59eb21d 100644 (file)
 #include <sched.h>
 
 #include "compat-getcpu.h"
-#include "urcu/wfcqueue.h"
-#include "urcu-pointer.h"
-#include "urcu/list.h"
-#include "urcu/futex.h"
-#include "urcu/tls-compat.h"
-#include "urcu/ref.h"
+#include <urcu/wfcqueue.h>
+#include <urcu/pointer.h>
+#include <urcu/list.h>
+#include <urcu/futex.h>
+#include <urcu/tls-compat.h>
+#include <urcu/ref.h>
 #include "urcu-die.h"
 
 #include "workqueue.h"
This page took 0.065853 seconds and 4 git commands to generate.