urcu/annotate: Add CMM annotation

[urcu.git] / include / urcu / static / urcu-memb.h

diff --git a/include/urcu/static/urcu-memb.h b/include/urcu/static/urcu-memb.h
index d30365a49f027ae09fc6c209d791a6196ce82d5b..b9178c879e1ac282a00cf9958a91d3f489d22bbe 100644 (file)
--- a/include/urcu/static/urcu-memb.h
+++ b/include/urcu/static/urcu-memb.h
@@ -1,31 +1,17 @@
+// SPDX-FileCopyrightText: 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+// SPDX-FileCopyrightText: 2009 Paul E. McKenney, IBM Corporation.
+//
+// SPDX-License-Identifier: LGPL-2.1-or-later
+
 #ifndef _URCU_MEMB_STATIC_H
 #define _URCU_MEMB_STATIC_H
 
 /*
- * urcu-memb-static.h
- *
  * Userspace RCU header.
  *
  * 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.
  */
 
@@ -34,6 +20,8 @@
 #include <unistd.h>
 #include <stdint.h>
 
+#include <urcu/annotate.h>
+#include <urcu/debug.h>
 #include <urcu/config.h>
 #include <urcu/compiler.h>
 #include <urcu/arch.h>
@@ -42,7 +30,6 @@
 #include <urcu/list.h>
 #include <urcu/futex.h>
 #include <urcu/tls-compat.h>
-#include <urcu/debug.h>
 #include <urcu/static/urcu-common.h>
 
 #ifdef __cplusplus
@@ -86,18 +73,27 @@ extern DECLARE_URCU_TLS(struct urcu_reader, urcu_memb_reader);
 
 /*
  * Helper for _rcu_read_lock().  The format of urcu_memb_gp.ctr (as well as
- * the per-thread rcu_reader.ctr) has the upper bits containing a count of
- * _rcu_read_lock() nesting, and a lower-order bit that contains either zero
- * or URCU_GP_CTR_PHASE.  The smp_mb_slave() ensures that the accesses in
+ * the per-thread rcu_reader.ctr) has the lower-order bits containing a count of
+ * _rcu_read_lock() nesting, and a single high-order URCU_BP_GP_CTR_PHASE bit
+ * that contains either zero or one.  The smp_mb_slave() ensures that the accesses in
  * _rcu_read_lock() happen before the subsequent read-side critical section.
  */
 static inline void _urcu_memb_read_lock_update(unsigned long tmp)
 {
+       unsigned long *ctr = &URCU_TLS(urcu_memb_reader).ctr;
+
        if (caa_likely(!(tmp & URCU_GP_CTR_NEST_MASK))) {
-               _CMM_STORE_SHARED(URCU_TLS(urcu_memb_reader).ctr, _CMM_LOAD_SHARED(urcu_memb_gp.ctr));
+               unsigned long *pgctr = &urcu_memb_gp.ctr;
+               unsigned long gctr = uatomic_load(pgctr, CMM_RELAXED);
+
+               /* Paired with following mb slave. */
+               cmm_annotate_mem_acquire(pgctr);
+               uatomic_store(ctr, gctr, CMM_RELAXED);
+
                urcu_memb_smp_mb_slave();
-       } else
-               _CMM_STORE_SHARED(URCU_TLS(urcu_memb_reader).ctr, tmp + URCU_GP_COUNT);
+       } else {
+               uatomic_store(ctr, tmp + URCU_GP_COUNT, CMM_RELAXED);
+       }
 }
 
 /*
@@ -114,10 +110,10 @@ static inline void _urcu_memb_read_lock(void)
 {
        unsigned long tmp;
 
-       urcu_assert(URCU_TLS(urcu_memb_reader).registered);
+       urcu_assert_debug(URCU_TLS(urcu_memb_reader).registered);
        cmm_barrier();
        tmp = URCU_TLS(urcu_memb_reader).ctr;
-       urcu_assert((tmp & URCU_GP_CTR_NEST_MASK) != URCU_GP_CTR_NEST_MASK);
+       urcu_assert_debug((tmp & URCU_GP_CTR_NEST_MASK) != URCU_GP_CTR_NEST_MASK);
        _urcu_memb_read_lock_update(tmp);
 }
 
@@ -131,13 +127,17 @@ static inline void _urcu_memb_read_lock(void)
  */
 static inline void _urcu_memb_read_unlock_update_and_wakeup(unsigned long tmp)
 {
+       unsigned long *ctr = &URCU_TLS(urcu_memb_reader).ctr;
+
        if (caa_likely((tmp & URCU_GP_CTR_NEST_MASK) == URCU_GP_COUNT)) {
                urcu_memb_smp_mb_slave();
-               _CMM_STORE_SHARED(URCU_TLS(urcu_memb_reader).ctr, tmp - URCU_GP_COUNT);
+               cmm_annotate_mem_release(ctr);
+               uatomic_store(ctr, tmp - URCU_GP_COUNT, CMM_RELAXED);
                urcu_memb_smp_mb_slave();
                urcu_common_wake_up_gp(&urcu_memb_gp);
-       } else
-               _CMM_STORE_SHARED(URCU_TLS(urcu_memb_reader).ctr, tmp - URCU_GP_COUNT);
+       } else {
+               uatomic_store(ctr, tmp - URCU_GP_COUNT, CMM_RELAXED);
+       }
 }
 
 /*
@@ -149,9 +149,9 @@ static inline void _urcu_memb_read_unlock(void)
 {
        unsigned long tmp;
 
-       urcu_assert(URCU_TLS(urcu_memb_reader).registered);
+       urcu_assert_debug(URCU_TLS(urcu_memb_reader).registered);
        tmp = URCU_TLS(urcu_memb_reader).ctr;
-       urcu_assert(tmp & URCU_GP_CTR_NEST_MASK);
+       urcu_assert_debug(tmp & URCU_GP_CTR_NEST_MASK);
        _urcu_memb_read_unlock_update_and_wakeup(tmp);
        cmm_barrier();  /* Ensure the compiler does not reorder us with mutex */
 }