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