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