ev_qs can request fallback to active vcores (XCC)
[akaros.git] / user / pthread / pthread.c
index fc705d9..5a8f916 100644 (file)
@@ -5,7 +5,7 @@
 #include <stdlib.h>
 #include <string.h>
 #include <assert.h>
-#include <rstdio.h>
+#include <stdio.h>
 #include <errno.h>
 #include <parlib.h>
 #include <ros/event.h>
@@ -15,6 +15,7 @@
 #include <sys/mman.h>
 #include <assert.h>
 #include <event.h>
+#include <ucq.h>
 
 struct pthread_queue ready_queue = TAILQ_HEAD_INITIALIZER(ready_queue);
 struct pthread_queue active_queue = TAILQ_HEAD_INITIALIZER(active_queue);
@@ -23,6 +24,10 @@ pthread_once_t init_once = PTHREAD_ONCE_INIT;
 int threads_ready = 0;
 int threads_active = 0;
 
+/* Array of per-vcore structs to manage waiting on syscalls and handling
+ * overflow.  Init'd in pth_init(). */
+struct sysc_mgmt *sysc_mgmt = 0;
+
 /* Helper / local functions */
 static int get_next_pid(void);
 static inline void spin_to_sleep(unsigned int spins, unsigned int *spun);
@@ -30,12 +35,16 @@ static inline void spin_to_sleep(unsigned int spins, unsigned int *spun);
 /* Pthread 2LS operations */
 struct uthread *pth_init(void);
 void pth_sched_entry(void);
-struct uthread *pth_thread_create(void *udata);
+struct uthread *pth_thread_create(void (*func)(void), void *udata);
 void pth_thread_runnable(struct uthread *uthread);
 void pth_thread_yield(struct uthread *uthread);
-void pth_thread_exit(struct uthread *uthread);
+void pth_thread_destroy(struct uthread *uthread);
 void pth_preempt_pending(void);
 void pth_spawn_thread(uintptr_t pc_start, void *data);
+void pth_blockon_sysc(struct syscall *sysc);
+
+/* Event Handlers */
+static void pth_handle_syscall(struct event_msg *ev_msg, unsigned int ev_type);
 
 struct schedule_ops pthread_sched_ops = {
        pth_init,
@@ -43,7 +52,8 @@ struct schedule_ops pthread_sched_ops = {
        pth_thread_create,
        pth_thread_runnable,
        pth_thread_yield,
-       pth_thread_exit,
+       pth_thread_destroy,
+       pth_blockon_sysc,
        0, /* pth_preempt_pending, */
        0, /* pth_spawn_thread, */
 };
@@ -59,6 +69,8 @@ static int __pthread_allocate_stack(struct pthread_tcb *pt);
  * main()) */
 struct uthread *pth_init(void)
 {
+       uintptr_t mmap_block;
+       struct mcs_lock_qnode local_qn = {0};
        /* Tell the kernel where and how we want to receive events.  This is just an
         * example of what to do to have a notification turned on.  We're turning on
         * USER_IPIs, posting events to vcore 0's vcpd, and telling the kernel to
@@ -67,56 +79,123 @@ struct uthread *pth_init(void)
         * to use parts of event.c to do what you want. */
        enable_kevent(EV_USER_IPI, 0, EVENT_IPI);
 
+       /* Handle syscall events.  Using small ev_qs, with no internal ev_mbox. */
+       ev_handlers[EV_SYSCALL] = pth_handle_syscall;
+       /* Set up the per-vcore structs to track outstanding syscalls */
+       sysc_mgmt = malloc(sizeof(struct sysc_mgmt) * max_vcores());
+       assert(sysc_mgmt);
+#if 1   /* Independent ev_mboxes per vcore */
+       /* Get a block of pages for our per-vcore (but non-VCPD) ev_qs */
+       mmap_block = (uintptr_t)mmap(0, PGSIZE * 2 * max_vcores(),
+                                    PROT_WRITE | PROT_READ,
+                                    MAP_POPULATE | MAP_ANONYMOUS, -1, 0);
+       assert(mmap_block);
+       /* Could be smarter and do this on demand (in case we don't actually want
+        * max_vcores()). */
+       for (int i = 0; i < max_vcores(); i++) {
+               /* Each vcore needs to point to a non-VCPD ev_q */
+               sysc_mgmt[i].ev_q = get_big_event_q_raw();
+               sysc_mgmt[i].ev_q->ev_flags = EVENT_IPI | EVENT_INDIR | EVENT_FALLBACK;
+               sysc_mgmt[i].ev_q->ev_vcore = i;
+               ucq_init_raw(&sysc_mgmt[i].ev_q->ev_mbox->ev_msgs, 
+                            mmap_block + (2 * i    ) * PGSIZE, 
+                            mmap_block + (2 * i + 1) * PGSIZE); 
+       }
+       /* Technically, we should munmap and free what we've alloc'd, but the
+        * kernel will clean it up for us when we exit. */
+#endif 
+#if 0   /* One global ev_mbox, separate ev_q per vcore */
+       struct event_mbox *sysc_mbox = malloc(sizeof(struct event_mbox));
+       uintptr_t two_pages = (uintptr_t)mmap(0, PGSIZE * 2, PROT_WRITE | PROT_READ,
+                                             MAP_POPULATE | MAP_ANONYMOUS, -1, 0);
+       printd("Global ucq: %08p\n", &sysc_mbox->ev_msgs);
+       assert(sysc_mbox);
+       assert(two_pages);
+       memset(sysc_mbox, 0, sizeof(struct event_mbox));
+       ucq_init_raw(&sysc_mbox->ev_msgs, two_pages, two_pages + PGSIZE);
+       for (int i = 0; i < max_vcores(); i++) {
+               sysc_mgmt[i].ev_q = get_event_q();
+               sysc_mgmt[i].ev_q->ev_flags = EVENT_IPI | EVENT_INDIR | EVENT_FALLBACK;
+               sysc_mgmt[i].ev_q->ev_vcore = i;
+               sysc_mgmt[i].ev_q->ev_mbox = sysc_mbox;
+       }
+#endif
+
        /* Create a pthread_tcb for the main thread */
        pthread_t t = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
+       assert(t);
        t->id = get_next_pid();
+       t->stacksize = USTACK_NUM_PAGES * PGSIZE;
+       t->stacktop = (void*)USTACKTOP;
+       t->detached = TRUE;
+       t->flags = 0;
+       t->finished = 0;
        assert(t->id == 0);
-
        /* Put the new pthread on the active queue */
-       mcs_lock_lock(&queue_lock);
+       mcs_lock_notifsafe(&queue_lock, &local_qn);
        threads_active++;
        TAILQ_INSERT_TAIL(&active_queue, t, next);
-       mcs_lock_unlock(&queue_lock);
+       mcs_unlock_notifsafe(&queue_lock, &local_qn);
        return (struct uthread*)t;
 }
 
 /* Called from vcore entry.  Options usually include restarting whoever was
  * running there before or running a new thread.  Events are handled out of
  * event.c (table of function pointers, stuff like that). */
-void pth_sched_entry(void)
+void __attribute__((noreturn)) pth_sched_entry(void)
 {
-       if (current_thread) {
+       uint32_t vcoreid = vcore_id();
+       if (current_uthread) {
                run_current_uthread();
                assert(0);
        }
        /* no one currently running, so lets get someone from the ready queue */
        struct pthread_tcb *new_thread = NULL;
-       mcs_lock_lock(&queue_lock);
-       new_thread = TAILQ_FIRST(&ready_queue);
-       if (new_thread) {
-               TAILQ_REMOVE(&ready_queue, new_thread, next);
-               TAILQ_INSERT_TAIL(&active_queue, new_thread, next);
-               threads_active++;
-               threads_ready--;
-       }
-       mcs_lock_unlock(&queue_lock);
-       /* For now, this dumb logic is done here */
-       if (!new_thread) {
-               /* TODO: consider doing something more intelligent here */
+       struct mcs_lock_qnode local_qn = {0};
+       /* Try to get a thread.  If we get one, we'll break out and run it.  If not,
+        * we'll try to yield.  vcore_yield() might return, if we lost a race and
+        * had a new event come in, one that may make us able to get a new_thread */
+       do {
+               handle_events(vcoreid);
+               mcs_lock_notifsafe(&queue_lock, &local_qn);
+               new_thread = TAILQ_FIRST(&ready_queue);
+               if (new_thread) {
+                       TAILQ_REMOVE(&ready_queue, new_thread, next);
+                       TAILQ_INSERT_TAIL(&active_queue, new_thread, next);
+                       threads_active++;
+                       threads_ready--;
+                       mcs_unlock_notifsafe(&queue_lock, &local_qn);
+                       break;
+               }
+               mcs_unlock_notifsafe(&queue_lock, &local_qn);
+               /* no new thread, try to yield */
                printd("[P] No threads, vcore %d is yielding\n", vcore_id());
-               sys_yield(0);
-               assert(0);
-       }
+               /* TODO: you can imagine having something smarter here, like spin for a
+                * bit before yielding (or not at all if you want to be greedy). */
+               vcore_yield();
+       } while (1);
+       assert(((struct uthread*)new_thread)->state != UT_RUNNING);
        run_uthread((struct uthread*)new_thread);
        assert(0);
 }
 
-struct uthread *pth_thread_create(void *udata)
+/* Could move this, along with start_routine and arg, into the 2LSs */
+static void __pthread_run(void)
+{
+       struct pthread_tcb *me = pthread_self();
+       pthread_exit(me->start_routine(me->arg));
+}
+
+/* Responible for creating the uthread and initializing its user trap frame */
+struct uthread *pth_thread_create(void (*func)(void), void *udata)
 {
        struct pthread_tcb *pthread;
        pthread_attr_t *attr = (pthread_attr_t*)udata;
        pthread = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
+       assert(pthread);
        pthread->stacksize = PTHREAD_STACK_SIZE;        /* default */
+       pthread->finished = 0;
+       pthread->flags = 0;
        pthread->id = get_next_pid();
        pthread->detached = FALSE;                              /* default */
        /* Respect the attributes */
@@ -129,18 +208,27 @@ struct uthread *pth_thread_create(void *udata)
        /* allocate a stack */
        if (__pthread_allocate_stack(pthread))
                printf("We're fucked\n");
+       /* 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, (uint32_t)__pthread_run, 
+                 (uint32_t)(pthread->stacktop));
        return (struct uthread*)pthread;
 }
 
 void pth_thread_runnable(struct uthread *uthread)
 {
        struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
+       struct mcs_lock_qnode local_qn = {0};
        /* Insert the newly created thread into the ready queue of threads.
         * It will be removed from this queue later when vcore_entry() comes up */
-       mcs_lock_lock(&queue_lock);
+       mcs_lock_notifsafe(&queue_lock, &local_qn);
        TAILQ_INSERT_TAIL(&ready_queue, pthread, next);
        threads_ready++;
-       mcs_lock_unlock(&queue_lock);
+       mcs_unlock_notifsafe(&queue_lock, &local_qn);
+       /* Smarter schedulers should look at the num_vcores() and how much work is
+        * going on to make a decision about how many vcores to request. */
+       vcore_request(threads_ready);
 }
 
 /* The calling thread is yielding.  Do what you need to do to restart (like put
@@ -149,36 +237,35 @@ void pth_thread_runnable(struct uthread *uthread)
 void pth_thread_yield(struct uthread *uthread)
 {
        struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
-       /* Take from the active list, and put on the ready list (tail).  Don't do
-        * this until we are done completely with the thread, since it can be
-        * restarted somewhere else. */
-       mcs_lock_lock(&queue_lock);
+       struct mcs_lock_qnode local_qn = {0};
+       /* Remove from the active list, whether exiting or yielding.  We're holding
+        * the lock throughout both list modifications (if applicable). */
+       mcs_lock_notifsafe(&queue_lock, &local_qn);
        threads_active--;
        TAILQ_REMOVE(&active_queue, pthread, next);
-       threads_ready++;
-       TAILQ_INSERT_TAIL(&ready_queue, pthread, next);
-       mcs_lock_unlock(&queue_lock);
+       if (pthread->flags & PTHREAD_EXITING) {
+               mcs_unlock_notifsafe(&queue_lock, &local_qn);
+               uthread_destroy(uthread);
+       } else {
+               /* Put it on the ready list (tail).  Don't do this until we are done
+                * completely with the thread, since it can be restarted somewhere else.
+                * */
+               threads_ready++;
+               TAILQ_INSERT_TAIL(&ready_queue, pthread, next);
+               mcs_unlock_notifsafe(&queue_lock, &local_qn);
+       }
 }
-
-/* Thread is exiting, do your 2LS specific stuff.  You're in vcore context.
- * Don't use the thread's TLS or stack or anything. */
-void pth_thread_exit(struct uthread *uthread)
+       
+void pth_thread_destroy(struct uthread *uthread)
 {
        struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
-       /* Remove from the active runqueue */
-       mcs_lock_lock(&queue_lock);
-       threads_active--;
-       TAILQ_REMOVE(&active_queue, pthread, next);
-       mcs_lock_unlock(&queue_lock);
        /* Cleanup, mirroring pth_thread_create() */
        __pthread_free_stack(pthread);
        /* TODO: race on detach state */
        if (pthread->detached)
                free(pthread);
-       /* Once we do this, our joiner can free us.  He won't free us if we're
-        * detached, but there is still a potential race there (since he's accessing
-        * someone who is freed. */
-       pthread->finished = 1;
+       else
+               pthread->finished = 1;
 }
 
 void pth_preempt_pending(void)
@@ -189,6 +276,63 @@ void pth_spawn_thread(uintptr_t pc_start, void *data)
 {
 }
 
+/* Restarts a uthread hanging off a syscall.  For the simple pthread case, we
+ * just make it runnable and let the main scheduler code handle it. */
+static void restart_thread(struct syscall *sysc)
+{
+       struct uthread *ut_restartee = (struct uthread*)sysc->u_data;
+       /* uthread stuff here: */
+       assert(ut_restartee);
+       assert(ut_restartee->state == UT_BLOCKED);
+       assert(ut_restartee->sysc == sysc);
+       ut_restartee->sysc = 0; /* so we don't 'reblock' on this later */
+       uthread_runnable(ut_restartee);
+}
+
+/* This handler is usually run in vcore context, though I can imagine it being
+ * called by a uthread in some other threading library. */
+static void pth_handle_syscall(struct event_msg *ev_msg, unsigned int ev_type)
+{
+       struct syscall *sysc;
+       assert(in_vcore_context());
+       /* It's a bug if we don't have a msg (we're handling a syscall bit-event) */
+       assert(ev_msg);
+       /* Get the sysc from the message and just restart it */
+       sysc = ev_msg->ev_arg3;
+       assert(sysc);
+       restart_thread(sysc);
+}
+
+/* This will be called from vcore context, after the current thread has yielded
+ * and is trying to block on sysc.  Need to put it somewhere were we can wake it
+ * up when the sysc is done.  For now, we'll have the kernel send us an event
+ * when the syscall is done. */
+void pth_blockon_sysc(struct syscall *sysc)
+{
+       int old_flags;
+       bool need_to_restart = FALSE;
+       uint32_t vcoreid = vcore_id();
+
+       assert(current_uthread->state == UT_BLOCKED);
+       /* rip from the active queue */
+       struct mcs_lock_qnode local_qn = {0};
+       struct pthread_tcb *pthread = (struct pthread_tcb*)current_uthread;
+       mcs_lock_notifsafe(&queue_lock, &local_qn);
+       threads_active--;
+       TAILQ_REMOVE(&active_queue, pthread, next);
+       mcs_unlock_notifsafe(&queue_lock, &local_qn);
+
+       /* Set things up so we can wake this thread up later */
+       sysc->u_data = current_uthread;
+       /* Register our vcore's syscall ev_q to hear about this syscall. */
+       if (!register_evq(sysc, sysc_mgmt[vcoreid].ev_q)) {
+               /* Lost the race with the call being done.  The kernel won't send the
+                * event.  Just restart him. */
+               restart_thread(sysc);
+       }
+       /* GIANT WARNING: do not touch the thread after this point. */
+}
+
 /* Pthread interface stuff and helpers */
 
 int pthread_attr_init(pthread_attr_t *a)
@@ -205,7 +349,7 @@ int pthread_attr_destroy(pthread_attr_t *a)
 
 static void __pthread_free_stack(struct pthread_tcb *pt)
 {
-       assert(!munmap(pt->uthread.stacktop - PTHREAD_STACK_SIZE, PTHREAD_STACK_SIZE));
+       assert(!munmap(pt->stacktop - pt->stacksize, pt->stacksize));
 }
 
 static int __pthread_allocate_stack(struct pthread_tcb *pt)
@@ -216,7 +360,7 @@ static int __pthread_allocate_stack(struct pthread_tcb *pt)
                              MAP_POPULATE|MAP_ANONYMOUS, -1, 0);
        if (stackbot == MAP_FAILED)
                return -1; // errno set by mmap
-       pt->uthread.stacktop = stackbot + pt->stacksize;
+       pt->stacktop = stackbot + pt->stacksize;
        return 0;
 }
 
@@ -241,10 +385,14 @@ int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize)
 int pthread_create(pthread_t* thread, const pthread_attr_t* attr,
                    void *(*start_routine)(void *), void* arg)
 {
-       struct uthread *uthread = uthread_create(start_routine, arg, (void*)attr);
-       if (!uthread)
+       struct pthread_tcb *pthread =
+              (struct pthread_tcb*)uthread_create(__pthread_run, (void*)attr);
+       if (!pthread)
                return -1;
-       *thread = (struct pthread_tcb*)uthread;
+       pthread->start_routine = start_routine;
+       pthread->arg = arg;
+       uthread_runnable((struct uthread*)pthread);
+       *thread = pthread;
        return 0;
 }
 
@@ -260,14 +408,14 @@ int pthread_join(pthread_t thread, void** retval)
        while (!thread->finished)
                pthread_yield();
        if (retval)
-               *retval = thread->uthread.retval;
+               *retval = thread->retval;
        free(thread);
        return 0;
 }
 
 int pthread_yield(void)
 {
-       uthread_yield();
+       uthread_yield(TRUE);
        return 0;
 }
 
@@ -305,7 +453,7 @@ int pthread_mutexattr_settype(pthread_mutexattr_t* attr, int type)
 int pthread_mutex_init(pthread_mutex_t* m, const pthread_mutexattr_t* attr)
 {
   m->attr = attr;
-  m->lock = 0;
+  atomic_init(&m->lock, 0);
   return 0;
 }
 
@@ -332,7 +480,7 @@ int pthread_mutex_lock(pthread_mutex_t* m)
 
 int pthread_mutex_trylock(pthread_mutex_t* m)
 {
-  return atomic_swap(&m->lock,1) == 0 ? 0 : EBUSY;
+  return atomic_swap(&m->lock, 1) == 0 ? 0 : EBUSY;
 }
 
 int pthread_mutex_unlock(pthread_mutex_t* m)
@@ -340,7 +488,7 @@ int pthread_mutex_unlock(pthread_mutex_t* m)
   /* Need to prevent the compiler (and some arches) from reordering older
    * stores */
   wmb();
-  m->lock = 0;
+  atomic_set(&m->lock, 0);
   return 0;
 }
 
@@ -385,11 +533,11 @@ int pthread_cond_signal(pthread_cond_t *c)
 
 int pthread_cond_wait(pthread_cond_t *c, pthread_mutex_t *m)
 {
-  int old_waiter = c->next_waiter;
-  int my_waiter = c->next_waiter;
+  uint32_t old_waiter = c->next_waiter;
+  uint32_t my_waiter = c->next_waiter;
   
   //allocate a slot
-  while (atomic_swap (& (c->in_use[my_waiter]), SLOT_IN_USE) == SLOT_IN_USE)
+  while (atomic_swap_u32(& (c->in_use[my_waiter]), SLOT_IN_USE) == SLOT_IN_USE)
   {
     my_waiter = (my_waiter + 1) % MAX_PTHREADS;
     assert (old_waiter != my_waiter);  // do not want to wrap around
@@ -432,7 +580,7 @@ int pthread_condattr_getpshared(pthread_condattr_t *a, int *s)
 
 pthread_t pthread_self()
 {
-  return (struct pthread_tcb*)current_thread;
+  return (struct pthread_tcb*)current_uthread;
 }
 
 int pthread_equal(pthread_t t1, pthread_t t2)
@@ -444,12 +592,16 @@ int pthread_equal(pthread_t t1, pthread_t t2)
  * scheduler.  Will need to sort that shit out. */
 void pthread_exit(void *ret)
 {
-       uthread_exit(ret);
+       struct pthread_tcb *pthread = pthread_self();
+       pthread->retval = ret;
+       /* So our pth_thread_yield knows we want to exit */
+       pthread->flags |= PTHREAD_EXITING;
+       uthread_yield(FALSE);
 }
 
 int pthread_once(pthread_once_t* once_control, void (*init_routine)(void))
 {
-  if(atomic_swap(once_control,1) == 0)
+  if (atomic_swap_u32(once_control, 1) == 0)
     init_routine();
   return 0;
 }
@@ -497,6 +649,7 @@ int pthread_barrier_destroy(pthread_barrier_t* b)
 
 int pthread_detach(pthread_t thread)
 {
+       /* TODO: race on this state.  Someone could be trying to join now */
        thread->detached = TRUE;
        return 0;
 }