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