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