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