Cleans up vcore/uth/pth init code
[akaros.git] / user / pthread / pthread.c
1 #include <ros/arch/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 <assert.h>
17 #include <event.h>
18 #include <ucq.h>
19
20 struct pthread_queue ready_queue = TAILQ_HEAD_INITIALIZER(ready_queue);
21 struct pthread_queue active_queue = TAILQ_HEAD_INITIALIZER(active_queue);
22 struct mcs_pdr_lock queue_lock;
23 pthread_once_t init_once = PTHREAD_ONCE_INIT;
24 int threads_ready = 0;
25 int threads_active = 0;
26 bool can_adjust_vcores = 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 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         TAILQ_INSERT_TAIL(&ready_queue, pthread, next);
144         threads_ready++;
145         mcs_pdr_unlock(&queue_lock);
146         /* Smarter schedulers should look at the num_vcores() and how much work is
147          * going on to make a decision about how many vcores to request. */
148         if (can_adjust_vcores)
149                 vcore_request(threads_ready);
150 }
151
152 /* For some reason not under its control, the uthread stopped running (compared
153  * to yield, which was caused by uthread/2LS code).
154  *
155  * The main case for this is if the vcore was preempted or if the vcore it was
156  * running on needed to stop.  You are given a uthread that looks like it took a
157  * notif, and had its context/silly state copied out to the uthread struct.
158  * (copyout_uthread).  Note that this will be called in the context (TLS) of the
159  * vcore that is losing the uthread.  If that vcore is running, it'll be in a
160  * preempt-event handling loop (not in your 2LS code).  If this is a big
161  * problem, I'll change it. */
162 void pth_thread_paused(struct uthread *uthread)
163 {
164         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
165         /* Remove from the active list.  Note that I don't particularly care about
166          * the active list.  We keep it around because it causes bugs and keeps us
167          * honest.  After all, some 2LS may want an active list */
168         mcs_pdr_lock(&queue_lock);
169         threads_active--;
170         TAILQ_REMOVE(&active_queue, pthread, next);
171         mcs_pdr_unlock(&queue_lock);
172         /* communicate to pth_thread_runnable */
173         pthread->state = PTH_BLK_PAUSED;
174         /* At this point, you could do something clever, like put it at the front of
175          * the runqueue, see if it was holding a lock, do some accounting, or
176          * whatever. */
177         uthread_runnable(uthread);
178 }
179
180 /* Restarts a uthread hanging off a syscall.  For the simple pthread case, we
181  * just make it runnable and let the main scheduler code handle it. */
182 static void restart_thread(struct syscall *sysc)
183 {
184         struct uthread *ut_restartee = (struct uthread*)sysc->u_data;
185         /* uthread stuff here: */
186         assert(ut_restartee);
187         assert(((struct pthread_tcb*)ut_restartee)->state == PTH_BLK_SYSC);
188         assert(ut_restartee->sysc == sysc);     /* set in uthread.c */
189         ut_restartee->sysc = 0; /* so we don't 'reblock' on this later */
190         uthread_runnable(ut_restartee);
191 }
192
193 /* This handler is usually run in vcore context, though I can imagine it being
194  * called by a uthread in some other threading library. */
195 static void pth_handle_syscall(struct event_msg *ev_msg, unsigned int ev_type)
196 {
197         struct syscall *sysc;
198         assert(in_vcore_context());
199         /* if we just got a bit (not a msg), it should be because the process is
200          * still an SCP and hasn't started using the MCP ev_q yet (using the simple
201          * ev_q and glibc's blockon) or because the bit is still set from an old
202          * ev_q (blocking syscalls from before we could enter vcore ctx).  Either
203          * way, just return.  Note that if you screwed up the pth ev_q and made it
204          * NO_MSG, you'll never notice (we used to assert(ev_msg)). */
205         if (!ev_msg)
206                 return;
207         /* It's a bug if we don't have a msg (we're handling a syscall bit-event) */
208         assert(ev_msg);
209         /* Get the sysc from the message and just restart it */
210         sysc = ev_msg->ev_arg3;
211         assert(sysc);
212         restart_thread(sysc);
213 }
214
215 /* This will be called from vcore context, after the current thread has yielded
216  * and is trying to block on sysc.  Need to put it somewhere were we can wake it
217  * up when the sysc is done.  For now, we'll have the kernel send us an event
218  * when the syscall is done. */
219 void pth_thread_blockon_sysc(struct uthread *uthread, void *syscall)
220 {
221         struct syscall *sysc = (struct syscall*)syscall;
222         int old_flags;
223         bool need_to_restart = FALSE;
224         uint32_t vcoreid = vcore_id();
225         /* rip from the active queue */
226         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
227         pthread->state = PTH_BLK_SYSC;
228         mcs_pdr_lock(&queue_lock);
229         threads_active--;
230         TAILQ_REMOVE(&active_queue, pthread, next);
231         mcs_pdr_unlock(&queue_lock);
232         /* Set things up so we can wake this thread up later */
233         sysc->u_data = uthread;
234         /* Register our vcore's syscall ev_q to hear about this syscall. */
235         if (!register_evq(sysc, sysc_mgmt[vcoreid].ev_q)) {
236                 /* Lost the race with the call being done.  The kernel won't send the
237                  * event.  Just restart him. */
238                 restart_thread(sysc);
239         }
240         /* GIANT WARNING: do not touch the thread after this point. */
241 }
242
243 void pth_thread_has_blocked(struct uthread *uthread, int flags)
244 {
245         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
246         /* could imagine doing something with the flags.  For now, we just treat all
247          * externally blocked reasons as 'MUTEX'.  Whatever we do here, we are
248          * mostly communicating to our future selves in pth_thread_runnable(), which
249          * gets called by whoever triggered this callback */
250         pthread->state = PTH_BLK_MUTEX;
251         /* Just for yucks: */
252         if (flags == UTH_EXT_BLK_JUSTICE)
253                 printf("For great justice!\n");
254 }
255
256 void pth_preempt_pending(void)
257 {
258 }
259
260 void pth_spawn_thread(uintptr_t pc_start, void *data)
261 {
262 }
263
264 /* Akaros pthread extensions / hacks */
265
266 /* Tells the pthread 2LS to not change the number of vcores.  This means it will
267  * neither request vcores nor yield vcores.  Only used for testing. */
268 void pthread_can_vcore_request(bool can)
269 {
270         /* checked when we would request or yield */
271         can_adjust_vcores = can;
272 }
273
274 /* Pthread interface stuff and helpers */
275
276 int pthread_attr_init(pthread_attr_t *a)
277 {
278         a->stacksize = PTHREAD_STACK_SIZE;
279         a->detachstate = PTHREAD_CREATE_JOINABLE;
280         return 0;
281 }
282
283 int pthread_attr_destroy(pthread_attr_t *a)
284 {
285         return 0;
286 }
287
288 static void __pthread_free_stack(struct pthread_tcb *pt)
289 {
290         assert(!munmap(pt->stacktop - pt->stacksize, pt->stacksize));
291 }
292
293 static int __pthread_allocate_stack(struct pthread_tcb *pt)
294 {
295         assert(pt->stacksize);
296         void* stackbot = mmap(0, pt->stacksize,
297                               PROT_READ|PROT_WRITE|PROT_EXEC,
298                               MAP_POPULATE|MAP_ANONYMOUS, -1, 0);
299         if (stackbot == MAP_FAILED)
300                 return -1; // errno set by mmap
301         pt->stacktop = stackbot + pt->stacksize;
302         return 0;
303 }
304
305 // Warning, this will reuse numbers eventually
306 static int get_next_pid(void)
307 {
308         static uint32_t next_pid = 0;
309         return next_pid++;
310 }
311
312 int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize)
313 {
314         attr->stacksize = stacksize;
315         return 0;
316 }
317 int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize)
318 {
319         *stacksize = attr->stacksize;
320         return 0;
321 }
322
323 /* Do whatever init you want.  At some point call uthread_lib_init() and pass it
324  * a uthread representing thread0 (int main()) */
325 void pthread_lib_init(void)
326 {
327         uintptr_t mmap_block;
328         /* Some testing code might call this more than once (once for a slimmed down
329          * pth 2LS, and another from pthread_create().  Also, this is racy, but the
330          * first time through we are an SCP. */
331         init_once(return);
332         assert(!in_multi_mode());
333         mcs_pdr_init(&queue_lock);
334         /* Create a pthread_tcb for the main thread */
335         pthread_t t = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
336         assert(t);
337         t->id = get_next_pid();
338         t->stacksize = USTACK_NUM_PAGES * PGSIZE;
339         t->stacktop = (void*)USTACKTOP;
340         t->detached = TRUE;
341         t->state = PTH_RUNNING;
342         t->joiner = 0;
343         assert(t->id == 0);
344         /* Put the new pthread (thread0) on the active queue */
345         mcs_pdr_lock(&queue_lock);      /* arguably, we don't need these (_S mode) */
346         threads_active++;
347         TAILQ_INSERT_TAIL(&active_queue, t, next);
348         mcs_pdr_unlock(&queue_lock);
349         /* Tell the kernel where and how we want to receive events.  This is just an
350          * example of what to do to have a notification turned on.  We're turning on
351          * USER_IPIs, posting events to vcore 0's vcpd, and telling the kernel to
352          * send to vcore 0.  Note sys_self_notify will ignore the vcoreid and
353          * private preference.  Also note that enable_kevent() is just an example,
354          * and you probably want to use parts of event.c to do what you want. */
355         enable_kevent(EV_USER_IPI, 0, EVENT_IPI | EVENT_VCORE_PRIVATE);
356
357         /* Handle syscall events. */
358         ev_handlers[EV_SYSCALL] = pth_handle_syscall;
359         /* Set up the per-vcore structs to track outstanding syscalls */
360         sysc_mgmt = malloc(sizeof(struct sysc_mgmt) * max_vcores());
361         assert(sysc_mgmt);
362 #if 1   /* Independent ev_mboxes per vcore */
363         /* Get a block of pages for our per-vcore (but non-VCPD) ev_qs */
364         mmap_block = (uintptr_t)mmap(0, PGSIZE * 2 * max_vcores(),
365                                      PROT_WRITE | PROT_READ,
366                                      MAP_POPULATE | MAP_ANONYMOUS, -1, 0);
367         assert(mmap_block);
368         /* Could be smarter and do this on demand (in case we don't actually want
369          * max_vcores()). */
370         for (int i = 0; i < max_vcores(); i++) {
371                 /* Each vcore needs to point to a non-VCPD ev_q */
372                 sysc_mgmt[i].ev_q = get_big_event_q_raw();
373                 sysc_mgmt[i].ev_q->ev_flags = EVENT_IPI | EVENT_INDIR | EVENT_FALLBACK;
374                 sysc_mgmt[i].ev_q->ev_vcore = i;
375                 ucq_init_raw(&sysc_mgmt[i].ev_q->ev_mbox->ev_msgs, 
376                              mmap_block + (2 * i    ) * PGSIZE, 
377                              mmap_block + (2 * i + 1) * PGSIZE); 
378         }
379         /* Technically, we should munmap and free what we've alloc'd, but the
380          * kernel will clean it up for us when we exit. */
381 #endif 
382 #if 0   /* One global ev_mbox, separate ev_q per vcore */
383         struct event_mbox *sysc_mbox = malloc(sizeof(struct event_mbox));
384         uintptr_t two_pages = (uintptr_t)mmap(0, PGSIZE * 2, PROT_WRITE | PROT_READ,
385                                               MAP_POPULATE | MAP_ANONYMOUS, -1, 0);
386         printd("Global ucq: %08p\n", &sysc_mbox->ev_msgs);
387         assert(sysc_mbox);
388         assert(two_pages);
389         memset(sysc_mbox, 0, sizeof(struct event_mbox));
390         ucq_init_raw(&sysc_mbox->ev_msgs, two_pages, two_pages + PGSIZE);
391         for (int i = 0; i < max_vcores(); i++) {
392                 sysc_mgmt[i].ev_q = get_event_q();
393                 sysc_mgmt[i].ev_q->ev_flags = EVENT_IPI | EVENT_INDIR | EVENT_FALLBACK;
394                 sysc_mgmt[i].ev_q->ev_vcore = i;
395                 sysc_mgmt[i].ev_q->ev_mbox = sysc_mbox;
396         }
397 #endif
398         /* Initialize the uthread code (we're in _M mode after this).  Doing this
399          * last so that all the event stuff is ready when we're in _M mode.  Not a
400          * big deal one way or the other.  Note that vcore_init() probably has
401          * happened, but don't rely on this.  Careful if your 2LS somehow wants to
402          * have its init stuff use things like vcore stacks or TLSs, we'll need to
403          * change this. */
404         uthread_lib_init((struct uthread*)t);
405 }
406
407 int pthread_create(pthread_t *thread, const pthread_attr_t *attr,
408                    void *(*start_routine)(void *), void *arg)
409 {
410         /* Racy, but the first time through we are an SCP */
411         run_once(pthread_lib_init());
412         /* Create the actual thread */
413         struct pthread_tcb *pthread;
414         pthread = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
415         assert(pthread);
416         pthread->stacksize = PTHREAD_STACK_SIZE;        /* default */
417         pthread->state = PTH_CREATED;
418         pthread->id = get_next_pid();
419         pthread->detached = FALSE;                              /* default */
420         pthread->joiner = 0;
421         /* Respect the attributes */
422         if (attr) {
423                 if (attr->stacksize)                                    /* don't set a 0 stacksize */
424                         pthread->stacksize = attr->stacksize;
425                 if (attr->detachstate == PTHREAD_CREATE_DETACHED)
426                         pthread->detached = TRUE;
427         }
428         /* allocate a stack */
429         if (__pthread_allocate_stack(pthread))
430                 printf("We're fucked\n");
431         /* Set the u_tf to start up in __pthread_run, which will call the real
432          * start_routine and pass it the arg.  Note those aren't set until later in
433          * pthread_create(). */
434         init_user_tf(&pthread->uthread.utf, (long)&__pthread_run,
435                      (long)(pthread->stacktop));
436         pthread->start_routine = start_routine;
437         pthread->arg = arg;
438         /* Initialize the uthread */
439         uthread_init((struct uthread*)pthread);
440         uthread_runnable((struct uthread*)pthread);
441         *thread = pthread;
442         return 0;
443 }
444
445 /* Helper that all pthread-controlled yield paths call.  Just does some
446  * accounting.  This is another example of how the much-loathed (and loved)
447  * active queue is keeping us honest. */
448 static void __pthread_generic_yield(struct pthread_tcb *pthread)
449 {
450         mcs_pdr_lock(&queue_lock);
451         threads_active--;
452         TAILQ_REMOVE(&active_queue, pthread, next);
453         mcs_pdr_unlock(&queue_lock);
454 }
455
456 /* Callback/bottom half of join, called from __uthread_yield (vcore context).
457  * join_target is who we are trying to join on (and who is calling exit). */
458 static void __pth_join_cb(struct uthread *uthread, void *arg)
459 {
460         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
461         struct pthread_tcb *join_target = (struct pthread_tcb*)arg;
462         struct pthread_tcb *temp_pth = 0;
463         __pthread_generic_yield(pthread);
464         /* We're trying to join, yield til we get woken up */
465         pthread->state = PTH_BLK_JOINING;       /* could do this front-side */
466         /* Put ourselves in the join target's joiner slot.  If we get anything back,
467          * we lost the race and need to wake ourselves.  Syncs with __pth_exit_cb.*/
468         temp_pth = atomic_swap_ptr((void**)&join_target->joiner, pthread);
469         /* After that atomic swap, the pthread might be woken up (if it succeeded),
470          * so don't touch pthread again after that (this following if () is okay).*/
471         if (temp_pth) {         /* temp_pth != 0 means they exited first */
472                 assert(temp_pth == join_target);        /* Sanity */
473                 /* wake ourselves, not the exited one! */
474                 printd("[pth] %08p already exit, rewaking ourselves, joiner %08p\n",
475                        temp_pth, pthread);
476                 uthread_runnable(uthread);      /* wake ourselves */
477         }
478 }
479
480 int pthread_join(struct pthread_tcb *join_target, void **retval)
481 {
482         /* Not sure if this is the right semantics.  There is a race if we deref
483          * join_target and he is already freed (which would have happened if he was
484          * detached. */
485         if (join_target->detached) {
486                 printf("[pthread] trying to join on a detached pthread");
487                 return -1;
488         }
489         /* See if it is already done, to avoid the pain of a uthread_yield() (the
490          * early check is an optimization, pth_thread_yield() handles the race). */
491         if (!join_target->joiner) {
492                 uthread_yield(TRUE, __pth_join_cb, join_target);
493                 /* When we return/restart, the thread will be done */
494         } else {
495                 assert(join_target->joiner == join_target);     /* sanity check */
496         }
497         if (retval)
498                 *retval = join_target->retval;
499         free(join_target);
500         return 0;
501 }
502
503 /* Callback/bottom half of exit.  Syncs with __pth_join_cb.  Here's how it
504  * works: the slot for joiner is initially 0.  Joiners try to swap themselves
505  * into that spot.  Exiters try to put 'themselves' into it.  Whoever gets 0
506  * back won the race.  If the exiter lost the race, it must wake up the joiner
507  * (which was the value from temp_pth).  If the joiner lost the race, it must
508  * wake itself up, and for sanity reasons can ensure the value from temp_pth is
509  * the join target). */
510 static void __pth_exit_cb(struct uthread *uthread, void *junk)
511 {
512         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
513         struct pthread_tcb *temp_pth = 0;
514         __pthread_generic_yield(pthread);
515         /* Catch some bugs */
516         pthread->state = PTH_EXITING;
517         /* Destroy the pthread */
518         uthread_cleanup(uthread);
519         /* Cleanup, mirroring pthread_create() */
520         __pthread_free_stack(pthread);
521         /* TODO: race on detach state (see join) */
522         if (pthread->detached) {
523                 free(pthread);
524         } else {
525                 /* See if someone is joining on us.  If not, we're done (and the
526                  * joiner will wake itself when it saw us there instead of 0). */
527                 temp_pth = atomic_swap_ptr((void**)&pthread->joiner, pthread);
528                 if (temp_pth) {
529                         /* they joined before we exited, we need to wake them */
530                         printd("[pth] %08p exiting, waking joiner %08p\n",
531                                pthread, temp_pth);
532                         uthread_runnable((struct uthread*)temp_pth);
533                 }
534         }
535 }
536
537 void pthread_exit(void *ret)
538 {
539         struct pthread_tcb *pthread = pthread_self();
540         pthread->retval = ret;
541         destroy_dtls();
542         uthread_yield(FALSE, __pth_exit_cb, 0);
543 }
544
545 /* Callback/bottom half of yield.  For those writing these pth callbacks, the
546  * minimum is call generic, set state (communicate with runnable), then do
547  * something that causes it to be runnable in the future (or right now). */
548 static void __pth_yield_cb(struct uthread *uthread, void *junk)
549 {
550         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
551         __pthread_generic_yield(pthread);
552         pthread->state = PTH_BLK_YIELDING;
553         /* just immediately restart it */
554         uthread_runnable(uthread);
555 }
556
557 /* Cooperative yielding of the processor, to allow other threads to run */
558 int pthread_yield(void)
559 {
560         uthread_yield(TRUE, __pth_yield_cb, 0);
561         return 0;
562 }
563
564 int pthread_mutexattr_init(pthread_mutexattr_t* attr)
565 {
566   attr->type = PTHREAD_MUTEX_DEFAULT;
567   return 0;
568 }
569
570 int pthread_mutexattr_destroy(pthread_mutexattr_t* attr)
571 {
572   return 0;
573 }
574
575 int pthread_attr_setdetachstate(pthread_attr_t *__attr, int __detachstate)
576 {
577         __attr->detachstate = __detachstate;
578         return 0;
579 }
580
581 int pthread_mutexattr_gettype(const pthread_mutexattr_t* attr, int* type)
582 {
583   *type = attr ? attr->type : PTHREAD_MUTEX_DEFAULT;
584   return 0;
585 }
586
587 int pthread_mutexattr_settype(pthread_mutexattr_t* attr, int type)
588 {
589   if(type != PTHREAD_MUTEX_NORMAL)
590     return EINVAL;
591   attr->type = type;
592   return 0;
593 }
594
595 int pthread_mutex_init(pthread_mutex_t* m, const pthread_mutexattr_t* attr)
596 {
597   m->attr = attr;
598   atomic_init(&m->lock, 0);
599   return 0;
600 }
601
602 /* Set *spun to 0 when calling this the first time.  It will yield after 'spins'
603  * calls.  Use this for adaptive mutexes and such. */
604 static inline void spin_to_sleep(unsigned int spins, unsigned int *spun)
605 {
606         if ((*spun)++ == spins) {
607                 pthread_yield();
608                 *spun = 0;
609         }
610 }
611
612 int pthread_mutex_lock(pthread_mutex_t* m)
613 {
614         unsigned int spinner = 0;
615         while(pthread_mutex_trylock(m))
616                 while(*(volatile size_t*)&m->lock) {
617                         cpu_relax();
618                         spin_to_sleep(PTHREAD_MUTEX_SPINS, &spinner);
619                 }
620         /* normally we'd need a wmb() and a wrmb() after locking, but the
621          * atomic_swap handles the CPU mb(), so just a cmb() is necessary. */
622         cmb();
623         return 0;
624 }
625
626 int pthread_mutex_trylock(pthread_mutex_t* m)
627 {
628   return atomic_swap(&m->lock, 1) == 0 ? 0 : EBUSY;
629 }
630
631 int pthread_mutex_unlock(pthread_mutex_t* m)
632 {
633   /* keep reads and writes inside the protected region */
634   rwmb();
635   wmb();
636   atomic_set(&m->lock, 0);
637   return 0;
638 }
639
640 int pthread_mutex_destroy(pthread_mutex_t* m)
641 {
642   return 0;
643 }
644
645 int pthread_cond_init(pthread_cond_t *c, const pthread_condattr_t *a)
646 {
647   c->attr = a;
648   memset(c->waiters,0,sizeof(c->waiters));
649   memset(c->in_use,0,sizeof(c->in_use));
650   c->next_waiter = 0;
651   return 0;
652 }
653
654 int pthread_cond_destroy(pthread_cond_t *c)
655 {
656   return 0;
657 }
658
659 int pthread_cond_broadcast(pthread_cond_t *c)
660 {
661   memset(c->waiters,0,sizeof(c->waiters));
662   return 0;
663 }
664
665 int pthread_cond_signal(pthread_cond_t *c)
666 {
667   int i;
668   for(i = 0; i < MAX_PTHREADS; i++)
669   {
670     if(c->waiters[i])
671     {
672       c->waiters[i] = 0;
673       break;
674     }
675   }
676   return 0;
677 }
678
679 int pthread_cond_wait(pthread_cond_t *c, pthread_mutex_t *m)
680 {
681   uint32_t old_waiter = c->next_waiter;
682   uint32_t my_waiter = c->next_waiter;
683   
684   //allocate a slot
685   while (atomic_swap_u32(& (c->in_use[my_waiter]), SLOT_IN_USE) == SLOT_IN_USE)
686   {
687     my_waiter = (my_waiter + 1) % MAX_PTHREADS;
688     assert (old_waiter != my_waiter);  // do not want to wrap around
689   }
690   c->waiters[my_waiter] = WAITER_WAITING;
691   c->next_waiter = (my_waiter+1) % MAX_PTHREADS;  // race on next_waiter but ok, because it is advisary
692
693   pthread_mutex_unlock(m);
694
695   volatile int* poll = &c->waiters[my_waiter];
696   while(*poll);
697   c->in_use[my_waiter] = SLOT_FREE;
698   pthread_mutex_lock(m);
699
700   return 0;
701 }
702
703 int pthread_condattr_init(pthread_condattr_t *a)
704 {
705   a = PTHREAD_PROCESS_PRIVATE;
706   return 0;
707 }
708
709 int pthread_condattr_destroy(pthread_condattr_t *a)
710 {
711   return 0;
712 }
713
714 int pthread_condattr_setpshared(pthread_condattr_t *a, int s)
715 {
716   a->pshared = s;
717   return 0;
718 }
719
720 int pthread_condattr_getpshared(pthread_condattr_t *a, int *s)
721 {
722   *s = a->pshared;
723   return 0;
724 }
725
726 pthread_t pthread_self()
727 {
728   return (struct pthread_tcb*)current_uthread;
729 }
730
731 int pthread_equal(pthread_t t1, pthread_t t2)
732 {
733   return t1 == t2;
734 }
735
736 int pthread_once(pthread_once_t* once_control, void (*init_routine)(void))
737 {
738   if (atomic_swap_u32(once_control, 1) == 0)
739     init_routine();
740   return 0;
741 }
742
743 int pthread_barrier_init(pthread_barrier_t* b, const pthread_barrierattr_t* a, int count)
744 {
745   b->nprocs = b->count = count;
746   b->sense = 0;
747   pthread_mutex_init(&b->pmutex, 0);
748   return 0;
749 }
750
751 int pthread_barrier_wait(pthread_barrier_t* b)
752 {
753   unsigned int spinner = 0;
754   int ls = !b->sense;
755
756   pthread_mutex_lock(&b->pmutex);
757   int count = --b->count;
758   pthread_mutex_unlock(&b->pmutex);
759
760   if(count == 0)
761   {
762     printd("Thread %d is last to hit the barrier, resetting...\n", pthread_self()->id);
763     b->count = b->nprocs;
764         wmb();
765     b->sense = ls;
766     return PTHREAD_BARRIER_SERIAL_THREAD;
767   }
768   else
769   {
770     while(b->sense != ls) {
771       cpu_relax();
772       spin_to_sleep(PTHREAD_BARRIER_SPINS, &spinner);
773     }
774     return 0;
775   }
776 }
777
778 int pthread_barrier_destroy(pthread_barrier_t* b)
779 {
780   pthread_mutex_destroy(&b->pmutex);
781   return 0;
782 }
783
784 int pthread_detach(pthread_t thread)
785 {
786         /* TODO: race on this state.  Someone could be trying to join now */
787         thread->detached = TRUE;
788         return 0;
789 }
790
791 int pthread_kill (pthread_t __threadid, int __signo)
792 {
793         printf("pthread_kill is not yet implemented!");
794         return -1;
795 }
796
797
798 int pthread_sigmask(int how, const sigset_t *set, sigset_t *oset)
799 {
800         printf("pthread_sigmask is not yet implemented!");
801         return -1;
802 }
803
804 int pthread_sigqueue(pthread_t *thread, int sig, const union sigval value)
805 {
806         printf("pthread_sigqueue is not yet implemented!");
807         return -1;
808 }
809
810 int pthread_key_create(pthread_key_t *key, void (*destructor)(void*))
811 {
812         *key = dtls_key_create(destructor);
813         assert(key);
814         return 0;
815 }
816
817 int pthread_key_delete(pthread_key_t key)
818 {
819         dtls_key_delete(key);
820         return 0;
821 }
822
823 void *pthread_getspecific(pthread_key_t key)
824 {
825         return get_dtls(key);
826 }
827
828 int pthread_setspecific(pthread_key_t key, const void *value)
829 {
830         set_dtls(key, (void*)value);
831         return 0;
832 }
833