Cleans up preempt_pending helper functions
[akaros.git] / user / pthread / pthread.c
index 77d847c..4765c6c 100644 (file)
@@ -19,7 +19,7 @@
 
 struct pthread_queue ready_queue = TAILQ_HEAD_INITIALIZER(ready_queue);
 struct pthread_queue active_queue = TAILQ_HEAD_INITIALIZER(active_queue);
-mcs_lock_t queue_lock = MCS_LOCK_INIT;
+struct mcs_pdr_lock queue_lock;
 pthread_once_t init_once = PTHREAD_ONCE_INIT;
 int threads_ready = 0;
 int threads_active = 0;
@@ -36,6 +36,7 @@ static inline void spin_to_sleep(unsigned int spins, unsigned int *spun);
 void pth_sched_entry(void);
 void pth_thread_runnable(struct uthread *uthread);
 void pth_thread_yield(struct uthread *uthread);
+void pth_thread_paused(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);
@@ -47,6 +48,7 @@ struct schedule_ops pthread_sched_ops = {
        pth_sched_entry,
        pth_thread_runnable,
        pth_thread_yield,
+       pth_thread_paused,
        pth_blockon_sysc,
        0, /* pth_preempt_pending, */
        0, /* pth_spawn_thread, */
@@ -71,28 +73,34 @@ void __attribute__((noreturn)) pth_sched_entry(void)
        }
        /* no one currently running, so lets get someone from the ready queue */
        struct pthread_tcb *new_thread = NULL;
-       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);
+               __check_preempt_pending(vcoreid);
+               mcs_pdr_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_unlock_notifsafe(&queue_lock, &local_qn);
+                       mcs_pdr_unlock(&queue_lock);
+                       /* If you see what looks like the same uthread running in multiple
+                        * places, your list might be jacked up.  Turn this on. */
+                       printd("[P] got uthread %08p on vc %d state %08p flags %08p\n",
+                              new_thread, vcoreid,
+                              ((struct uthread*)new_thread)->state,
+                              ((struct uthread*)new_thread)->flags);
                        break;
                }
-               mcs_unlock_notifsafe(&queue_lock, &local_qn);
+               mcs_pdr_unlock(&queue_lock);
                /* no new thread, try to yield */
                printd("[P] No threads, vcore %d is yielding\n", vcore_id());
                /* 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();
+               vcore_yield(FALSE);
        } while (1);
        assert(((struct uthread*)new_thread)->state != UT_RUNNING);
        run_uthread((struct uthread*)new_thread);
@@ -109,13 +117,12 @@ static void __pthread_run(void)
 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_notifsafe(&queue_lock, &local_qn);
+       mcs_pdr_lock(&queue_lock);
        TAILQ_INSERT_TAIL(&ready_queue, pthread, next);
        threads_ready++;
-       mcs_unlock_notifsafe(&queue_lock, &local_qn);
+       mcs_pdr_unlock(&queue_lock);
        /* 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);
@@ -127,33 +134,80 @@ void pth_thread_runnable(struct uthread *uthread)
 void pth_thread_yield(struct uthread *uthread)
 {
        struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
-       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);
+       struct pthread_tcb *temp_pth = 0;       /* used for exiting AND joining */
+       /* Remove from the active list, whether exiting or yielding. */
+       mcs_pdr_lock(&queue_lock);
        threads_active--;
        TAILQ_REMOVE(&active_queue, pthread, next);
+       mcs_pdr_unlock(&queue_lock);
        if (pthread->flags & PTHREAD_EXITING) {
-               mcs_unlock_notifsafe(&queue_lock, &local_qn);
                /* Destroy the pthread */
                uthread_cleanup(uthread);
                /* Cleanup, mirroring pthread_create() */
                __pthread_free_stack(pthread);
                /* TODO: race on detach state */
-               if (pthread->detached)
+               if (pthread->detached) {
                        free(pthread);
-               else
-                       pthread->finished = 1;
+               } else {
+                       /* See if someone is joining on us.  If not, we're done (and the
+                        * joiner will wake itself when it saw us there instead of 0). */
+                       temp_pth = atomic_swap_ptr((void**)&pthread->joiner, pthread);
+                       if (temp_pth) {
+                               /* they joined before we exited, we need to wake them */
+                               printd("[pth] %08p exiting, waking joiner %08p\n",
+                                      pthread, temp_pth);
+                               pth_thread_runnable((struct uthread*)temp_pth);
+                       }
+               }
+       } else if (pthread->flags & PTHREAD_JOINING) {
+               /* We're trying to join, yield til we get woken up */
+               /* put ourselves in the join target's joiner slot.  If we get anything
+                * back, we lost the race and need to wake ourselves. */
+               temp_pth = atomic_swap_ptr((void**)&pthread->join_target->joiner,
+                                          pthread);
+               /* after that atomic swap, the pthread might be woken up (if it
+                * succeeded), so don't touch pthread again after that (this following
+                * if () is okay). */
+               if (temp_pth) {
+                       assert(temp_pth == pthread->join_target);       /* Sanity */
+                       /* wake ourselves, not the exited one! */
+                       printd("[pth] %08p already exit, rewaking ourselves, joiner %08p\n",
+                              temp_pth, pthread);
+                       pth_thread_runnable((struct uthread*)pthread);
+               }
        } 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);
+               /* Yielding for no apparent reason (being nice / help break deadlocks).
+                * Just wake it up and make it ready again. */
+               pth_thread_runnable((struct uthread*)pthread);
        }
 }
 
+/* For some reason not under its control, the uthread stopped running (compared
+ * to yield, which was caused by uthread/2LS code).
+ *
+ * The main case for this is if the vcore was preempted or if the vcore it was
+ * running on needed to stop.  You are given a uthread that looks like it took a
+ * notif, and had its context/silly state copied out to the uthread struct.
+ * (copyout_uthread).  Note that this will be called in the context (TLS) of the
+ * vcore that is losing the uthread.  If that vcore is running, it'll be in a
+ * preempt-event handling loop (not in your 2LS code).  If this is a big
+ * problem, I'll change it. */
+void pth_thread_paused(struct uthread *uthread)
+{
+       struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
+       /* Remove from the active list.  Note that I don't particularly care about
+        * the active list.  We keep it around because it causes bugs and keeps us
+        * honest.  After all, some 2LS may want an active list */
+       mcs_pdr_lock(&queue_lock);
+       threads_active--;
+       TAILQ_REMOVE(&active_queue, pthread, next);
+       mcs_pdr_unlock(&queue_lock);
+       /* At this point, you could do something clever, like put it at the front of
+        * the runqueue, see if it was holding a lock, do some accounting, or
+        * whatever. */
+       uthread_runnable(uthread);
+}
+
 void pth_preempt_pending(void)
 {
 }
@@ -201,12 +255,11 @@ void pth_blockon_sysc(struct syscall *sysc)
 
        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);
+       mcs_pdr_lock(&queue_lock);
        threads_active--;
        TAILQ_REMOVE(&active_queue, pthread, next);
-       mcs_unlock_notifsafe(&queue_lock, &local_qn);
+       mcs_pdr_unlock(&queue_lock);
 
        /* Set things up so we can wake this thread up later */
        sysc->u_data = current_uthread;
@@ -278,7 +331,7 @@ static int pthread_lib_init(void)
                return -1;
        initialized = TRUE;
        uintptr_t mmap_block;
-       struct mcs_lock_qnode local_qn = {0};
+       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);
@@ -287,20 +340,21 @@ static int pthread_lib_init(void)
        t->stacktop = (void*)USTACKTOP;
        t->detached = TRUE;
        t->flags = 0;
-       t->finished = 0;
+       t->join_target = 0;
+       t->joiner = 0;
        assert(t->id == 0);
        /* Put the new pthread (thread0) on the active queue */
-       mcs_lock_notifsafe(&queue_lock, &local_qn);
+       mcs_pdr_lock(&queue_lock);      /* arguably, we don't need these (_S mode) */
        threads_active++;
        TAILQ_INSERT_TAIL(&active_queue, t, next);
-       mcs_unlock_notifsafe(&queue_lock, &local_qn);
+       mcs_pdr_unlock(&queue_lock);
        /* 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
-        * send to vcore 0.  Note sys_self_notify will ignore the vcoreid pref.
-        * Also note that enable_kevent() is just an example, and you probably want
-        * to use parts of event.c to do what you want. */
-       enable_kevent(EV_USER_IPI, 0, EVENT_IPI);
+        * send to vcore 0.  Note sys_self_notify will ignore the vcoreid and
+        * private preference.  Also note that enable_kevent() is just an example,
+        * and you probably want to use parts of event.c to do what you want. */
+       enable_kevent(EV_USER_IPI, 0, EVENT_IPI | EVENT_VCORE_PRIVATE);
 
        /* Handle syscall events. */
        ev_handlers[EV_SYSCALL] = pth_handle_syscall;
@@ -365,10 +419,11 @@ int pthread_create(pthread_t *thread, const pthread_attr_t *attr,
        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 */
+       pthread->join_target = 0;
+       pthread->joiner = 0;
        /* Respect the attributes */
        if (attr) {
                if (attr->stacksize)                                    /* don't set a 0 stacksize */
@@ -382,11 +437,11 @@ 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, (uint32_t)__pthread_run, 
-                    (uint32_t)(pthread->stacktop));
+       init_user_tf(&pthread->uthread.utf, (long)&__pthread_run,
+                    (long)(pthread->stacktop));
        pthread->start_routine = start_routine;
        pthread->arg = arg;
-       /* Initializse the uthread */
+       /* Initialize the uthread */
        uthread_init((struct uthread*)pthread);
        uthread_runnable((struct uthread*)pthread);
        *thread = pthread;
@@ -395,6 +450,7 @@ int pthread_create(pthread_t *thread, const pthread_attr_t *attr,
 
 int pthread_join(pthread_t thread, void** retval)
 {
+       struct pthread_tcb *caller = (struct pthread_tcb*)current_uthread;
        /* Not sure if this is the right semantics.  There is a race if we deref
         * thread and he is already freed (which would have happened if he was
         * detached. */
@@ -402,8 +458,17 @@ int pthread_join(pthread_t thread, void** retval)
                printf("[pthread] trying to join on a detached pthread");
                return -1;
        }
-       while (!thread->finished)
-               pthread_yield();
+       /* See if it is already done, to avoid the pain of a uthread_yield() (the
+        * early check is an optimization, pth_thread_yield() handles the race). */
+       if (!thread->joiner) {
+               /* Time to join, set things up so pth_thread_yield() knows what to do */
+               caller->flags |= PTHREAD_JOINING;
+               caller->join_target = thread;
+               uthread_yield(TRUE);
+               /* When we return/restart, the thread will be done */
+       } else {
+               assert(thread->joiner == thread);       /* sanity check */
+       }
        if (retval)
                *retval = thread->retval;
        free(thread);
@@ -472,6 +537,9 @@ int pthread_mutex_lock(pthread_mutex_t* m)
                        cpu_relax();
                        spin_to_sleep(PTHREAD_MUTEX_SPINS, &spinner);
                }
+       /* normally we'd need a wmb() and a wrmb() after locking, but the
+        * atomic_swap handles the CPU mb(), so just a cmb() is necessary. */
+       cmb();
        return 0;
 }
 
@@ -482,8 +550,8 @@ int pthread_mutex_trylock(pthread_mutex_t* m)
 
 int pthread_mutex_unlock(pthread_mutex_t* m)
 {
-  /* Need to prevent the compiler (and some arches) from reordering older
-   * stores */
+  /* keep reads and writes inside the protected region */
+  rwmb();
   wmb();
   atomic_set(&m->lock, 0);
   return 0;