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