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