Fix static linking: fix symbol name namespaces

[urcu.git] / urcu / static / urcu-qsbr.h

diff --git a/urcu/static/urcu-qsbr.h b/urcu/static/urcu-qsbr.h
index 22908a45f95c6a6c77988ab73acd8baaa97e7f15..8b16a4abc4586783fd5a267126e43063050f58f6 100644 (file)
--- a/urcu/static/urcu-qsbr.h
+++ b/urcu/static/urcu-qsbr.h
@@ -6,8 +6,8 @@
  *
  * Userspace RCU QSBR header.
  *
- * TO BE INCLUDED ONLY IN LGPL-COMPATIBLE CODE. See urcu-qsbr.h for linking
- * dynamically with the userspace rcu QSBR library.
+ * 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.
@@ -68,43 +68,43 @@ extern "C" {
 #include <pthread.h>
 #include <unistd.h>
 
-#define YIELD_READ     (1 << 0)
-#define YIELD_WRITE    (1 << 1)
+#define RCU_YIELD_READ         (1 << 0)
+#define RCU_YIELD_WRITE        (1 << 1)
 
 /* maximum sleep delay, in us */
 #define MAX_SLEEP 50
 
-extern unsigned int yield_active;
-extern DECLARE_URCU_TLS(unsigned int, rand_yield);
+extern unsigned int rcu_yield_active;
+extern DECLARE_URCU_TLS(unsigned int, rcu_rand_yield);
 
-static inline void debug_yield_read(void)
+static inline void rcu_debug_yield_read(void)
 {
-       if (yield_active & YIELD_READ)
-               if (rand_r(&URCU_TLS(rand_yield)) & 0x1)
-                       usleep(rand_r(&URCU_TLS(rand_yield)) % MAX_SLEEP);
+       if (rcu_yield_active & RCU_YIELD_READ)
+               if (rand_r(&URCU_TLS(rcu_rand_yield)) & 0x1)
+                       usleep(rand_r(&URCU_TLS(rcu_rand_yield)) % MAX_SLEEP);
 }
 
-static inline void debug_yield_write(void)
+static inline void rcu_debug_yield_write(void)
 {
-       if (yield_active & YIELD_WRITE)
-               if (rand_r(&URCU_TLS(rand_yield)) & 0x1)
-                       usleep(rand_r(&URCU_TLS(rand_yield)) % MAX_SLEEP);
+       if (rcu_yield_active & RCU_YIELD_WRITE)
+               if (rand_r(&URCU_TLS(rcu_rand_yield)) & 0x1)
+                       usleep(rand_r(&URCU_TLS(rcu_rand_yield)) % MAX_SLEEP);
 }
 
-static inline void debug_yield_init(void)
+static inline void rcu_debug_yield_init(void)
 {
-       URCU_TLS(rand_yield) = time(NULL) ^ pthread_self();
+       URCU_TLS(rcu_rand_yield) = time(NULL) ^ pthread_self();
 }
 #else
-static inline void debug_yield_read(void)
+static inline void rcu_debug_yield_read(void)
 {
 }
 
-static inline void debug_yield_write(void)
+static inline void rcu_debug_yield_write(void)
 {
 }
 
-static inline void debug_yield_init(void)
+static inline void rcu_debug_yield_init(void)
 {
 
 }
@@ -131,7 +131,7 @@ struct rcu_reader {
 
 extern DECLARE_URCU_TLS(struct rcu_reader, rcu_reader);
 
-extern int32_t gp_futex;
+extern int32_t rcu_gp_futex;
 
 /*
  * Wake-up waiting synchronize_rcu(). Called from many concurrent threads.
@@ -141,10 +141,10 @@ static inline void wake_up_gp(void)
        if (caa_unlikely(_CMM_LOAD_SHARED(URCU_TLS(rcu_reader).waiting))) {
                _CMM_STORE_SHARED(URCU_TLS(rcu_reader).waiting, 0);
                cmm_smp_mb();
-               if (uatomic_read(&gp_futex) != -1)
+               if (uatomic_read(&rcu_gp_futex) != -1)
                        return;
-               uatomic_set(&gp_futex, 0);
-               futex_noasync(&gp_futex, FUTEX_WAKE, 1,
+               uatomic_set(&rcu_gp_futex, 0);
+               futex_noasync(&rcu_gp_futex, FUTEX_WAKE, 1,
                      NULL, NULL, 0);
        }
 }
@@ -157,15 +157,36 @@ static inline int rcu_gp_ongoing(unsigned long *ctr)
        return v && (v != rcu_gp_ctr);
 }
 
+/*
+ * Enter an RCU read-side critical section.
+ *
+ * This function is less than 10 lines long.  The intent is that this
+ * function meets the 10-line criterion for LGPL, allowing this function
+ * to be invoked directly from non-LGPL code.
+ */
 static inline void _rcu_read_lock(void)
 {
        rcu_assert(URCU_TLS(rcu_reader).ctr);
 }
 
+/*
+ * Exit an RCU read-side critical section.
+ *
+ * This function is less than 10 lines long.  The intent is that this
+ * function meets the 10-line criterion for LGPL, allowing this function
+ * to be invoked directly from non-LGPL code.
+ */
 static inline void _rcu_read_unlock(void)
 {
 }
 
+/*
+ * Inform RCU of a quiescent state.
+ *
+ * This function is less than 10 lines long.  The intent is that this
+ * function meets the 10-line criterion for LGPL, allowing this function
+ * to be invoked directly from non-LGPL code.
+ */
 static inline void _rcu_quiescent_state(void)
 {
        cmm_smp_mb();
@@ -175,6 +196,14 @@ static inline void _rcu_quiescent_state(void)
        cmm_smp_mb();
 }
 
+/*
+ * Take a thread offline, prohibiting it from entering further RCU
+ * read-side critical sections.
+ *
+ * This function is less than 10 lines long.  The intent is that this
+ * function meets the 10-line criterion for LGPL, allowing this function
+ * to be invoked directly from non-LGPL code.
+ */
 static inline void _rcu_thread_offline(void)
 {
        cmm_smp_mb();
@@ -184,6 +213,14 @@ static inline void _rcu_thread_offline(void)
        cmm_barrier();  /* Ensure the compiler does not reorder us with mutex */
 }
 
+/*
+ * Bring a thread online, allowing it to once again enter RCU
+ * read-side critical sections.
+ *
+ * This function is less than 10 lines long.  The intent is that this
+ * function meets the 10-line criterion for LGPL, allowing this function
+ * to be invoked directly from non-LGPL code.
+ */
 static inline void _rcu_thread_online(void)
 {
        cmm_barrier();  /* Ensure the compiler does not reorder us with mutex */