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