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