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