Update pthread futexes to use alarms for timeouts
[akaros.git] / user / pthread / futex.c
index 2d459a0..5dbcfad 100644 (file)
@@ -2,16 +2,25 @@
 #include <futex.h>
 #include <sys/queue.h>
 #include <pthread.h>
+#include <parlib.h>
 #include <assert.h>
 #include <stdio.h>
 #include <errno.h>
 #include <slab.h>
 #include <mcs.h>
+#include <alarm.h>
+
+static inline int futex_wake(int *uaddr, int count);
+static inline int futex_wait(int *uaddr, int val, uint64_t ms_timeout);
+static void *timer_thread(void *arg);
 
 struct futex_element {
   TAILQ_ENTRY(futex_element) link;
   pthread_t pthread;
   int *uaddr;
+  uint64_t us_timeout;
+  struct alarm_waiter awaiter;
+  bool timedout;
 };
 TAILQ_HEAD(futex_queue, futex_element);
 
@@ -27,27 +36,85 @@ static inline void futex_init()
   TAILQ_INIT(&__futex.queue);
 }
 
+static void __futex_timeout(struct alarm_waiter *awaiter) {
+  struct futex_element *__e = NULL;
+  struct futex_element *e = (struct futex_element*)awaiter->data;
+
+  // Atomically remove the timed-out element from the futex queue if we won the
+  // race against actually completing.
+  mcs_pdr_lock(&__futex.lock);
+  TAILQ_FOREACH(__e, &__futex.queue, link)
+    if (__e == e) break;
+  if (__e != NULL)
+    TAILQ_REMOVE(&__futex.queue, e, link);
+  mcs_pdr_unlock(&__futex.lock);
+
+  // If we removed it, restart it outside the lock
+  if (__e != NULL) {
+    uthread_runnable((struct uthread*)e->pthread);
+    e->timedout = true;
+  }
+  // Set this as the very last thing we do.  Spin on this in the wake code if
+  // we are trying to wake something that has already fired this timer.
+  awaiter->data = NULL;
+}
+
 static void __futex_block(struct uthread *uthread, void *arg) {
   pthread_t pthread = (pthread_t)uthread;
   struct futex_element *e = (struct futex_element*)arg;
+
+  // Set the remaining properties of the futex element
+  e->pthread = pthread;
+  e->timedout = false;
+
+  // Insert the futex element into the queue
+  TAILQ_INSERT_TAIL(&__futex.queue, e, link);
+
+  // Set an alarm for futex timeout if applicable
+  if(e->us_timeout != (uint64_t)-1) {
+    e->awaiter.data = e;
+    init_awaiter(&e->awaiter, __futex_timeout);
+    set_awaiter_rel(&e->awaiter, e->us_timeout);
+    set_alarm(&e->awaiter);
+  }
+
+  // Notify the scheduler of the type of yield we did
   __pthread_generic_yield(pthread);
   pthread->state = PTH_BLK_MUTEX;
-  e->pthread = pthread;
+
+  // Unlock the pdr_lock 
+  mcs_pdr_unlock(&__futex.lock);
 }
 
-static inline int futex_wait(int *uaddr, int val)
+static inline int futex_wait(int *uaddr, int val, uint64_t us_timeout)
 {
+  // Atomically do the following...
   mcs_pdr_lock(&__futex.lock);
+  // If the value of *uaddr matches val
   if(*uaddr == val) {
+    // Create a new futex element and initialize it.
     struct futex_element e;
     e.uaddr = uaddr;
-    e.pthread = NULL;
-    TAILQ_INSERT_TAIL(&__futex.queue, &e, link);
-    mcs_pdr_unlock(&__futex.lock);
+    e.us_timeout = us_timeout;
+    // Yield the uthread...
+    // We set the remaining properties of the futex element, set the timer, and
+    // unlock the pdr lock on the other side.  It is important that we do the
+    // unlock on the other side, because (unlike linux, etc.) its possible to
+    // get interrupted and drop into vcore context right after releasing the
+    // lock.  If that vcore code then calls futex_wake(), we would be screwed.
+    // Doing things this way means we have to hold the lock longer, but its
+    // necessary for correctness.
     uthread_yield(TRUE, __futex_block, &e);
-  }
-  else {
-    mcs_pdr_unlock(&__futex.lock);
+    // We are unlocked here!
+
+    // After waking, if we timed out, set the error
+    // code appropriately and return
+    if(e.timedout) {
+      errno = ETIMEDOUT;
+      return -1;
+    }
+  } else {
+      mcs_pdr_unlock(&__futex.lock);
   }
   return 0;
 }
@@ -64,7 +131,23 @@ static inline int futex_wake(int *uaddr, int count)
   while(e != NULL) {
     if(count > 0) {
       n = TAILQ_NEXT(e, link);
+      // If this element is blocked on uaddr
       if(e->uaddr == uaddr) {
+        // Cancel the timeout if one was set
+        if(e->us_timeout != (uint64_t)-1) {
+          // Try and unset the alarm.  If this fails, then we have already
+          // started running the alarm callback, so spin on awaiter->data being
+          // set to NULL.  The fact that we made it here though, means that WE
+          // are the one who removed e from the queue, so we are basically
+          // spinning just to make sure that no more references to awaiter
+          // exist.
+          if(!unset_alarm(&e->awaiter)) {
+            while(&e->awaiter)
+              cpu_relax();
+          } else {
+          }
+        }
+        // Remove it from the queue
         TAILQ_REMOVE(&__futex.queue, e, link);
         TAILQ_INSERT_TAIL(&q, e, link);
         count--;
@@ -80,25 +163,29 @@ static inline int futex_wake(int *uaddr, int count)
   while(e != NULL) {
     n = TAILQ_NEXT(e, link);
     TAILQ_REMOVE(&q, e, link);
-    while(e->pthread == NULL)
-      cpu_relax();
     uthread_runnable((struct uthread*)e->pthread);
     e = n;
   }
   return 0;
 }
 
-int futex(int *uaddr, int op, int val, const struct timespec *timeout,
-                 int *uaddr2, int val3)
+int futex(int *uaddr, int op, int val,
+          const struct timespec *timeout,
+          int *uaddr2, int val3)
 {
-  assert(timeout == NULL);
+  // Round to the nearest micro-second
+  uint64_t us_timeout = (uint64_t)-1;
   assert(uaddr2 == NULL);
   assert(val3 == 0);
+  if(timeout != NULL) {
+    us_timeout = timeout->tv_sec*1000000L + timeout->tv_nsec/1000L;
+    assert(us_timeout > 0);
+  }
 
   run_once(futex_init());
   switch(op) {
     case FUTEX_WAIT:
-      return futex_wait(uaddr, val);
+      return futex_wait(uaddr, val, us_timeout);
     case FUTEX_WAKE:
       return futex_wake(uaddr, val);
     default: