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