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