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