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