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