Allow SCPs to run a pthread 2LS
[akaros.git] / user / pthread / pthread.c
1 // Needed for sigmask functions...
2 #define _GNU_SOURCE
3
4 #include <ros/trapframe.h>
5 #include "pthread.h"
6 #include <parlib/vcore.h>
7 #include <parlib/mcs.h>
8 #include <stdlib.h>
9 #include <string.h>
10 #include <assert.h>
11 #include <stdio.h>
12 #include <errno.h>
13 #include <parlib/parlib.h>
14 #include <ros/event.h>
15 #include <parlib/arch/atomic.h>
16 #include <parlib/arch/arch.h>
17 #include <sys/queue.h>
18 #include <sys/mman.h>
19 #include <parlib/event.h>
20 #include <parlib/ucq.h>
21
22 struct pthread_queue ready_queue = TAILQ_HEAD_INITIALIZER(ready_queue);
23 struct pthread_queue active_queue = TAILQ_HEAD_INITIALIZER(active_queue);
24 struct mcs_pdr_lock queue_lock;
25 int threads_ready = 0;
26 int threads_active = 0;
27 atomic_t threads_total;
28 bool can_adjust_vcores = TRUE;
29 bool need_tls = TRUE;
30
31 /* Array of per-vcore structs to manage waiting on syscalls and handling
32  * overflow.  Init'd in pth_init(). */
33 struct sysc_mgmt *sysc_mgmt = 0;
34
35 /* Helper / local functions */
36 static int get_next_pid(void);
37 static inline void spin_to_sleep(unsigned int spins, unsigned int *spun);
38
39 /* Pthread 2LS operations */
40 void pth_sched_entry(void);
41 void pth_thread_runnable(struct uthread *uthread);
42 void pth_thread_paused(struct uthread *uthread);
43 void pth_thread_blockon_sysc(struct uthread *uthread, void *sysc);
44 void pth_thread_has_blocked(struct uthread *uthread, int flags);
45 void pth_thread_refl_fault(struct uthread *uthread, unsigned int trap_nr,
46                            unsigned int err, unsigned long aux);
47 void pth_preempt_pending(void);
48 void pth_spawn_thread(uintptr_t pc_start, void *data);
49
50 /* Event Handlers */
51 static void pth_handle_syscall(struct event_msg *ev_msg, unsigned int ev_type,
52                                void *data);
53
54 struct schedule_ops pthread_sched_ops = {
55         pth_sched_entry,
56         pth_thread_runnable,
57         pth_thread_paused,
58         pth_thread_blockon_sysc,
59         pth_thread_has_blocked,
60         pth_thread_refl_fault,
61         0, /* pth_preempt_pending, */
62         0, /* pth_spawn_thread, */
63 };
64 struct signal_ops pthread_signal_ops = {
65         .sigprocmask = pthread_sigmask,
66 };
67
68 /* Static helpers */
69 static void __pthread_free_stack(struct pthread_tcb *pt);
70 static int __pthread_allocate_stack(struct pthread_tcb *pt);
71 static void __pth_yield_cb(struct uthread *uthread, void *junk);
72
73 /* Swap the contents of two user contexts (not just their pointers). */
74 static void swap_user_contexts(struct user_context *c1, struct user_context *c2)
75 {
76         struct user_context temp_ctx;
77         temp_ctx = *c1;
78         *c1 = *c2;
79         *c2 = temp_ctx;
80 }
81
82 /* Prep a pthread to run a signal handler.  The original context of the pthread
83  * is saved, and a new context with a new stack is set up to run the signal
84  * handler the next time the pthread is run. */
85 static void __pthread_prep_sighandler(struct pthread_tcb *pthread,
86                                       void (*entry)(void),
87                                       struct siginfo *info)
88 {
89         struct user_context *ctx;
90
91         pthread->sigdata = alloc_sigdata();
92         if (info != NULL)
93                 pthread->sigdata->info = *info;
94         init_user_ctx(&pthread->sigdata->u_ctx,
95                       (uintptr_t)entry,
96                       (uintptr_t)pthread->sigdata->stack);
97         if (pthread->uthread.flags & UTHREAD_SAVED) {
98                 ctx = &pthread->uthread.u_ctx;
99                 if (pthread->uthread.flags & UTHREAD_FPSAVED) {
100                         pthread->sigdata->as = pthread->uthread.as;
101                         pthread->uthread.flags &= ~UTHREAD_FPSAVED;
102                 }
103         } else {
104                 assert(current_uthread == &pthread->uthread);
105                 ctx = &vcpd_of(vcore_id())->uthread_ctx;
106                 save_fp_state(&pthread->sigdata->as);
107         }
108         swap_user_contexts(ctx, &pthread->sigdata->u_ctx);
109 }
110
111 /* Restore the context saved as the result of running a signal handler on a
112  * pthread. This context will execute the next time the pthread is run. */
113 static void __pthread_restore_after_sighandler(struct pthread_tcb *pthread)
114 {
115         pthread->uthread.u_ctx = pthread->sigdata->u_ctx;
116         pthread->uthread.flags |= UTHREAD_SAVED;
117         if (pthread->uthread.u_ctx.type == ROS_HW_CTX) {
118                 pthread->uthread.as = pthread->sigdata->as;
119                 pthread->uthread.flags |= UTHREAD_FPSAVED;
120         }
121         free_sigdata(pthread->sigdata);
122         pthread->sigdata = NULL;
123 }
124
125 /* Callback when yielding a pthread after upon completion of a sighandler.  We
126  * didn't save the current context on yeild, but that's ok because here we
127  * restore the original saved context of the pthread and then treat this like a
128  * normal voluntary yield. */
129 static void __exit_sighandler_cb(struct uthread *uthread, void *junk)
130 {
131         __pthread_restore_after_sighandler((struct pthread_tcb*)uthread);
132         __pth_yield_cb(uthread, 0);
133 }
134
135 /* Run a specific sighandler from the top of the sigdata stack. The 'info'
136  * struct is prepopulated before the call is triggered as the result of a
137  * reflected fault. */
138 static void __run_sighandler()
139 {
140         struct pthread_tcb *me = pthread_self();
141         __sigdelset(&me->sigpending, me->sigdata->info.si_signo);
142         trigger_posix_signal(me->sigdata->info.si_signo,
143                              &me->sigdata->info,
144                              &me->sigdata->u_ctx);
145         uthread_yield(FALSE, __exit_sighandler_cb, 0);
146 }
147
148 /* Run through all pending sighandlers and trigger them with a NULL info field.
149  * These handlers are triggered as the result of a pthread_kill(), and thus
150  * don't require individual 'info' structs. */
151 static void __run_pending_sighandlers()
152 {
153         struct pthread_tcb *me = pthread_self();
154         sigset_t andset = me->sigpending & (~me->sigmask);
155         for (int i = 1; i < _NSIG; i++) {
156                 if (__sigismember(&andset, i)) {
157                         __sigdelset(&me->sigpending, i);
158                         trigger_posix_signal(i, NULL, &me->sigdata->u_ctx);
159                 }
160         }
161         uthread_yield(FALSE, __exit_sighandler_cb, 0);
162 }
163
164 /* If the given signal is unmasked, prep the pthread to run it's signal
165  * handler, but don't run it yet. In either case, make the pthread runnable
166  * again. Once the signal handler is complete, the original context will be
167  * restored and restarted. */
168 static void __pthread_signal_and_restart(struct pthread_tcb *pthread,
169                                           int signo, int code, void *addr)
170 {
171         if (!__sigismember(&pthread->sigmask, signo)) {
172                 if (pthread->sigdata) {
173                         printf("Pthread sighandler faulted, signal: %d\n", signo);
174                         /* uthread.c already copied out the faulting ctx into the uth */
175                         print_user_context(&pthread->uthread.u_ctx);
176                         exit(-1);
177                 }
178                 struct siginfo info = {0};
179                 info.si_signo = signo;
180                 info.si_code = code;
181                 info.si_addr = addr;
182                 __pthread_prep_sighandler(pthread, __run_sighandler, &info);
183         }
184         pth_thread_runnable(&pthread->uthread);
185 }
186
187 /* If there are any pending signals, prep the pthread to run it's signal
188  * handler. The next time the pthread is run, it will pop into it's signal
189  * handler context instead of its original saved context. Once the signal
190  * handler is complete, the original context will be restored and restarted. */
191 static void __pthread_prep_for_pending_posix_signals(pthread_t pthread)
192 {
193         if (!pthread->sigdata && pthread->sigpending) {
194                 sigset_t andset = pthread->sigpending & (~pthread->sigmask);
195                 if (!__sigisemptyset(&andset)) {
196                         __pthread_prep_sighandler(pthread, __run_pending_sighandlers, NULL);
197                 }
198         }
199 }
200
201 /* Called from vcore entry.  Options usually include restarting whoever was
202  * running there before or running a new thread.  Events are handled out of
203  * event.c (table of function pointers, stuff like that). */
204 void __attribute__((noreturn)) pth_sched_entry(void)
205 {
206         uint32_t vcoreid = vcore_id();
207         if (current_uthread) {
208                 /* Prep the pthread to run any pending posix signal handlers registered
209          * via pthread_kill once it is restored. */
210                 __pthread_prep_for_pending_posix_signals((pthread_t)current_uthread);
211                 /* Run the thread itself */
212                 run_current_uthread();
213                 assert(0);
214         }
215         /* no one currently running, so lets get someone from the ready queue */
216         struct pthread_tcb *new_thread = NULL;
217         /* Try to get a thread.  If we get one, we'll break out and run it.  If not,
218          * we'll try to yield.  vcore_yield() might return, if we lost a race and
219          * had a new event come in, one that may make us able to get a new_thread */
220         do {
221                 handle_events(vcoreid);
222                 __check_preempt_pending(vcoreid);
223                 mcs_pdr_lock(&queue_lock);
224                 new_thread = TAILQ_FIRST(&ready_queue);
225                 if (new_thread) {
226                         TAILQ_REMOVE(&ready_queue, new_thread, tq_next);
227                         TAILQ_INSERT_TAIL(&active_queue, new_thread, tq_next);
228                         threads_active++;
229                         threads_ready--;
230                         mcs_pdr_unlock(&queue_lock);
231                         /* If you see what looks like the same uthread running in multiple
232                          * places, your list might be jacked up.  Turn this on. */
233                         printd("[P] got uthread %08p on vc %d state %08p flags %08p\n",
234                                new_thread, vcoreid,
235                                ((struct uthread*)new_thread)->state,
236                                ((struct uthread*)new_thread)->flags);
237                         break;
238                 }
239                 mcs_pdr_unlock(&queue_lock);
240                 /* no new thread, try to yield */
241                 printd("[P] No threads, vcore %d is yielding\n", vcore_id());
242                 /* TODO: you can imagine having something smarter here, like spin for a
243                  * bit before yielding (or not at all if you want to be greedy). */
244                 if (can_adjust_vcores)
245                         vcore_yield(FALSE);
246                 if (!parlib_wants_to_be_mcp)
247                         sys_yield(FALSE);
248         } while (1);
249         assert(new_thread->state == PTH_RUNNABLE);
250         /* Prep the pthread to run any pending posix signal handlers registered
251      * via pthread_kill once it is restored. */
252         __pthread_prep_for_pending_posix_signals(new_thread);
253         /* Run the thread itself */
254         run_uthread((struct uthread*)new_thread);
255         assert(0);
256 }
257
258 /* Could move this, along with start_routine and arg, into the 2LSs */
259 static void __pthread_run(void)
260 {
261         struct pthread_tcb *me = pthread_self();
262         pthread_exit(me->start_routine(me->arg));
263 }
264
265 /* GIANT WARNING: if you make any changes to this, also change the broadcast
266  * wakeups (cond var, barrier, etc) */
267 void pth_thread_runnable(struct uthread *uthread)
268 {
269         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
270         /* At this point, the 2LS can see why the thread blocked and was woken up in
271          * the first place (coupling these things together).  On the yield path, the
272          * 2LS was involved and was able to set the state.  Now when we get the
273          * thread back, we can take a look. */
274         printd("pthread %08p runnable, state was %d\n", pthread, pthread->state);
275         switch (pthread->state) {
276                 case (PTH_CREATED):
277                 case (PTH_BLK_YIELDING):
278                 case (PTH_BLK_JOINING):
279                 case (PTH_BLK_SYSC):
280                 case (PTH_BLK_PAUSED):
281                 case (PTH_BLK_MUTEX):
282                         /* can do whatever for each of these cases */
283                         break;
284                 default:
285                         printf("Odd state %d for pthread %08p\n", pthread->state, pthread);
286         }
287         pthread->state = PTH_RUNNABLE;
288         /* Insert the newly created thread into the ready queue of threads.
289          * It will be removed from this queue later when vcore_entry() comes up */
290         mcs_pdr_lock(&queue_lock);
291         /* Again, GIANT WARNING: if you change this, change batch wakeup code */
292         TAILQ_INSERT_TAIL(&ready_queue, pthread, tq_next);
293         threads_ready++;
294         mcs_pdr_unlock(&queue_lock);
295         /* Smarter schedulers should look at the num_vcores() and how much work is
296          * going on to make a decision about how many vcores to request. */
297         if (can_adjust_vcores)
298                 vcore_request(threads_ready);
299 }
300
301 /* For some reason not under its control, the uthread stopped running (compared
302  * to yield, which was caused by uthread/2LS code).
303  *
304  * The main case for this is if the vcore was preempted or if the vcore it was
305  * running on needed to stop.  You are given a uthread that looks like it took a
306  * notif, and had its context/silly state copied out to the uthread struct.
307  * (copyout_uthread).  Note that this will be called in the context (TLS) of the
308  * vcore that is losing the uthread.  If that vcore is running, it'll be in a
309  * preempt-event handling loop (not in your 2LS code).  If this is a big
310  * problem, I'll change it. */
311 void pth_thread_paused(struct uthread *uthread)
312 {
313         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
314         /* Remove from the active list.  Note that I don't particularly care about
315          * the active list.  We keep it around because it causes bugs and keeps us
316          * honest.  After all, some 2LS may want an active list */
317         mcs_pdr_lock(&queue_lock);
318         threads_active--;
319         TAILQ_REMOVE(&active_queue, pthread, tq_next);
320         mcs_pdr_unlock(&queue_lock);
321         /* communicate to pth_thread_runnable */
322         pthread->state = PTH_BLK_PAUSED;
323         /* At this point, you could do something clever, like put it at the front of
324          * the runqueue, see if it was holding a lock, do some accounting, or
325          * whatever. */
326         pth_thread_runnable(uthread);
327 }
328
329 /* Restarts a uthread hanging off a syscall.  For the simple pthread case, we
330  * just make it runnable and let the main scheduler code handle it. */
331 static void restart_thread(struct syscall *sysc)
332 {
333         struct uthread *ut_restartee = (struct uthread*)sysc->u_data;
334         /* uthread stuff here: */
335         assert(ut_restartee);
336         assert(((struct pthread_tcb*)ut_restartee)->state == PTH_BLK_SYSC);
337         assert(ut_restartee->sysc == sysc);     /* set in uthread.c */
338         ut_restartee->sysc = 0; /* so we don't 'reblock' on this later */
339         pth_thread_runnable(ut_restartee);
340 }
341
342 /* This handler is usually run in vcore context, though I can imagine it being
343  * called by a uthread in some other threading library. */
344 static void pth_handle_syscall(struct event_msg *ev_msg, unsigned int ev_type,
345                                void *data)
346 {
347         struct syscall *sysc;
348         assert(in_vcore_context());
349         /* if we just got a bit (not a msg), it should be because the process is
350          * still an SCP and hasn't started using the MCP ev_q yet (using the simple
351          * ev_q and glibc's blockon) or because the bit is still set from an old
352          * ev_q (blocking syscalls from before we could enter vcore ctx).  Either
353          * way, just return.  Note that if you screwed up the pth ev_q and made it
354          * NO_MSG, you'll never notice (we used to assert(ev_msg)). */
355         if (!ev_msg)
356                 return;
357         /* It's a bug if we don't have a msg (we're handling a syscall bit-event) */
358         assert(ev_msg);
359         /* Get the sysc from the message and just restart it */
360         sysc = ev_msg->ev_arg3;
361         assert(sysc);
362         restart_thread(sysc);
363 }
364
365 /* This will be called from vcore context, after the current thread has yielded
366  * and is trying to block on sysc.  Need to put it somewhere were we can wake it
367  * up when the sysc is done.  For now, we'll have the kernel send us an event
368  * when the syscall is done. */
369 void pth_thread_blockon_sysc(struct uthread *uthread, void *syscall)
370 {
371         struct syscall *sysc = (struct syscall*)syscall;
372         int old_flags;
373         uint32_t vcoreid = vcore_id();
374         /* rip from the active queue */
375         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
376         pthread->state = PTH_BLK_SYSC;
377         mcs_pdr_lock(&queue_lock);
378         threads_active--;
379         TAILQ_REMOVE(&active_queue, pthread, tq_next);
380         mcs_pdr_unlock(&queue_lock);
381         /* Set things up so we can wake this thread up later */
382         sysc->u_data = uthread;
383         /* Register our vcore's syscall ev_q to hear about this syscall. */
384         if (!register_evq(sysc, sysc_mgmt[vcoreid].ev_q)) {
385                 /* Lost the race with the call being done.  The kernel won't send the
386                  * event.  Just restart him. */
387                 restart_thread(sysc);
388         }
389         /* GIANT WARNING: do not touch the thread after this point. */
390 }
391
392 void pth_thread_has_blocked(struct uthread *uthread, int flags)
393 {
394         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
395         /* could imagine doing something with the flags.  For now, we just treat all
396          * externally blocked reasons as 'MUTEX'.  Whatever we do here, we are
397          * mostly communicating to our future selves in pth_thread_runnable(), which
398          * gets called by whoever triggered this callback */
399         pthread->state = PTH_BLK_MUTEX;
400         /* Just for yucks: */
401         if (flags == UTH_EXT_BLK_JUSTICE)
402                 printf("For great justice!\n");
403 }
404
405 static void handle_div_by_zero(struct uthread *uthread, unsigned int err,
406                                unsigned long aux)
407 {
408         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
409         __pthread_signal_and_restart(pthread, SIGFPE, FPE_INTDIV, (void*)aux);
410 }
411
412 static void handle_gp_fault(struct uthread *uthread, unsigned int err,
413                             unsigned long aux)
414 {
415         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
416         __pthread_signal_and_restart(pthread, SIGSEGV, SEGV_ACCERR, (void*)aux);
417 }
418
419 static void handle_page_fault(struct uthread *uthread, unsigned int err,
420                               unsigned long aux)
421 {
422         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
423         if (!(err & PF_VMR_BACKED)) {
424                 __pthread_signal_and_restart(pthread, SIGSEGV, SEGV_MAPERR, (void*)aux);
425         } else {
426                 /* stitching for the event handler.  sysc -> uth, uth -> sysc */
427                 uthread->local_sysc.u_data = uthread;
428                 uthread->sysc = &uthread->local_sysc;
429                 pthread->state = PTH_BLK_SYSC;
430                 /* one downside is that we'll never check the return val of the syscall.  if
431                  * we errored out, we wouldn't know til we PF'd again, and inspected the old
432                  * retval/err and other sysc fields (make sure the PF is on the same addr,
433                  * etc).  could run into this issue on truncated files too. */
434                 syscall_async(&uthread->local_sysc, SYS_populate_va, aux, 1);
435                 if (!register_evq(&uthread->local_sysc, sysc_mgmt[vcore_id()].ev_q)) {
436                         /* Lost the race with the call being done.  The kernel won't send the
437                          * event.  Just restart him. */
438                         restart_thread(&uthread->local_sysc);
439                 }
440         }
441 }
442
443 void pth_thread_refl_fault(struct uthread *uthread, unsigned int trap_nr,
444                            unsigned int err, unsigned long aux)
445 {
446         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
447         pthread->state = PTH_BLK_SYSC;
448         mcs_pdr_lock(&queue_lock);
449         threads_active--;
450         TAILQ_REMOVE(&active_queue, pthread, tq_next);
451         mcs_pdr_unlock(&queue_lock);
452
453         /* TODO: RISCV/x86 issue! (0 is divby0, 14 is PF, etc) */
454 #if defined(__i386__) || defined(__x86_64__) 
455         switch(trap_nr) {
456                 case 0:
457                         handle_div_by_zero(uthread, err, aux);
458                         break;
459                 case 13:
460                         handle_gp_fault(uthread, err, aux);
461                         break;
462                 case 14:
463                         handle_page_fault(uthread, err, aux);
464                         break;
465                 default:
466                         printf("Pthread has unhandled fault: %d\n", trap_nr);
467                         /* Note that uthread.c already copied out our ctx into the uth struct */
468                         print_user_context(&uthread->u_ctx);
469                         exit(-1);
470         }
471 #else
472         #error "Handling hardware faults is currently only supported on x86"
473 #endif
474 }
475
476 void pth_preempt_pending(void)
477 {
478 }
479
480 void pth_spawn_thread(uintptr_t pc_start, void *data)
481 {
482 }
483
484 /* Akaros pthread extensions / hacks */
485
486 /* Tells the pthread 2LS to not change the number of vcores.  This means it will
487  * neither request vcores nor yield vcores.  Only used for testing. */
488 void pthread_can_vcore_request(bool can)
489 {
490         /* checked when we would request or yield */
491         can_adjust_vcores = can;
492 }
493
494 void pthread_need_tls(bool need)
495 {
496         need_tls = need;
497 }
498
499 /* Pthread interface stuff and helpers */
500
501 int pthread_attr_init(pthread_attr_t *a)
502 {
503         a->stackaddr = 0;
504         a->stacksize = PTHREAD_STACK_SIZE;
505         a->detachstate = PTHREAD_CREATE_JOINABLE;
506         /* priority and policy should be set by anyone changing inherit. */
507         a->sched_priority = 0;
508         a->sched_policy = 0;
509         a->sched_inherit = PTHREAD_INHERIT_SCHED;
510         return 0;
511 }
512
513 int pthread_attr_destroy(pthread_attr_t *a)
514 {
515         return 0;
516 }
517
518 static void __pthread_free_stack(struct pthread_tcb *pt)
519 {
520         int ret = munmap(pt->stacktop - pt->stacksize, pt->stacksize);
521         assert(!ret);
522 }
523
524 static int __pthread_allocate_stack(struct pthread_tcb *pt)
525 {
526         assert(pt->stacksize);
527         void* stackbot = mmap(0, pt->stacksize,
528                               PROT_READ|PROT_WRITE|PROT_EXEC,
529                               MAP_POPULATE|MAP_ANONYMOUS, -1, 0);
530         if (stackbot == MAP_FAILED)
531                 return -1; // errno set by mmap
532         pt->stacktop = stackbot + pt->stacksize;
533         return 0;
534 }
535
536 // Warning, this will reuse numbers eventually
537 static int get_next_pid(void)
538 {
539         static uint32_t next_pid = 0;
540         return next_pid++;
541 }
542
543 int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize)
544 {
545         attr->stacksize = stacksize;
546         return 0;
547 }
548
549 int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize)
550 {
551         *stacksize = attr->stacksize;
552         return 0;
553 }
554
555 int pthread_attr_setguardsize(pthread_attr_t *attr, size_t guardsize)
556 {
557         attr->guardsize = guardsize;
558         return 0;
559 }
560
561 int pthread_attr_getguardsize(pthread_attr_t *attr, size_t *guardsize)
562 {
563         *guardsize = attr->guardsize;
564         return 0;
565 }
566
567 int pthread_attr_getstack(const pthread_attr_t *__restrict __attr,
568                                                    void **__stackaddr, size_t *__stacksize)
569 {
570         *__stackaddr = __attr->stackaddr;
571         *__stacksize = __attr->stacksize;
572         return 0;
573 }
574
575 int pthread_getattr_np(pthread_t __th, pthread_attr_t *__attr)
576 {
577         __attr->stackaddr = __th->stacktop - __th->stacksize;
578         __attr->stacksize = __th->stacksize;
579         if (__th->detached)
580                 __attr->detachstate = PTHREAD_CREATE_DETACHED;
581         else
582                 __attr->detachstate = PTHREAD_CREATE_JOINABLE;
583         return 0;
584 }
585
586 /* Do whatever init you want.  At some point call uthread_2ls_init() and pass it
587  * a uthread representing thread0 (int main()) */
588 void __attribute__((constructor)) pthread_lib_init(void)
589 {
590         uintptr_t mmap_block;
591         struct pthread_tcb *t;
592         int ret;
593
594         /* Only run once, but make sure that uthread_lib_init() has run already. */
595         init_once_racy(return);
596         uthread_lib_init();
597
598         /* Publish our sched_ops and signal_ops, overriding the defaults */
599         sched_ops = &pthread_sched_ops;
600         signal_ops = &pthread_signal_ops;
601
602         mcs_pdr_init(&queue_lock);
603         /* Create a pthread_tcb for the main thread */
604         ret = posix_memalign((void**)&t, __alignof__(struct pthread_tcb),
605                              sizeof(struct pthread_tcb));
606         assert(!ret);
607         memset(t, 0, sizeof(struct pthread_tcb));       /* aggressively 0 for bugs */
608         t->id = get_next_pid();
609         t->stacksize = USTACK_NUM_PAGES * PGSIZE;
610         t->stacktop = (void*)USTACKTOP;
611         t->detached = TRUE;
612         t->state = PTH_RUNNING;
613         t->joiner = 0;
614         /* implies that sigmasks are longs, which they are. */
615         t->sigmask = 0;
616         __sigemptyset(&t->sigpending);
617         assert(t->id == 0);
618         t->sched_policy = SCHED_FIFO;
619         t->sched_priority = 0;
620         /* Put the new pthread (thread0) on the active queue */
621         mcs_pdr_lock(&queue_lock);
622         threads_active++;
623         TAILQ_INSERT_TAIL(&active_queue, t, tq_next);
624         mcs_pdr_unlock(&queue_lock);
625         /* Tell the kernel where and how we want to receive events.  This is just an
626          * example of what to do to have a notification turned on.  We're turning on
627          * USER_IPIs, posting events to vcore 0's vcpd, and telling the kernel to
628          * send to vcore 0.  Note sys_self_notify will ignore the vcoreid and
629          * private preference.  Also note that enable_kevent() is just an example,
630          * and you probably want to use parts of event.c to do what you want. */
631         enable_kevent(EV_USER_IPI, 0, EVENT_IPI | EVENT_VCORE_PRIVATE);
632
633         /* Handle syscall events. */
634         register_ev_handler(EV_SYSCALL, pth_handle_syscall, 0);
635         /* Set up the per-vcore structs to track outstanding syscalls */
636         sysc_mgmt = malloc(sizeof(struct sysc_mgmt) * max_vcores());
637         assert(sysc_mgmt);
638 #if 1   /* Independent ev_mboxes per vcore */
639         /* Get a block of pages for our per-vcore (but non-VCPD) ev_qs */
640         mmap_block = (uintptr_t)mmap(0, PGSIZE * 2 * max_vcores(),
641                                      PROT_WRITE | PROT_READ,
642                                      MAP_POPULATE | MAP_ANONYMOUS, -1, 0);
643         assert(mmap_block);
644         /* Could be smarter and do this on demand (in case we don't actually want
645          * max_vcores()). */
646         for (int i = 0; i < max_vcores(); i++) {
647                 /* Each vcore needs to point to a non-VCPD ev_q */
648                 sysc_mgmt[i].ev_q = get_big_event_q_raw();
649                 sysc_mgmt[i].ev_q->ev_flags = EVENT_IPI | EVENT_INDIR | EVENT_FALLBACK;
650                 sysc_mgmt[i].ev_q->ev_vcore = i;
651                 ucq_init_raw(&sysc_mgmt[i].ev_q->ev_mbox->ev_msgs, 
652                              mmap_block + (2 * i    ) * PGSIZE, 
653                              mmap_block + (2 * i + 1) * PGSIZE); 
654         }
655         /* Technically, we should munmap and free what we've alloc'd, but the
656          * kernel will clean it up for us when we exit. */
657 #endif 
658 #if 0   /* One global ev_mbox, separate ev_q per vcore */
659         struct event_mbox *sysc_mbox = malloc(sizeof(struct event_mbox));
660         uintptr_t two_pages = (uintptr_t)mmap(0, PGSIZE * 2, PROT_WRITE | PROT_READ,
661                                               MAP_POPULATE | MAP_ANONYMOUS, -1, 0);
662         printd("Global ucq: %08p\n", &sysc_mbox->ev_msgs);
663         assert(sysc_mbox);
664         assert(two_pages);
665         memset(sysc_mbox, 0, sizeof(struct event_mbox));
666         ucq_init_raw(&sysc_mbox->ev_msgs, two_pages, two_pages + PGSIZE);
667         for (int i = 0; i < max_vcores(); i++) {
668                 sysc_mgmt[i].ev_q = get_event_q();
669                 sysc_mgmt[i].ev_q->ev_flags = EVENT_IPI | EVENT_INDIR | EVENT_FALLBACK;
670                 sysc_mgmt[i].ev_q->ev_vcore = i;
671                 sysc_mgmt[i].ev_q->ev_mbox = sysc_mbox;
672         }
673 #endif
674         uthread_2ls_init((struct uthread*)t);
675         atomic_init(&threads_total, 1);                 /* one for thread0 */
676 }
677
678 /* Make sure our scheduler runs inside an MCP rather than an SCP. */
679 void pthread_mcp_init()
680 {
681         /* Prevent this from happening more than once. */
682         init_once_racy(return);
683
684         if (!parlib_wants_to_be_mcp) {
685                 /* sign to whether or not we ask for more vcores.  actually, if we're
686                  * an SCP, the current kernel will ignore our requests, but best to not
687                  * rely on that. */
688                 can_adjust_vcores = FALSE;
689                 return;
690         }
691         uthread_mcp_init();
692         /* From here forward we are an MCP running on vcore 0. Could consider doing
693          * other pthread specific initialization based on knowing we are an mcp
694          * after this point. */
695 }
696
697 int __pthread_create(pthread_t *thread, const pthread_attr_t *attr,
698                      void *(*start_routine)(void *), void *arg)
699 {
700         struct uth_thread_attr uth_attr = {0};
701         struct pthread_tcb *parent;
702         struct pthread_tcb *pthread;
703         int ret;
704
705         /* For now, unconditionally become an mcp when creating a pthread (if not
706          * one already). This may change in the future once we support 2LSs in an
707          * SCP. */
708         pthread_mcp_init();
709
710         parent = (struct pthread_tcb*)current_uthread;
711         ret = posix_memalign((void**)&pthread, __alignof__(struct pthread_tcb),
712                              sizeof(struct pthread_tcb));
713         assert(!ret);
714         memset(pthread, 0, sizeof(struct pthread_tcb)); /* aggressively 0 for bugs*/
715         pthread->stacksize = PTHREAD_STACK_SIZE;        /* default */
716         pthread->state = PTH_CREATED;
717         pthread->id = get_next_pid();
718         pthread->detached = FALSE;                              /* default */
719         pthread->joiner = 0;
720         pthread->sigmask = ((pthread_t)current_uthread)->sigmask;
721         __sigemptyset(&pthread->sigpending);
722         pthread->sigdata = NULL;
723         /* Might override these later, based on attr && EXPLICIT_SCHED */
724         pthread->sched_policy = parent->sched_policy;
725         pthread->sched_priority = parent->sched_priority;
726         /* Respect the attributes */
727         if (attr) {
728                 if (attr->stacksize)                                    /* don't set a 0 stacksize */
729                         pthread->stacksize = attr->stacksize;
730                 if (attr->detachstate == PTHREAD_CREATE_DETACHED)
731                         pthread->detached = TRUE;
732                 if (attr->sched_inherit == PTHREAD_EXPLICIT_SCHED) {
733                         pthread->sched_policy = attr->sched_policy;
734                         pthread->sched_priority = attr->sched_priority;
735                 }
736         }
737         /* allocate a stack */
738         if (__pthread_allocate_stack(pthread))
739                 printf("We're fucked\n");
740         /* Set the u_tf to start up in __pthread_run, which will call the real
741          * start_routine and pass it the arg.  Note those aren't set until later in
742          * pthread_create(). */
743         init_user_ctx(&pthread->uthread.u_ctx, (uintptr_t)&__pthread_run,
744                       (uintptr_t)(pthread->stacktop));
745         pthread->start_routine = start_routine;
746         pthread->arg = arg;
747         /* Initialize the uthread */
748         if (need_tls)
749                 uth_attr.want_tls = TRUE;
750         uthread_init((struct uthread*)pthread, &uth_attr);
751         *thread = pthread;
752         atomic_inc(&threads_total);
753         return 0;
754 }
755
756 int pthread_create(pthread_t *thread, const pthread_attr_t *attr,
757                    void *(*start_routine)(void *), void *arg)
758 {
759         if (!__pthread_create(thread, attr, start_routine, arg))
760                 pth_thread_runnable((struct uthread*)*thread);
761         return 0;
762 }
763
764 /* Helper that all pthread-controlled yield paths call.  Just does some
765  * accounting.  This is another example of how the much-loathed (and loved)
766  * active queue is keeping us honest.  Need to export for sem and friends. */
767 void __pthread_generic_yield(struct pthread_tcb *pthread)
768 {
769         mcs_pdr_lock(&queue_lock);
770         threads_active--;
771         TAILQ_REMOVE(&active_queue, pthread, tq_next);
772         mcs_pdr_unlock(&queue_lock);
773 }
774
775 /* Callback/bottom half of join, called from __uthread_yield (vcore context).
776  * join_target is who we are trying to join on (and who is calling exit). */
777 static void __pth_join_cb(struct uthread *uthread, void *arg)
778 {
779         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
780         struct pthread_tcb *join_target = (struct pthread_tcb*)arg;
781         struct pthread_tcb *temp_pth = 0;
782         __pthread_generic_yield(pthread);
783         /* We're trying to join, yield til we get woken up */
784         pthread->state = PTH_BLK_JOINING;       /* could do this front-side */
785         /* Put ourselves in the join target's joiner slot.  If we get anything back,
786          * we lost the race and need to wake ourselves.  Syncs with __pth_exit_cb.*/
787         temp_pth = atomic_swap_ptr((void**)&join_target->joiner, pthread);
788         /* After that atomic swap, the pthread might be woken up (if it succeeded),
789          * so don't touch pthread again after that (this following if () is okay).*/
790         if (temp_pth) {         /* temp_pth != 0 means they exited first */
791                 assert(temp_pth == join_target);        /* Sanity */
792                 /* wake ourselves, not the exited one! */
793                 printd("[pth] %08p already exit, rewaking ourselves, joiner %08p\n",
794                        temp_pth, pthread);
795                 pth_thread_runnable(uthread);   /* wake ourselves */
796         }
797 }
798
799 int pthread_join(struct pthread_tcb *join_target, void **retval)
800 {
801         /* Not sure if this is the right semantics.  There is a race if we deref
802          * join_target and he is already freed (which would have happened if he was
803          * detached. */
804         if (join_target->detached) {
805                 printf("[pthread] trying to join on a detached pthread");
806                 return -1;
807         }
808         /* See if it is already done, to avoid the pain of a uthread_yield() (the
809          * early check is an optimization, pth_thread_yield() handles the race). */
810         if (!join_target->joiner) {
811                 uthread_yield(TRUE, __pth_join_cb, join_target);
812                 /* When we return/restart, the thread will be done */
813         } else {
814                 assert(join_target->joiner == join_target);     /* sanity check */
815         }
816         if (retval)
817                 *retval = join_target->retval;
818         free(join_target);
819         return 0;
820 }
821
822 /* Callback/bottom half of exit.  Syncs with __pth_join_cb.  Here's how it
823  * works: the slot for joiner is initially 0.  Joiners try to swap themselves
824  * into that spot.  Exiters try to put 'themselves' into it.  Whoever gets 0
825  * back won the race.  If the exiter lost the race, it must wake up the joiner
826  * (which was the value from temp_pth).  If the joiner lost the race, it must
827  * wake itself up, and for sanity reasons can ensure the value from temp_pth is
828  * the join target). */
829 static void __pth_exit_cb(struct uthread *uthread, void *junk)
830 {
831         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
832         struct pthread_tcb *temp_pth = 0;
833         __pthread_generic_yield(pthread);
834         /* Catch some bugs */
835         pthread->state = PTH_EXITING;
836         /* Destroy the pthread */
837         uthread_cleanup(uthread);
838         /* Cleanup, mirroring pthread_create() */
839         __pthread_free_stack(pthread);
840         /* TODO: race on detach state (see join) */
841         if (pthread->detached) {
842                 free(pthread);
843         } else {
844                 /* See if someone is joining on us.  If not, we're done (and the
845                  * joiner will wake itself when it saw us there instead of 0). */
846                 temp_pth = atomic_swap_ptr((void**)&pthread->joiner, pthread);
847                 if (temp_pth) {
848                         /* they joined before we exited, we need to wake them */
849                         printd("[pth] %08p exiting, waking joiner %08p\n",
850                                pthread, temp_pth);
851                         pth_thread_runnable((struct uthread*)temp_pth);
852                 }
853         }
854         /* If we were the last pthread, we exit for the whole process.  Keep in mind
855          * that thread0 is counted in this, so this will only happen if that thread
856          * calls pthread_exit(). */
857         if ((atomic_fetch_and_add(&threads_total, -1) == 1))
858                 exit(0);
859 }
860
861 void pthread_exit(void *ret)
862 {
863         struct pthread_tcb *pthread = pthread_self();
864         pthread->retval = ret;
865         destroy_dtls();
866         uthread_yield(FALSE, __pth_exit_cb, 0);
867 }
868
869 /* Callback/bottom half of yield.  For those writing these pth callbacks, the
870  * minimum is call generic, set state (communicate with runnable), then do
871  * something that causes it to be runnable in the future (or right now). */
872 static void __pth_yield_cb(struct uthread *uthread, void *junk)
873 {
874         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
875         __pthread_generic_yield(pthread);
876         pthread->state = PTH_BLK_YIELDING;
877         /* just immediately restart it */
878         pth_thread_runnable(uthread);
879 }
880
881 /* Cooperative yielding of the processor, to allow other threads to run */
882 int pthread_yield(void)
883 {
884         uthread_yield(TRUE, __pth_yield_cb, 0);
885         return 0;
886 }
887
888 int pthread_mutexattr_init(pthread_mutexattr_t* attr)
889 {
890   attr->type = PTHREAD_MUTEX_DEFAULT;
891   return 0;
892 }
893
894 int pthread_mutexattr_destroy(pthread_mutexattr_t* attr)
895 {
896   return 0;
897 }
898
899 int pthread_attr_setdetachstate(pthread_attr_t *__attr, int __detachstate)
900 {
901         __attr->detachstate = __detachstate;
902         return 0;
903 }
904
905 int pthread_mutexattr_gettype(const pthread_mutexattr_t* attr, int* type)
906 {
907   *type = attr ? attr->type : PTHREAD_MUTEX_DEFAULT;
908   return 0;
909 }
910
911 int pthread_mutexattr_settype(pthread_mutexattr_t* attr, int type)
912 {
913   if(type != PTHREAD_MUTEX_NORMAL)
914     return EINVAL;
915   attr->type = type;
916   return 0;
917 }
918
919 int pthread_mutex_init(pthread_mutex_t* m, const pthread_mutexattr_t* attr)
920 {
921   m->attr = attr;
922   atomic_init(&m->lock, 0);
923   return 0;
924 }
925
926 /* Helper for spinning sync, returns TRUE if it is okay to keep spinning.
927  *
928  * Alternatives include:
929  *              old_count <= num_vcores() (barrier code, pass in old_count as *state, 
930  *                                         but this only works if every awake pthread
931  *                                         will belong to the barrier).
932  *              just spin for a bit       (use *state to track spins)
933  *              FALSE                     (always is safe)
934  *              etc...
935  * 'threads_ready' isn't too great since sometimes it'll be non-zero when it is
936  * about to become 0.  We really want "I have no threads waiting to run that
937  * aren't going to run on their on unless this core yields instead of spins". */
938 /* TODO: consider making this a 2LS op */
939 static inline bool safe_to_spin(unsigned int *state)
940 {
941         return !threads_ready;
942 }
943
944 /* Set *spun to 0 when calling this the first time.  It will yield after 'spins'
945  * calls.  Use this for adaptive mutexes and such. */
946 static inline void spin_to_sleep(unsigned int spins, unsigned int *spun)
947 {
948         if ((*spun)++ == spins) {
949                 pthread_yield();
950                 *spun = 0;
951         }
952 }
953
954 int pthread_mutex_lock(pthread_mutex_t* m)
955 {
956         unsigned int spinner = 0;
957         while(pthread_mutex_trylock(m))
958                 while(*(volatile size_t*)&m->lock) {
959                         cpu_relax();
960                         spin_to_sleep(PTHREAD_MUTEX_SPINS, &spinner);
961                 }
962         /* normally we'd need a wmb() and a wrmb() after locking, but the
963          * atomic_swap handles the CPU mb(), so just a cmb() is necessary. */
964         cmb();
965         return 0;
966 }
967
968 int pthread_mutex_trylock(pthread_mutex_t* m)
969 {
970   return atomic_swap(&m->lock, 1) == 0 ? 0 : EBUSY;
971 }
972
973 int pthread_mutex_unlock(pthread_mutex_t* m)
974 {
975   /* keep reads and writes inside the protected region */
976   rwmb();
977   wmb();
978   atomic_set(&m->lock, 0);
979   return 0;
980 }
981
982 int pthread_mutex_destroy(pthread_mutex_t* m)
983 {
984   return 0;
985 }
986
987 int pthread_cond_init(pthread_cond_t *c, const pthread_condattr_t *a)
988 {
989         SLIST_INIT(&c->waiters);
990         spin_pdr_init(&c->spdr_lock);
991         if (a) {
992                 c->attr_pshared = a->pshared;
993                 c->attr_clock = a->clock;
994         } else {
995                 c->attr_pshared = PTHREAD_PROCESS_PRIVATE;
996                 c->attr_clock = 0;
997         }
998         return 0;
999 }
1000
1001 int pthread_cond_destroy(pthread_cond_t *c)
1002 {
1003         return 0;
1004 }
1005
1006 static void swap_slists(struct pthread_list *a, struct pthread_list *b)
1007 {
1008         struct pthread_list temp;
1009         temp = *a;
1010         *a = *b;
1011         *b = temp;
1012 }
1013
1014 static void wake_slist(struct pthread_list *to_wake)
1015 {
1016         unsigned int nr_woken = 0;      /* assuming less than 4 bil threads */
1017         struct pthread_tcb *pthread_i, *pth_temp;
1018         /* Amortize the lock grabbing over all restartees */
1019         mcs_pdr_lock(&queue_lock);
1020         /* Do the work of pth_thread_runnable().  We're in uth context here, but I
1021          * think it's okay.  When we need to (when locking) we drop into VC ctx, as
1022          * far as the kernel and other cores are concerned. */
1023         SLIST_FOREACH_SAFE(pthread_i, to_wake, sl_next, pth_temp) {
1024                 pthread_i->state = PTH_RUNNABLE;
1025                 nr_woken++;
1026                 TAILQ_INSERT_TAIL(&ready_queue, pthread_i, tq_next);
1027         }
1028         threads_ready += nr_woken;
1029         mcs_pdr_unlock(&queue_lock);
1030         if (can_adjust_vcores)
1031                 vcore_request(threads_ready);
1032 }
1033
1034 int pthread_cond_broadcast(pthread_cond_t *c)
1035 {
1036         struct pthread_list restartees = SLIST_HEAD_INITIALIZER(restartees);
1037         spin_pdr_lock(&c->spdr_lock);
1038         swap_slists(&restartees, &c->waiters);
1039         spin_pdr_unlock(&c->spdr_lock);
1040         wake_slist(&restartees);
1041         return 0;
1042 }
1043
1044 /* spec says this needs to work regardless of whether or not it holds the mutex
1045  * already. */
1046 int pthread_cond_signal(pthread_cond_t *c)
1047 {
1048         struct pthread_tcb *pthread;
1049         spin_pdr_lock(&c->spdr_lock);
1050         pthread = SLIST_FIRST(&c->waiters);
1051         if (!pthread) {
1052                 spin_pdr_unlock(&c->spdr_lock);
1053                 return 0;
1054         }
1055         SLIST_REMOVE_HEAD(&c->waiters, sl_next);
1056         spin_pdr_unlock(&c->spdr_lock);
1057         pth_thread_runnable((struct uthread*)pthread);
1058         return 0;
1059 }
1060
1061 /* Communicate btw cond_wait and its callback */
1062 struct cond_junk {
1063         pthread_cond_t                          *c;
1064         pthread_mutex_t                         *m;
1065 };
1066
1067 /* Callback/bottom half of cond wait.  For those writing these pth callbacks,
1068  * the minimum is call generic, set state (communicate with runnable), then do
1069  * something that causes it to be runnable in the future (or right now). */
1070 static void __pth_wait_cb(struct uthread *uthread, void *junk)
1071 {
1072         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
1073         pthread_cond_t *c = ((struct cond_junk*)junk)->c;
1074         pthread_mutex_t *m = ((struct cond_junk*)junk)->m;
1075         /* this removes us from the active list; we can reuse next below */
1076         __pthread_generic_yield(pthread);
1077         pthread->state = PTH_BLK_MUTEX;
1078         spin_pdr_lock(&c->spdr_lock);
1079         SLIST_INSERT_HEAD(&c->waiters, pthread, sl_next);
1080         spin_pdr_unlock(&c->spdr_lock);
1081         pthread_mutex_unlock(m);
1082 }
1083
1084 int pthread_cond_wait(pthread_cond_t *c, pthread_mutex_t *m)
1085 {
1086         struct cond_junk local_junk;
1087         local_junk.c = c;
1088         local_junk.m = m;
1089         uthread_yield(TRUE, __pth_wait_cb, &local_junk);
1090         pthread_mutex_lock(m);
1091         return 0;
1092 }
1093
1094 int pthread_condattr_init(pthread_condattr_t *a)
1095 {
1096         a->pshared = PTHREAD_PROCESS_PRIVATE;
1097         a->clock = 0;
1098         return 0;
1099 }
1100
1101 int pthread_condattr_destroy(pthread_condattr_t *a)
1102 {
1103         return 0;
1104 }
1105
1106 int pthread_condattr_getpshared(pthread_condattr_t *a, int *s)
1107 {
1108         *s = a->pshared;
1109         return 0;
1110 }
1111
1112 int pthread_condattr_setpshared(pthread_condattr_t *a, int s)
1113 {
1114         a->pshared = s;
1115         if (s == PTHREAD_PROCESS_SHARED) {
1116                 printf("Warning: we don't do shared pthread condvars btw diff MCPs\n");
1117                 return -1;
1118         }
1119         return 0;
1120 }
1121
1122 int pthread_condattr_getclock(const pthread_condattr_t *attr,
1123                               clockid_t *clock_id)
1124 {
1125         *clock_id = attr->clock;
1126 }
1127
1128 int pthread_condattr_setclock(pthread_condattr_t *attr, clockid_t clock_id)
1129 {
1130         printf("Warning: we don't do pthread condvar clock stuff\n");
1131         attr->clock = clock_id;
1132 }
1133
1134 pthread_t pthread_self()
1135 {
1136   return (struct pthread_tcb*)current_uthread;
1137 }
1138
1139 int pthread_equal(pthread_t t1, pthread_t t2)
1140 {
1141   return t1 == t2;
1142 }
1143
1144 int pthread_once(pthread_once_t* once_control, void (*init_routine)(void))
1145 {
1146   if (atomic_swap_u32(once_control, 1) == 0)
1147     init_routine();
1148   return 0;
1149 }
1150
1151 int pthread_barrier_init(pthread_barrier_t *b,
1152                          const pthread_barrierattr_t *a, int count)
1153 {
1154         b->total_threads = count;
1155         b->sense = 0;
1156         atomic_set(&b->count, count);
1157         spin_pdr_init(&b->lock);
1158         SLIST_INIT(&b->waiters);
1159         b->nr_waiters = 0;
1160         return 0;
1161 }
1162
1163 struct barrier_junk {
1164         pthread_barrier_t                               *b;
1165         int                                                             ls;
1166 };
1167
1168 /* Callback/bottom half of barrier. */
1169 static void __pth_barrier_cb(struct uthread *uthread, void *junk)
1170 {
1171         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
1172         pthread_barrier_t *b = ((struct barrier_junk*)junk)->b;
1173         int ls = ((struct barrier_junk*)junk)->ls;
1174         /* Removes from active list, we can reuse.  must also restart */
1175         __pthread_generic_yield(pthread);
1176         /* TODO: if we used a trylock, we could bail as soon as we see sense */
1177         spin_pdr_lock(&b->lock);
1178         /* If sense is ls (our free value), we lost the race and shouldn't sleep */
1179         if (b->sense == ls) {
1180                 /* TODO: i'd like to fast-path the wakeup, skipping pth_runnable */
1181                 pthread->state = PTH_BLK_YIELDING;      /* not sure which state for this */
1182                 spin_pdr_unlock(&b->lock);
1183                 pth_thread_runnable(uthread);
1184                 return;
1185         }
1186         /* otherwise, we sleep */
1187         pthread->state = PTH_BLK_MUTEX; /* TODO: consider ignoring this */
1188         SLIST_INSERT_HEAD(&b->waiters, pthread, sl_next);
1189         b->nr_waiters++;
1190         spin_pdr_unlock(&b->lock);
1191 }
1192
1193 /* We assume that the same threads participating in the barrier this time will
1194  * also participate next time.  Imagine a thread stopped right after its fetch
1195  * and add - we know it is coming through eventually.  We finish and change the
1196  * sense, which should allow the delayed thread to eventually break through.
1197  * But if another n threads come in first, we'll set the sense back to the old
1198  * value, thereby catching the delayed thread til the next barrier. 
1199  *
1200  * A note on preemption: if any thread gets preempted and it is never dealt
1201  * with, eventually we deadlock, with all threads waiting on the last one to
1202  * enter (and any stragglers from one run will be the last in the next run).
1203  * One way or another, we need to handle preemptions.  The current 2LS requests
1204  * an IPI for a preempt, so we'll be fine.  Any other strategies will need to
1205  * consider how barriers work.  Any time we sleep, we'll be okay (since that
1206  * frees up our core to handle preemptions/run other threads. */
1207 int pthread_barrier_wait(pthread_barrier_t *b)
1208 {
1209         unsigned int spin_state = 0;
1210         int ls = !b->sense;     /* when b->sense is the value we read, then we're free*/
1211         struct pthread_list restartees = SLIST_HEAD_INITIALIZER(restartees);
1212         struct pthread_tcb *pthread_i;
1213         struct barrier_junk local_junk;
1214         
1215         long old_count = atomic_fetch_and_add(&b->count, -1);
1216
1217         if (old_count == 1) {
1218                 printd("Thread %d is last to hit the barrier, resetting...\n",
1219                        pthread_self()->id);
1220                 /* TODO: we might want to grab the lock right away, so a few short
1221                  * circuit faster? */
1222                 atomic_set(&b->count, b->total_threads);
1223                 /* we still need to maintain ordering btw count and sense, in case
1224                  * another thread doesn't sleep (if we wrote sense first, they could
1225                  * break out, race around, and muck with count before it is time) */
1226                 /* wmb(); handled by the spin lock */
1227                 spin_pdr_lock(&b->lock);
1228                 /* Sense is only protected in addition to decisions to sleep */
1229                 b->sense = ls;  /* set to free everyone */
1230                 /* All access to nr_waiters is protected by the lock */
1231                 if (!b->nr_waiters) {
1232                         spin_pdr_unlock(&b->lock);
1233                         return PTHREAD_BARRIER_SERIAL_THREAD;
1234                 }
1235                 swap_slists(&restartees, &b->waiters);
1236                 b->nr_waiters = 0;
1237                 spin_pdr_unlock(&b->lock);
1238                 wake_slist(&restartees);
1239                 return PTHREAD_BARRIER_SERIAL_THREAD;
1240         } else {
1241                 /* Spin if there are no other threads to run.  No sense sleeping */
1242                 do {
1243                         if (b->sense == ls)
1244                                 return 0;
1245                         cpu_relax();
1246                 } while (safe_to_spin(&spin_state));
1247
1248                 /* Try to sleep, when we wake/return, we're free to go */
1249                 local_junk.b = b;
1250                 local_junk.ls = ls;
1251                 uthread_yield(TRUE, __pth_barrier_cb, &local_junk);
1252                 // assert(b->sense == ls);
1253                 return 0;
1254         }
1255 }
1256
1257 int pthread_barrier_destroy(pthread_barrier_t *b)
1258 {
1259         assert(SLIST_EMPTY(&b->waiters));
1260         assert(!b->nr_waiters);
1261         /* Free any locks (if we end up using an MCS) */
1262         return 0;
1263 }
1264
1265 int pthread_detach(pthread_t thread)
1266 {
1267         /* TODO: race on this state.  Someone could be trying to join now */
1268         thread->detached = TRUE;
1269         return 0;
1270 }
1271
1272 int pthread_kill(pthread_t thread, int signo)
1273 {
1274         // Slightly racy with clearing of mask when triggering the signal, but
1275         // that's OK, as signals are inherently racy since they don't queue up.
1276         return sigaddset(&thread->sigpending, signo);
1277 }
1278
1279 int pthread_sigmask(int how, const sigset_t *set, sigset_t *oset)
1280 {
1281         sigset_t *sigmask;
1282         if (how != SIG_BLOCK && how != SIG_SETMASK && how != SIG_UNBLOCK) {
1283                 errno = EINVAL;
1284                 return -1;
1285         }
1286         sigmask = &((struct pthread_tcb*)current_uthread)->sigmask;
1287
1288         if (oset)
1289                 *oset = *sigmask;
1290         switch (how) {
1291                 case SIG_BLOCK:
1292                         *sigmask = *sigmask | *set;
1293                         break;
1294                 case SIG_SETMASK:
1295                         *sigmask = *set;
1296                         break;
1297                 case SIG_UNBLOCK:
1298                         *sigmask = *sigmask & ~(*set);
1299                         break;
1300         }
1301         // Ensures any signals we just unmasked get processed if they are pending
1302         pthread_yield();
1303         return 0;
1304 }
1305
1306 int pthread_sigqueue(pthread_t *thread, int sig, const union sigval value)
1307 {
1308         printf("pthread_sigqueue is not yet implemented!");
1309         return -1;
1310 }
1311
1312 int pthread_key_create(pthread_key_t *key, void (*destructor)(void*))
1313 {
1314         *key = dtls_key_create(destructor);
1315         assert(key);
1316         return 0;
1317 }
1318
1319 int pthread_key_delete(pthread_key_t key)
1320 {
1321         dtls_key_delete(key);
1322         return 0;
1323 }
1324
1325 void *pthread_getspecific(pthread_key_t key)
1326 {
1327         return get_dtls(key);
1328 }
1329
1330 int pthread_setspecific(pthread_key_t key, const void *value)
1331 {
1332         set_dtls(key, (void*)value);
1333         return 0;
1334 }
1335
1336
1337 /* Scheduling Stuff */
1338
1339 static bool policy_is_supported(int policy)
1340 {
1341         /* As our scheduler changes, we can add more policies here */
1342         switch (policy) {
1343                 case SCHED_FIFO:
1344                         return TRUE;
1345                 default:
1346                         return FALSE;
1347         }
1348 }
1349
1350 int pthread_attr_setschedparam(pthread_attr_t *attr,
1351                                const struct sched_param *param)
1352 {
1353         /* The set of acceptable priorities are based on the scheduling policy.
1354          * We'll just accept any old number, since we might not know the policy
1355          * yet.  I didn't see anything in the man pages saying attr had to have a
1356          * policy set before setting priority. */
1357         attr->sched_priority = param->sched_priority;
1358         return 0;
1359 }
1360
1361 int pthread_attr_getschedparam(pthread_attr_t *attr,
1362                                struct sched_param *param)
1363 {
1364         param->sched_priority = attr->sched_priority;
1365         return 0;
1366 }
1367
1368 int pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy)
1369 {
1370         if (!policy_is_supported(policy))
1371                 return -EINVAL;
1372         attr->sched_policy = policy;
1373         return 0;
1374 }
1375
1376 int pthread_attr_getschedpolicy(pthread_attr_t *attr, int *policy)
1377 {
1378         *policy = attr->sched_policy;
1379         return 0;
1380 }
1381
1382 /* We only support SCOPE_PROCESS, so we don't even use the attr. */
1383 int pthread_attr_setscope(pthread_attr_t *attr, int scope)
1384 {
1385         if (scope != PTHREAD_SCOPE_PROCESS)
1386                 return -ENOTSUP;
1387         return 0;
1388 }
1389
1390 int pthread_attr_getscope(pthread_attr_t *attr, int *scope)
1391 {
1392         *scope = PTHREAD_SCOPE_PROCESS;
1393         return 0;
1394 }
1395
1396 /* Inheritance refers to policy, priority, scope */
1397 int pthread_attr_setinheritsched(pthread_attr_t *attr,
1398                                  int inheritsched)
1399 {
1400         switch (inheritsched) {
1401                 case PTHREAD_INHERIT_SCHED:
1402                 case PTHREAD_EXPLICIT_SCHED:
1403                         break;
1404                 default:
1405                         return -EINVAL;
1406         }
1407         attr->sched_inherit = inheritsched;
1408         return 0;
1409 }
1410
1411 int pthread_attr_getinheritsched(const pthread_attr_t *attr,
1412                                  int *inheritsched)
1413 {
1414         *inheritsched = attr->sched_inherit;
1415         return 0;
1416 }
1417
1418 int pthread_setschedparam(pthread_t thread, int policy,
1419                            const struct sched_param *param)
1420 {
1421         if (!policy_is_supported(policy))
1422                 return -EINVAL;
1423         thread->sched_policy = policy;
1424         /* We actually could check if the priority falls in the range of the
1425          * specified policy here, since we have both policy and priority. */
1426         thread->sched_priority = param->sched_priority;
1427         return 0;
1428 }
1429
1430 int pthread_getschedparam(pthread_t thread, int *policy,
1431                            struct sched_param *param)
1432 {
1433         *policy = thread->sched_policy;
1434         param->sched_priority = thread->sched_priority;
1435         return 0;
1436 }
1437
1438
1439 /* Unsupported Stuff */
1440
1441 int pthread_mutex_timedlock (pthread_mutex_t *__restrict __mutex,
1442                                         const struct timespec *__restrict
1443                                         __abstime)
1444 {
1445         fprintf(stderr, "Unsupported %s!", __FUNCTION__);
1446         abort();
1447         return -1;
1448 }
1449
1450 int pthread_cond_timedwait (pthread_cond_t *__restrict __cond,
1451                                    pthread_mutex_t *__restrict __mutex,
1452                                    const struct timespec *__restrict __abstime)
1453 {
1454         fprintf(stderr, "Unsupported %s!", __FUNCTION__);
1455         abort();
1456         return -1;
1457 }
1458
1459 int pthread_cancel (pthread_t __th)
1460 {
1461         fprintf(stderr, "Unsupported %s!", __FUNCTION__);
1462         abort();
1463         return -1;
1464 }
1465
1466 void pthread_cleanup_push(void (*routine)(void *), void *arg)
1467 {
1468         fprintf(stderr, "Unsupported %s!", __FUNCTION__);
1469         abort();
1470 }
1471
1472 void pthread_cleanup_pop(int execute)
1473 {
1474         fprintf(stderr, "Unsupported %s!", __FUNCTION__);
1475         abort();
1476 }