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