urcu/annotate: Add CMM annotation
[userspace-rcu.git] / src / urcu.c
index c36119aeb466673c03c810dc2ea372eea568f10f..76c8720c288b5d5ce52eacdd58714126513645c4 100644 (file)
@@ -1,35 +1,21 @@
+// 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
+
 /*
- * urcu.c
- *
  * 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.
  */
 
+#define URCU_NO_COMPAT_IDENTIFIERS
 #define _BSD_SOURCE
 #define _LGPL_SOURCE
 #define _DEFAULT_SOURCE
 #include <stdio.h>
 #include <pthread.h>
 #include <signal.h>
-#include <assert.h>
 #include <stdlib.h>
 #include <stdint.h>
 #include <string.h>
@@ -37,6 +23,9 @@
 #include <stdbool.h>
 #include <poll.h>
 
+#include <urcu/config.h>
+#include <urcu/annotate.h>
+#include <urcu/assert.h>
 #include <urcu/arch.h>
 #include <urcu/wfcqueue.h>
 #include <urcu/map/urcu.h>
@@ -92,8 +81,6 @@ static int urcu_memb_has_sys_membarrier_private_expedited;
  * uninitialized variable.
  */
 int urcu_memb_has_sys_membarrier = 0;
-__attribute__((alias("urcu_memb_has_sys_membarrier")))
-extern int rcu_has_sys_membarrier_memb;
 #endif
 
 void __attribute__((constructor)) rcu_init(void);
@@ -103,17 +90,19 @@ void __attribute__((constructor)) rcu_init(void);
 void rcu_init(void)
 {
 }
-__attribute__((alias(urcu_stringify(rcu_init))))
-void alias_rcu_init(void);
 #endif
 
 #ifdef RCU_SIGNAL
 static int init_done;
 
 void __attribute__((constructor)) rcu_init(void);
-void __attribute__((destructor)) rcu_exit(void);
+
+static DEFINE_URCU_TLS(int, rcu_signal_was_blocked);
 #endif
 
+void __attribute__((destructor)) rcu_exit(void);
+static void urcu_call_rcu_exit(void);
+
 /*
  * rcu_gp_lock ensures mutual exclusion between threads calling
  * synchronize_rcu().
@@ -130,16 +119,12 @@ static pthread_mutex_t rcu_gp_lock = PTHREAD_MUTEX_INITIALIZER;
  */
 static pthread_mutex_t rcu_registry_lock = PTHREAD_MUTEX_INITIALIZER;
 struct urcu_gp rcu_gp = { .ctr = URCU_GP_COUNT };
-__attribute__((alias(urcu_stringify(rcu_gp))))
-extern struct urcu_gp alias_rcu_gp;
 
 /*
  * Written to only by each individual reader. Read by both the reader and the
  * writers.
  */
 DEFINE_URCU_TLS(struct urcu_reader, rcu_reader);
-__attribute__((alias(urcu_stringify(rcu_reader))))
-extern struct urcu_reader alias_rcu_reader;
 
 static CDS_LIST_HEAD(registry);
 
@@ -265,17 +250,25 @@ static void wait_gp(void)
        smp_mb_master();
        /* Temporarily unlock the registry lock. */
        mutex_unlock(&rcu_registry_lock);
-       if (uatomic_read(&rcu_gp.futex) != -1)
-               goto end;
-       while (futex_async(&rcu_gp.futex, FUTEX_WAIT, -1,
-                       NULL, NULL, 0)) {
+       while (uatomic_read(&rcu_gp.futex) == -1) {
+               if (!futex_async(&rcu_gp.futex, FUTEX_WAIT, -1, NULL, NULL, 0)) {
+                       /*
+                        * Prior queued wakeups queued by unrelated code
+                        * using the same address can cause futex wait to
+                        * return 0 even through the futex value is still
+                        * -1 (spurious wakeups). Check the value again
+                        * in user-space to validate whether it really
+                        * differs from -1.
+                        */
+                       continue;
+               }
                switch (errno) {
-               case EWOULDBLOCK:
+               case EAGAIN:
                        /* Value already changed. */
                        goto end;
                case EINTR:
                        /* Retry if interrupted by signal. */
-                       break;  /* Get out of switch. */
+                       break;  /* Get out of switch. Check again. */
                default:
                        /* Unexpected error. */
                        urcu_die(errno);
@@ -294,7 +287,8 @@ end:
  */
 static void wait_for_readers(struct cds_list_head *input_readers,
                        struct cds_list_head *cur_snap_readers,
-                       struct cds_list_head *qsreaders)
+                       struct cds_list_head *qsreaders,
+                       cmm_annotate_t *group)
 {
        unsigned int wait_loops = 0;
        struct urcu_reader *index, *tmp;
@@ -317,7 +311,7 @@ static void wait_for_readers(struct cds_list_head *input_readers,
                }
 
                cds_list_for_each_entry_safe(index, tmp, input_readers, node) {
-                       switch (urcu_common_reader_state(&rcu_gp, &index->ctr)) {
+                       switch (urcu_common_reader_state(&rcu_gp, &index->ctr, group)) {
                        case URCU_READER_ACTIVE_CURRENT:
                                if (cur_snap_readers) {
                                        cds_list_move(&index->node,
@@ -401,6 +395,8 @@ static void wait_for_readers(struct cds_list_head *input_readers,
 
 void synchronize_rcu(void)
 {
+       cmm_annotate_define(acquire_group);
+       cmm_annotate_define(release_group);
        CDS_LIST_HEAD(cur_snap_readers);
        CDS_LIST_HEAD(qsreaders);
        DEFINE_URCU_WAIT_NODE(wait, URCU_WAIT_WAITING);
@@ -415,10 +411,11 @@ void synchronize_rcu(void)
         * queue before their insertion into the wait queue.
         */
        if (urcu_wait_add(&gp_waiters, &wait) != 0) {
-               /* Not first in queue: will be awakened by another thread. */
+               /*
+                * Not first in queue: will be awakened by another thread.
+                * Implies a memory barrier after grace period.
+                */
                urcu_adaptative_busy_wait(&wait);
-               /* Order following memory accesses after grace period. */
-               cmm_smp_mb();
                return;
        }
        /* We won't need to wake ourself up */
@@ -443,13 +440,14 @@ void synchronize_rcu(void)
         */
        /* Write new ptr before changing the qparity */
        smp_mb_master();
+       cmm_annotate_group_mb_release(&release_group);
 
        /*
         * Wait for readers to observe original parity or be quiescent.
         * wait_for_readers() can release and grab again rcu_registry_lock
-        * interally.
+        * internally.
         */
-       wait_for_readers(&registry, &cur_snap_readers, &qsreaders);
+       wait_for_readers(&registry, &cur_snap_readers, &qsreaders, &acquire_group);
 
        /*
         * Must finish waiting for quiescent state for original parity before
@@ -468,7 +466,8 @@ void synchronize_rcu(void)
        cmm_smp_mb();
 
        /* Switch parity: 0 -> 1, 1 -> 0 */
-       CMM_STORE_SHARED(rcu_gp.ctr, rcu_gp.ctr ^ URCU_GP_CTR_PHASE);
+       cmm_annotate_group_mem_release(&release_group, &rcu_gp.ctr);
+       uatomic_store(&rcu_gp.ctr, rcu_gp.ctr ^ URCU_GP_CTR_PHASE, CMM_RELAXED);
 
        /*
         * Must commit rcu_gp.ctr update to memory before waiting for quiescent
@@ -489,9 +488,9 @@ void synchronize_rcu(void)
        /*
         * Wait for readers to observe new parity or be quiescent.
         * wait_for_readers() can release and grab again rcu_registry_lock
-        * interally.
+        * internally.
         */
-       wait_for_readers(&cur_snap_readers, NULL, &qsreaders);
+       wait_for_readers(&cur_snap_readers, NULL, &qsreaders, &acquire_group);
 
        /*
         * Put quiescent reader list back into registry.
@@ -504,6 +503,7 @@ void synchronize_rcu(void)
         * iterates on reader threads.
         */
        smp_mb_master();
+       cmm_annotate_group_mb_acquire(&acquire_group);
 out:
        mutex_unlock(&rcu_registry_lock);
        mutex_unlock(&rcu_gp_lock);
@@ -515,8 +515,6 @@ out:
         */
        urcu_wake_all_waiters(&waiters);
 }
-__attribute__((alias(urcu_stringify(synchronize_rcu))))
-void alias_synchronize_rcu();
 
 /*
  * library wrappers to be used by non-LGPL compatible source code.
@@ -526,49 +524,85 @@ void rcu_read_lock(void)
 {
        _rcu_read_lock();
 }
-__attribute__((alias(urcu_stringify(rcu_read_lock))))
-void alias_rcu_read_lock();
 
 void rcu_read_unlock(void)
 {
        _rcu_read_unlock();
 }
-__attribute__((alias(urcu_stringify(rcu_read_unlock))))
-void alias_rcu_read_unlock();
 
 int rcu_read_ongoing(void)
 {
        return _rcu_read_ongoing();
 }
-__attribute__((alias(urcu_stringify(rcu_read_ongoing))))
-void alias_rcu_read_ongoing();
+
+#ifdef RCU_SIGNAL
+/*
+ * Make sure the signal used by the urcu-signal flavor is unblocked
+ * while the thread is registered.
+ */
+static
+void urcu_signal_unblock(void)
+{
+       sigset_t mask, oldmask;
+       int ret;
+
+       ret = sigemptyset(&mask);
+       urcu_posix_assert(!ret);
+       ret = sigaddset(&mask, SIGRCU);
+       urcu_posix_assert(!ret);
+       ret = pthread_sigmask(SIG_UNBLOCK, &mask, &oldmask);
+       urcu_posix_assert(!ret);
+       URCU_TLS(rcu_signal_was_blocked) = sigismember(&oldmask, SIGRCU);
+}
+
+static
+void urcu_signal_restore(void)
+{
+       sigset_t mask;
+       int ret;
+
+       if (!URCU_TLS(rcu_signal_was_blocked))
+               return;
+       ret = sigemptyset(&mask);
+       urcu_posix_assert(!ret);
+       ret = sigaddset(&mask, SIGRCU);
+       urcu_posix_assert(!ret);
+       ret = pthread_sigmask(SIG_BLOCK, &mask, NULL);
+       urcu_posix_assert(!ret);
+}
+#else
+static
+void urcu_signal_unblock(void) { }
+static
+void urcu_signal_restore(void) { }
+#endif
 
 void rcu_register_thread(void)
 {
+       urcu_signal_unblock();
+
        URCU_TLS(rcu_reader).tid = pthread_self();
-       assert(URCU_TLS(rcu_reader).need_mb == 0);
-       assert(!(URCU_TLS(rcu_reader).ctr & URCU_GP_CTR_NEST_MASK));
+       urcu_posix_assert(URCU_TLS(rcu_reader).need_mb == 0);
+       urcu_posix_assert(!(URCU_TLS(rcu_reader).ctr & URCU_GP_CTR_NEST_MASK));
 
        mutex_lock(&rcu_registry_lock);
-       assert(!URCU_TLS(rcu_reader).registered);
+       urcu_posix_assert(!URCU_TLS(rcu_reader).registered);
        URCU_TLS(rcu_reader).registered = 1;
        rcu_init();     /* In case gcc does not support constructor attribute */
        cds_list_add(&URCU_TLS(rcu_reader).node, &registry);
        mutex_unlock(&rcu_registry_lock);
 }
-__attribute__((alias(urcu_stringify(rcu_register_thread))))
-void alias_rcu_register_thread();
 
 void rcu_unregister_thread(void)
 {
        mutex_lock(&rcu_registry_lock);
-       assert(URCU_TLS(rcu_reader).registered);
+       urcu_posix_assert(URCU_TLS(rcu_reader).registered);
        URCU_TLS(rcu_reader).registered = 0;
        cds_list_del(&URCU_TLS(rcu_reader).node);
        mutex_unlock(&rcu_registry_lock);
+
+       urcu_signal_restore();
 }
-__attribute__((alias(urcu_stringify(rcu_unregister_thread))))
-void alias_rcu_unregister_thread();
 
 #ifdef RCU_MEMBARRIER
 
@@ -616,12 +650,12 @@ void rcu_init(void)
        init_done = 1;
        rcu_sys_membarrier_init();
 }
-__attribute__((alias(urcu_stringify(rcu_init))))
-void alias_rcu_init(void);
 #endif
 
 #ifdef RCU_SIGNAL
-static void sigrcu_handler(int signo, siginfo_t *siginfo, void *context)
+static void sigrcu_handler(int signo __attribute__((unused)),
+               siginfo_t *siginfo __attribute__((unused)),
+               void *context __attribute__((unused)))
 {
        /*
         * Executing this cmm_smp_mb() is the only purpose of this signal handler.
@@ -657,27 +691,25 @@ void rcu_init(void)
        if (ret)
                urcu_die(errno);
 }
-__attribute__((alias(urcu_stringify(rcu_init))))
-void alias_rcu_init(void);
+
+/*
+ * Don't unregister the SIGRCU signal handler anymore, because
+ * call_rcu threads could still be using it shortly before the
+ * application exits.
+ * Assertion disabled because call_rcu threads are now rcu
+ * readers, and left running at exit.
+ * urcu_posix_assert(cds_list_empty(&registry));
+ */
+
+#endif /* #ifdef RCU_SIGNAL */
 
 void rcu_exit(void)
 {
-       /*
-        * Don't unregister the SIGRCU signal handler anymore, because
-        * call_rcu threads could still be using it shortly before the
-        * application exits.
-        * Assertion disabled because call_rcu threads are now rcu
-        * readers, and left running at exit.
-        * assert(cds_list_empty(&registry));
-        */
+       urcu_call_rcu_exit();
 }
-__attribute__((alias(urcu_stringify(rcu_exit))))
-void alias_rcu_exit(void);
-
-#endif /* #ifdef RCU_SIGNAL */
 
 DEFINE_RCU_FLAVOR(rcu_flavor);
-DEFINE_RCU_FLAVOR_ALIAS(rcu_flavor, alias_rcu_flavor);
 
 #include "urcu-call-rcu-impl.h"
 #include "urcu-defer-impl.h"
+#include "urcu-poll-impl.h"
This page took 0.026545 seconds and 4 git commands to generate.