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