2LS op for handling reflected faults
[akaros.git] / user / pthread / pthread.c
index a2fb333..a1eafb2 100644 (file)
@@ -1,4 +1,4 @@
-#include <ros/arch/trapframe.h>
+#include <ros/trapframe.h>
 #include <pthread.h>
 #include <vcore.h>
 #include <mcs.h>
@@ -21,7 +21,9 @@ struct pthread_queue active_queue = TAILQ_HEAD_INITIALIZER(active_queue);
 struct mcs_pdr_lock queue_lock;
 int threads_ready = 0;
 int threads_active = 0;
+atomic_t threads_total;
 bool can_adjust_vcores = TRUE;
+bool need_tls = TRUE;
 
 /* Array of per-vcore structs to manage waiting on syscalls and handling
  * overflow.  Init'd in pth_init(). */
@@ -37,6 +39,8 @@ void pth_thread_runnable(struct uthread *uthread);
 void pth_thread_paused(struct uthread *uthread);
 void pth_thread_blockon_sysc(struct uthread *uthread, void *sysc);
 void pth_thread_has_blocked(struct uthread *uthread, int flags);
+void pth_thread_refl_fault(struct uthread *uthread, unsigned int trap_nr,
+                           unsigned int err, unsigned long aux);
 void pth_preempt_pending(void);
 void pth_spawn_thread(uintptr_t pc_start, void *data);
 
@@ -49,6 +53,7 @@ struct schedule_ops pthread_sched_ops = {
        pth_thread_paused,
        pth_thread_blockon_sysc,
        pth_thread_has_blocked,
+       pth_thread_refl_fault,
        0, /* pth_preempt_pending, */
        0, /* pth_spawn_thread, */
 };
@@ -221,7 +226,6 @@ void pth_thread_blockon_sysc(struct uthread *uthread, void *syscall)
 {
        struct syscall *sysc = (struct syscall*)syscall;
        int old_flags;
-       bool need_to_restart = FALSE;
        uint32_t vcoreid = vcore_id();
        /* rip from the active queue */
        struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
@@ -254,6 +258,44 @@ void pth_thread_has_blocked(struct uthread *uthread, int flags)
                printf("For great justice!\n");
 }
 
+void pth_thread_refl_fault(struct uthread *uthread, unsigned int trap_nr,
+                           unsigned int err, unsigned long aux)
+{
+       struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
+       pthread->state = PTH_BLK_SYSC;
+       mcs_pdr_lock(&queue_lock);
+       threads_active--;
+       TAILQ_REMOVE(&active_queue, pthread, next);
+       mcs_pdr_unlock(&queue_lock);
+
+       if (trap_nr != 14) {
+               printf("Pthread has unhandled fault\n");
+               print_user_context(&uthread->u_ctx);
+               exit(-1);
+       }
+
+       if (!(err & PF_VMR_BACKED)) {
+               /* TODO: put your SIGSEGV handling here */
+               printf("Pthread page faulted outside a VMR\n");
+               print_user_context(&uthread->u_ctx);
+               exit(-1);
+       }
+       /* stitching for the event handler.  sysc -> uth, uth -> sysc */
+       uthread->local_sysc.u_data = uthread;
+       uthread->sysc = &uthread->local_sysc;
+       pthread->state = PTH_BLK_SYSC;
+       /* one downside is that we'll never check the return val of the syscall.  if
+        * we errored out, we wouldn't know til we PF'd again, and inspected the old
+        * retval/err and other sysc fields (make sure the PF is on the same addr,
+        * etc).  could run into this issue on truncated files too. */
+       syscall_async(&uthread->local_sysc, SYS_populate_va, aux, 1);
+       if (!register_evq(&uthread->local_sysc, sysc_mgmt[vcore_id()].ev_q)) {
+               /* Lost the race with the call being done.  The kernel won't send the
+                * event.  Just restart him. */
+               restart_thread(&uthread->local_sysc);
+       }
+}
+
 void pth_preempt_pending(void)
 {
 }
@@ -272,6 +314,11 @@ void pthread_can_vcore_request(bool can)
        can_adjust_vcores = can;
 }
 
+void pthread_need_tls(bool need)
+{
+       need_tls = need;
+}
+
 /* Pthread interface stuff and helpers */
 
 int pthread_attr_init(pthread_attr_t *a)
@@ -316,6 +363,7 @@ int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize)
        attr->stacksize = stacksize;
        return 0;
 }
+
 int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize)
 {
        *stacksize = attr->stacksize;
@@ -327,6 +375,8 @@ int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize)
 void pthread_lib_init(void)
 {
        uintptr_t mmap_block;
+       struct pthread_tcb *t;
+       int ret;
        /* Some testing code might call this more than once (once for a slimmed down
         * pth 2LS, and another from pthread_create().  Also, this is racy, but the
         * first time through we are an SCP. */
@@ -334,8 +384,10 @@ void pthread_lib_init(void)
        assert(!in_multi_mode());
        mcs_pdr_init(&queue_lock);
        /* Create a pthread_tcb for the main thread */
-       pthread_t t = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
-       assert(t);
+       ret = posix_memalign((void**)&t, __alignof__(struct pthread_tcb),
+                            sizeof(struct pthread_tcb));
+       assert(!ret);
+       memset(t, 0, sizeof(struct pthread_tcb));       /* aggressively 0 for bugs */
        t->id = get_next_pid();
        t->stacksize = USTACK_NUM_PAGES * PGSIZE;
        t->stacktop = (void*)USTACKTOP;
@@ -344,7 +396,7 @@ void pthread_lib_init(void)
        t->joiner = 0;
        assert(t->id == 0);
        /* Put the new pthread (thread0) on the active queue */
-       mcs_pdr_lock(&queue_lock);      /* arguably, we don't need these (_S mode) */
+       mcs_pdr_lock(&queue_lock);
        threads_active++;
        TAILQ_INSERT_TAIL(&active_queue, t, next);
        mcs_pdr_unlock(&queue_lock);
@@ -404,16 +456,20 @@ void pthread_lib_init(void)
         * have its init stuff use things like vcore stacks or TLSs, we'll need to
         * change this. */
        uthread_lib_init((struct uthread*)t);
+       atomic_init(&threads_total, 1);                 /* one for thread0 */
 }
 
 int pthread_create(pthread_t *thread, const pthread_attr_t *attr,
                    void *(*start_routine)(void *), void *arg)
 {
+       struct uth_thread_attr uth_attr = {0};
        run_once(pthread_lib_init());
        /* Create the actual thread */
        struct pthread_tcb *pthread;
-       pthread = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
-       assert(pthread);
+       int ret = posix_memalign((void**)&pthread, __alignof__(struct pthread_tcb),
+                                sizeof(struct pthread_tcb));
+       assert(!ret);
+       memset(pthread, 0, sizeof(struct pthread_tcb)); /* aggressively 0 for bugs*/
        pthread->stacksize = PTHREAD_STACK_SIZE;        /* default */
        pthread->state = PTH_CREATED;
        pthread->id = get_next_pid();
@@ -432,14 +488,17 @@ int pthread_create(pthread_t *thread, const pthread_attr_t *attr,
        /* Set the u_tf to start up in __pthread_run, which will call the real
         * start_routine and pass it the arg.  Note those aren't set until later in
         * pthread_create(). */
-       init_user_tf(&pthread->uthread.utf, (long)&__pthread_run,
-                    (long)(pthread->stacktop));
+       init_user_ctx(&pthread->uthread.u_ctx, (uintptr_t)&__pthread_run,
+                     (uintptr_t)(pthread->stacktop));
        pthread->start_routine = start_routine;
        pthread->arg = arg;
        /* Initialize the uthread */
-       uthread_init((struct uthread*)pthread);
+       if (need_tls)
+               uth_attr.want_tls = TRUE;
+       uthread_init((struct uthread*)pthread, &uth_attr);
        pth_thread_runnable((struct uthread*)pthread);
        *thread = pthread;
+       atomic_inc(&threads_total);
        return 0;
 }
 
@@ -533,11 +592,19 @@ static void __pth_exit_cb(struct uthread *uthread, void *junk)
                        pth_thread_runnable((struct uthread*)temp_pth);
                }
        }
+       /* If we were the last pthread, we exit for the whole process.  Keep in mind
+        * that thread0 is counted in this, so this will only happen if that thread
+        * calls pthread_exit(). */
+       if ((atomic_fetch_and_add(&threads_total, -1) == 1))
+               exit(0);
 }
 
 void pthread_exit(void *ret)
 {
        struct pthread_tcb *pthread = pthread_self();
+       /* Some apps could call pthread_exit before initing.  This will slow down
+        * our pthread exits slightly. */
+       pthread_lib_init();
        pthread->retval = ret;
        destroy_dtls();
        uthread_yield(FALSE, __pth_exit_cb, 0);
@@ -600,6 +667,24 @@ int pthread_mutex_init(pthread_mutex_t* m, const pthread_mutexattr_t* attr)
   return 0;
 }
 
+/* Helper for spinning sync, returns TRUE if it is okay to keep spinning.
+ *
+ * Alternatives include:
+ *             old_count <= num_vcores() (barrier code, pass in old_count as *state, 
+ *                                        but this only works if every awake pthread
+ *                                        will belong to the barrier).
+ *             just spin for a bit       (use *state to track spins)
+ *             FALSE                     (always is safe)
+ *             etc...
+ * 'threads_ready' isn't too great since sometimes it'll be non-zero when it is
+ * about to become 0.  We really want "I have no threads waiting to run that
+ * aren't going to run on their on unless this core yields instead of spins". */
+/* TODO: consider making this a 2LS op */
+static inline bool safe_to_spin(unsigned int *state)
+{
+       return !threads_ready;
+}
+
 /* Set *spun to 0 when calling this the first time.  It will yield after 'spins'
  * calls.  Use this for adaptive mutexes and such. */
 static inline void spin_to_sleep(unsigned int spins, unsigned int *spun)
@@ -795,45 +880,129 @@ int pthread_once(pthread_once_t* once_control, void (*init_routine)(void))
   return 0;
 }
 
-int pthread_barrier_init(pthread_barrier_t* b, const pthread_barrierattr_t* a, int count)
+int pthread_barrier_init(pthread_barrier_t *b,
+                         const pthread_barrierattr_t *a, int count)
 {
-  b->nprocs = b->count = count;
-  b->sense = 0;
-  pthread_mutex_init(&b->pmutex, 0);
-  return 0;
+       b->total_threads = count;
+       b->sense = 0;
+       atomic_set(&b->count, count);
+       spin_pdr_init(&b->lock);
+       TAILQ_INIT(&b->waiters);
+       b->nr_waiters = 0;
+       return 0;
 }
 
-int pthread_barrier_wait(pthread_barrier_t* b)
-{
-  unsigned int spinner = 0;
-  int ls = !b->sense;
+struct barrier_junk {
+       pthread_barrier_t                               *b;
+       int                                                             ls;
+};
 
-  pthread_mutex_lock(&b->pmutex);
-  int count = --b->count;
-  pthread_mutex_unlock(&b->pmutex);
+/* Callback/bottom half of barrier. */
+static void __pth_barrier_cb(struct uthread *uthread, void *junk)
+{
+       struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
+       pthread_barrier_t *b = ((struct barrier_junk*)junk)->b;
+       int ls = ((struct barrier_junk*)junk)->ls;
+       /* Removes from active list, we can reuse.  must also restart */
+       __pthread_generic_yield(pthread);
+       /* TODO: if we used a trylock, we could bail as soon as we see sense */
+       spin_pdr_lock(&b->lock);
+       /* If sense is ls (our free value), we lost the race and shouldn't sleep */
+       if (b->sense == ls) {
+               /* TODO: i'd like to fast-path the wakeup, skipping pth_runnable */
+               pthread->state = PTH_BLK_YIELDING;      /* not sure which state for this */
+               spin_pdr_unlock(&b->lock);
+               pth_thread_runnable(uthread);
+               return;
+       }
+       /* otherwise, we sleep */
+       pthread->state = PTH_BLK_MUTEX; /* TODO: consider ignoring this */
+       TAILQ_INSERT_TAIL(&b->waiters, pthread, next);
+       b->nr_waiters++;
+       spin_pdr_unlock(&b->lock);
+}
+
+/* We assume that the same threads participating in the barrier this time will
+ * also participate next time.  Imagine a thread stopped right after its fetch
+ * and add - we know it is coming through eventually.  We finish and change the
+ * sense, which should allow the delayed thread to eventually break through.
+ * But if another n threads come in first, we'll set the sense back to the old
+ * value, thereby catching the delayed thread til the next barrier. 
+ *
+ * A note on preemption: if any thread gets preempted and it is never dealt
+ * with, eventually we deadlock, with all threads waiting on the last one to
+ * enter (and any stragglers from one run will be the last in the next run).
+ * One way or another, we need to handle preemptions.  The current 2LS requests
+ * an IPI for a preempt, so we'll be fine.  Any other strategies will need to
+ * consider how barriers work.  Any time we sleep, we'll be okay (since that
+ * frees up our core to handle preemptions/run other threads. */
+int pthread_barrier_wait(pthread_barrier_t *b)
+{
+       unsigned int spin_state = 0;
+       int ls = !b->sense;     /* when b->sense is the value we read, then we're free*/
+       int nr_waiters;
+       struct pthread_queue restartees = TAILQ_HEAD_INITIALIZER(restartees);
+       struct pthread_tcb *pthread_i;
+       struct barrier_junk local_junk;
+       
+       long old_count = atomic_fetch_and_add(&b->count, -1);
+
+       if (old_count == 1) {
+               printd("Thread %d is last to hit the barrier, resetting...\n",
+                      pthread_self()->id);
+               /* TODO: we might want to grab the lock right away, so a few short
+                * circuit faster? */
+               atomic_set(&b->count, b->total_threads);
+               /* we still need to maintain ordering btw count and sense, in case
+                * another thread doesn't sleep (if we wrote sense first, they could
+                * break out, race around, and muck with count before it is time) */
+               /* wmb(); handled by the spin lock */
+               spin_pdr_lock(&b->lock);
+               /* Sense is only protected in addition to decisions to sleep */
+               b->sense = ls;  /* set to free everyone */
+               /* All access to nr_waiters is protected by the lock */
+               if (!b->nr_waiters) {
+                       spin_pdr_unlock(&b->lock);
+                       return PTHREAD_BARRIER_SERIAL_THREAD;
+               }
+               TAILQ_CONCAT(&restartees, &b->waiters, next);
+               nr_waiters = b->nr_waiters;
+               b->nr_waiters = 0;
+               spin_pdr_unlock(&b->lock);
+               /* TODO: do we really need this state tracking? */
+               TAILQ_FOREACH(pthread_i, &restartees, next)
+                       pthread_i->state = PTH_RUNNABLE;
+               /* bulk restart waiters (skipping pth_thread_runnable()) */
+               mcs_pdr_lock(&queue_lock);
+               threads_ready += nr_waiters;
+               TAILQ_CONCAT(&ready_queue, &restartees, next);
+               mcs_pdr_unlock(&queue_lock);
+               if (can_adjust_vcores)
+                       vcore_request(threads_ready);
+               return PTHREAD_BARRIER_SERIAL_THREAD;
+       } else {
+               /* Spin if there are no other threads to run.  No sense sleeping */
+               do {
+                       if (b->sense == ls)
+                               return 0;
+                       cpu_relax();
+               } while (safe_to_spin(&spin_state));
 
-  if(count == 0)
-  {
-    printd("Thread %d is last to hit the barrier, resetting...\n", pthread_self()->id);
-    b->count = b->nprocs;
-       wmb();
-    b->sense = ls;
-    return PTHREAD_BARRIER_SERIAL_THREAD;
-  }
-  else
-  {
-    while(b->sense != ls) {
-      cpu_relax();
-      spin_to_sleep(PTHREAD_BARRIER_SPINS, &spinner);
-    }
-    return 0;
-  }
+               /* Try to sleep, when we wake/return, we're free to go */
+               local_junk.b = b;
+               local_junk.ls = ls;
+               uthread_yield(TRUE, __pth_barrier_cb, &local_junk);
+               // assert(b->sense == ls);
+               return 0;
+       }
 }
 
-int pthread_barrier_destroy(pthread_barrier_tb)
+int pthread_barrier_destroy(pthread_barrier_t *b)
 {
-  pthread_mutex_destroy(&b->pmutex);
-  return 0;
+       assert(TAILQ_EMPTY(&b->waiters));
+       assert(!b->nr_waiters);
+       /* Free any locks (if we end up using an MCS) */
+       return 0;
 }
 
 int pthread_detach(pthread_t thread)