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