X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcommon%2Ffutex.c;h=f1b33ea34dabc3c5cbe8352d98280a5ba9c553c7;hb=287a512f2b868c16132b894a8143a5faf0379ca8;hp=adfe66b1c29feb3295949253f315819c8d110d92;hpb=50c8f4840cc0cf140c760159c8705592d6b434ea;p=lttng-tools.git

diff --git a/src/common/futex.c b/src/common/futex.c
index adfe66b1c..f1b33ea34 100644
--- a/src/common/futex.c
+++ b/src/common/futex.c
@@ -16,14 +16,13 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-#define _GNU_SOURCE
+#define _LGPL_SOURCE
 #include <limits.h>
-#include <sys/syscall.h>
 #include <unistd.h>
 #include <urcu.h>
 #include <urcu/futex.h>
 
-#include <common/error.h>
+#include <common/common.h>
 
 #include "futex.h"
 
@@ -31,30 +30,38 @@
  * This futex wait/wake scheme only works for N wakers / 1 waiters. Hence the
  * "nto1" added to all function signature.
  *
- * Please see wait_gp()/update_counter_and_wait() calls in urcu.c in the urcu
- * git tree for a detail example of this scheme being used. futex_async() is
- * the urcu wrapper over the futex() sycall.
- *
- * There is also a formal verification available in the git tree.
- *
- *   branch: formal-model
- *   commit id: 2a8044f3493046fcc8c67016902dc7beec6f026a
- *
- * Ref: git://git.lttng.org/userspace-rcu.git
+ * The code is adapted from the adaptative busy wait/wake_up scheme used in
+ * liburcu.
  */
 
+/* Number of busy-loop attempts before waiting on futex. */
+#define FUTEX_WAIT_ATTEMPTS 1000
+
+enum futex_wait_state {
+	/* FUTEX_WAIT_WAITING is compared directly (futex() compares it). */
+	FUTEX_WAIT_WAITING =	0,
+	/* non-zero are used as masks. */
+	FUTEX_WAIT_WAKEUP =	(1 << 0),
+	FUTEX_WAIT_RUNNING =	(1 << 1),
+	FUTEX_WAIT_TEARDOWN =	(1 << 2),
+};
+
 /*
  * Update futex according to active or not. This scheme is used to wake every
  * libust waiting on the shared memory map futex hence the INT_MAX used in the
  * futex() call. If active, we set the value and wake everyone else we indicate
  * that we are gone (cleanup() case).
  */
+LTTNG_HIDDEN
 void futex_wait_update(int32_t *futex, int active)
 {
 	if (active) {
 		uatomic_set(futex, 1);
-		futex_async(futex, FUTEX_WAKE,
-				INT_MAX, NULL, NULL, 0);
+		if (futex_async(futex, FUTEX_WAKE,
+				INT_MAX, NULL, NULL, 0) < 0) {
+			PERROR("futex_async");
+			abort();
+		}
 	} else {
 		uatomic_set(futex, 0);
 	}
@@ -65,9 +72,10 @@ void futex_wait_update(int32_t *futex, int active)
 /*
  * Prepare futex.
  */
+LTTNG_HIDDEN
 void futex_nto1_prepare(int32_t *futex)
 {
-	uatomic_set(futex, -1);
+	uatomic_set(futex, FUTEX_WAIT_WAITING);
 	cmm_smp_mb();
 
 	DBG("Futex n to 1 prepare done");
@@ -76,26 +84,69 @@ void futex_nto1_prepare(int32_t *futex)
 /*
  * Wait futex.
  */
+LTTNG_HIDDEN
 void futex_nto1_wait(int32_t *futex)
 {
-	cmm_smp_mb();
+	unsigned int i;
 
-	if (uatomic_read(futex) == -1) {
-		futex_async(futex, FUTEX_WAIT, -1, NULL, NULL, 0);
+	/* Load and test condition before read state */
+	cmm_smp_rmb();
+	for (i = 0; i < FUTEX_WAIT_ATTEMPTS; i++) {
+		if (uatomic_read(futex) != FUTEX_WAIT_WAITING)
+			goto skip_futex_wait;
+		caa_cpu_relax();
 	}
+	while (futex_noasync(futex, FUTEX_WAIT, FUTEX_WAIT_WAITING,
+			NULL, NULL, 0)) {
+		switch (errno) {
+		case EWOULDBLOCK:
+			/* Value already changed. */
+			goto skip_futex_wait;
+		case EINTR:
+			/* Retry if interrupted by signal. */
+			break;	/* Get out of switch. */
+		default:
+			/* Unexpected error. */
+			PERROR("futex");
+			abort();
+		}
+	}
+skip_futex_wait:
+
+	/* Tell waker thread than we are running. */
+	uatomic_or(futex, FUTEX_WAIT_RUNNING);
 
+	/*
+	 * Wait until waker thread lets us know it's ok to tear down
+	 * memory allocated for the futex.
+	 */
+	for (i = 0; i < FUTEX_WAIT_ATTEMPTS; i++) {
+		if (uatomic_read(futex) & FUTEX_WAIT_TEARDOWN)
+			break;
+		caa_cpu_relax();
+	}
+	while (!(uatomic_read(futex) & FUTEX_WAIT_TEARDOWN))
+		poll(NULL, 0, 10);
+	assert(uatomic_read(futex) & FUTEX_WAIT_TEARDOWN);
 	DBG("Futex n to 1 wait done");
 }
 
 /*
  * Wake 1 futex.
  */
+LTTNG_HIDDEN
 void futex_nto1_wake(int32_t *futex)
 {
-	if (caa_unlikely(uatomic_read(futex) == -1)) {
-		uatomic_set(futex, 0);
-		futex_async(futex, FUTEX_WAKE, 1, NULL, NULL, 0);
+	cmm_smp_mb();
+	uatomic_set(futex, FUTEX_WAIT_WAKEUP);
+	if (!(uatomic_read(futex) & FUTEX_WAIT_RUNNING)) {
+		if (futex_noasync(futex, FUTEX_WAKE, 1,
+				NULL, NULL, 0) < 0) {
+			PERROR("futex_noasync");
+			abort();
+		}
 	}
-
+	/* Allow teardown of futex. */
+	uatomic_or(futex, FUTEX_WAIT_TEARDOWN);
 	DBG("Futex n to 1 wake done");
 }