Uthread arch-dependent code uses user_contexts
[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         /* Some testing code might call this more than once (once for a slimmed down
331          * pth 2LS, and another from pthread_create().  Also, this is racy, but the
332          * first time through we are an SCP. */
333         init_once_racy(return);
334         assert(!in_multi_mode());
335         mcs_pdr_init(&queue_lock);
336         /* Create a pthread_tcb for the main thread */
337         pthread_t t = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
338         assert(t);
339         t->id = get_next_pid();
340         t->stacksize = USTACK_NUM_PAGES * PGSIZE;
341         t->stacktop = (void*)USTACKTOP;
342         t->detached = TRUE;
343         t->state = PTH_RUNNING;
344         t->joiner = 0;
345         assert(t->id == 0);
346         /* Put the new pthread (thread0) on the active queue */
347         mcs_pdr_lock(&queue_lock);      /* arguably, we don't need these (_S mode) */
348         threads_active++;
349         TAILQ_INSERT_TAIL(&active_queue, t, next);
350         mcs_pdr_unlock(&queue_lock);
351         /* Tell the kernel where and how we want to receive events.  This is just an
352          * example of what to do to have a notification turned on.  We're turning on
353          * USER_IPIs, posting events to vcore 0's vcpd, and telling the kernel to
354          * send to vcore 0.  Note sys_self_notify will ignore the vcoreid and
355          * private preference.  Also note that enable_kevent() is just an example,
356          * and you probably want to use parts of event.c to do what you want. */
357         enable_kevent(EV_USER_IPI, 0, EVENT_IPI | EVENT_VCORE_PRIVATE);
358
359         /* Handle syscall events. */
360         ev_handlers[EV_SYSCALL] = pth_handle_syscall;
361         /* Set up the per-vcore structs to track outstanding syscalls */
362         sysc_mgmt = malloc(sizeof(struct sysc_mgmt) * max_vcores());
363         assert(sysc_mgmt);
364 #if 1   /* Independent ev_mboxes per vcore */
365         /* Get a block of pages for our per-vcore (but non-VCPD) ev_qs */
366         mmap_block = (uintptr_t)mmap(0, PGSIZE * 2 * max_vcores(),
367                                      PROT_WRITE | PROT_READ,
368                                      MAP_POPULATE | MAP_ANONYMOUS, -1, 0);
369         assert(mmap_block);
370         /* Could be smarter and do this on demand (in case we don't actually want
371          * max_vcores()). */
372         for (int i = 0; i < max_vcores(); i++) {
373                 /* Each vcore needs to point to a non-VCPD ev_q */
374                 sysc_mgmt[i].ev_q = get_big_event_q_raw();
375                 sysc_mgmt[i].ev_q->ev_flags = EVENT_IPI | EVENT_INDIR | EVENT_FALLBACK;
376                 sysc_mgmt[i].ev_q->ev_vcore = i;
377                 ucq_init_raw(&sysc_mgmt[i].ev_q->ev_mbox->ev_msgs, 
378                              mmap_block + (2 * i    ) * PGSIZE, 
379                              mmap_block + (2 * i + 1) * PGSIZE); 
380         }
381         /* Technically, we should munmap and free what we've alloc'd, but the
382          * kernel will clean it up for us when we exit. */
383 #endif 
384 #if 0   /* One global ev_mbox, separate ev_q per vcore */
385         struct event_mbox *sysc_mbox = malloc(sizeof(struct event_mbox));
386         uintptr_t two_pages = (uintptr_t)mmap(0, PGSIZE * 2, PROT_WRITE | PROT_READ,
387                                               MAP_POPULATE | MAP_ANONYMOUS, -1, 0);
388         printd("Global ucq: %08p\n", &sysc_mbox->ev_msgs);
389         assert(sysc_mbox);
390         assert(two_pages);
391         memset(sysc_mbox, 0, sizeof(struct event_mbox));
392         ucq_init_raw(&sysc_mbox->ev_msgs, two_pages, two_pages + PGSIZE);
393         for (int i = 0; i < max_vcores(); i++) {
394                 sysc_mgmt[i].ev_q = get_event_q();
395                 sysc_mgmt[i].ev_q->ev_flags = EVENT_IPI | EVENT_INDIR | EVENT_FALLBACK;
396                 sysc_mgmt[i].ev_q->ev_vcore = i;
397                 sysc_mgmt[i].ev_q->ev_mbox = sysc_mbox;
398         }
399 #endif
400         /* Initialize the uthread code (we're in _M mode after this).  Doing this
401          * last so that all the event stuff is ready when we're in _M mode.  Not a
402          * big deal one way or the other.  Note that vcore_init() probably has
403          * happened, but don't rely on this.  Careful if your 2LS somehow wants to
404          * have its init stuff use things like vcore stacks or TLSs, we'll need to
405          * change this. */
406         uthread_lib_init((struct uthread*)t);
407 }
408
409 int pthread_create(pthread_t *thread, const pthread_attr_t *attr,
410                    void *(*start_routine)(void *), void *arg)
411 {
412         run_once(pthread_lib_init());
413         /* Create the actual thread */
414         struct pthread_tcb *pthread;
415         pthread = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
416         assert(pthread);
417         pthread->stacksize = PTHREAD_STACK_SIZE;        /* default */
418         pthread->state = PTH_CREATED;
419         pthread->id = get_next_pid();
420         pthread->detached = FALSE;                              /* default */
421         pthread->joiner = 0;
422         /* Respect the attributes */
423         if (attr) {
424                 if (attr->stacksize)                                    /* don't set a 0 stacksize */
425                         pthread->stacksize = attr->stacksize;
426                 if (attr->detachstate == PTHREAD_CREATE_DETACHED)
427                         pthread->detached = TRUE;
428         }
429         /* allocate a stack */
430         if (__pthread_allocate_stack(pthread))
431                 printf("We're fucked\n");
432         /* Set the u_tf to start up in __pthread_run, which will call the real
433          * start_routine and pass it the arg.  Note those aren't set until later in
434          * pthread_create(). */
435         init_user_ctx(&pthread->uthread.u_ctx, (long)&__pthread_run,
436                       (long)(pthread->stacktop));
437         pthread->start_routine = start_routine;
438         pthread->arg = arg;
439         /* Initialize the uthread */
440         uthread_init((struct uthread*)pthread);
441         pth_thread_runnable((struct uthread*)pthread);
442         *thread = pthread;
443         return 0;
444 }
445
446 /* Helper that all pthread-controlled yield paths call.  Just does some
447  * accounting.  This is another example of how the much-loathed (and loved)
448  * active queue is keeping us honest.  Need to export for sem and friends. */
449 void __pthread_generic_yield(struct pthread_tcb *pthread)
450 {
451         mcs_pdr_lock(&queue_lock);
452         threads_active--;
453         TAILQ_REMOVE(&active_queue, pthread, next);
454         mcs_pdr_unlock(&queue_lock);
455 }
456
457 /* Callback/bottom half of join, called from __uthread_yield (vcore context).
458  * join_target is who we are trying to join on (and who is calling exit). */
459 static void __pth_join_cb(struct uthread *uthread, void *arg)
460 {
461         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
462         struct pthread_tcb *join_target = (struct pthread_tcb*)arg;
463         struct pthread_tcb *temp_pth = 0;
464         __pthread_generic_yield(pthread);
465         /* We're trying to join, yield til we get woken up */
466         pthread->state = PTH_BLK_JOINING;       /* could do this front-side */
467         /* Put ourselves in the join target's joiner slot.  If we get anything back,
468          * we lost the race and need to wake ourselves.  Syncs with __pth_exit_cb.*/
469         temp_pth = atomic_swap_ptr((void**)&join_target->joiner, pthread);
470         /* After that atomic swap, the pthread might be woken up (if it succeeded),
471          * so don't touch pthread again after that (this following if () is okay).*/
472         if (temp_pth) {         /* temp_pth != 0 means they exited first */
473                 assert(temp_pth == join_target);        /* Sanity */
474                 /* wake ourselves, not the exited one! */
475                 printd("[pth] %08p already exit, rewaking ourselves, joiner %08p\n",
476                        temp_pth, pthread);
477                 pth_thread_runnable(uthread);   /* wake ourselves */
478         }
479 }
480
481 int pthread_join(struct pthread_tcb *join_target, void **retval)
482 {
483         /* Not sure if this is the right semantics.  There is a race if we deref
484          * join_target and he is already freed (which would have happened if he was
485          * detached. */
486         if (join_target->detached) {
487                 printf("[pthread] trying to join on a detached pthread");
488                 return -1;
489         }
490         /* See if it is already done, to avoid the pain of a uthread_yield() (the
491          * early check is an optimization, pth_thread_yield() handles the race). */
492         if (!join_target->joiner) {
493                 uthread_yield(TRUE, __pth_join_cb, join_target);
494                 /* When we return/restart, the thread will be done */
495         } else {
496                 assert(join_target->joiner == join_target);     /* sanity check */
497         }
498         if (retval)
499                 *retval = join_target->retval;
500         free(join_target);
501         return 0;
502 }
503
504 /* Callback/bottom half of exit.  Syncs with __pth_join_cb.  Here's how it
505  * works: the slot for joiner is initially 0.  Joiners try to swap themselves
506  * into that spot.  Exiters try to put 'themselves' into it.  Whoever gets 0
507  * back won the race.  If the exiter lost the race, it must wake up the joiner
508  * (which was the value from temp_pth).  If the joiner lost the race, it must
509  * wake itself up, and for sanity reasons can ensure the value from temp_pth is
510  * the join target). */
511 static void __pth_exit_cb(struct uthread *uthread, void *junk)
512 {
513         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
514         struct pthread_tcb *temp_pth = 0;
515         __pthread_generic_yield(pthread);
516         /* Catch some bugs */
517         pthread->state = PTH_EXITING;
518         /* Destroy the pthread */
519         uthread_cleanup(uthread);
520         /* Cleanup, mirroring pthread_create() */
521         __pthread_free_stack(pthread);
522         /* TODO: race on detach state (see join) */
523         if (pthread->detached) {
524                 free(pthread);
525         } else {
526                 /* See if someone is joining on us.  If not, we're done (and the
527                  * joiner will wake itself when it saw us there instead of 0). */
528                 temp_pth = atomic_swap_ptr((void**)&pthread->joiner, pthread);
529                 if (temp_pth) {
530                         /* they joined before we exited, we need to wake them */
531                         printd("[pth] %08p exiting, waking joiner %08p\n",
532                                pthread, temp_pth);
533                         pth_thread_runnable((struct uthread*)temp_pth);
534                 }
535         }
536 }
537
538 void pthread_exit(void *ret)
539 {
540         struct pthread_tcb *pthread = pthread_self();
541         pthread->retval = ret;
542         destroy_dtls();
543         uthread_yield(FALSE, __pth_exit_cb, 0);
544 }
545
546 /* Callback/bottom half of yield.  For those writing these pth callbacks, the
547  * minimum is call generic, set state (communicate with runnable), then do
548  * something that causes it to be runnable in the future (or right now). */
549 static void __pth_yield_cb(struct uthread *uthread, void *junk)
550 {
551         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
552         __pthread_generic_yield(pthread);
553         pthread->state = PTH_BLK_YIELDING;
554         /* just immediately restart it */
555         pth_thread_runnable(uthread);
556 }
557
558 /* Cooperative yielding of the processor, to allow other threads to run */
559 int pthread_yield(void)
560 {
561         uthread_yield(TRUE, __pth_yield_cb, 0);
562         return 0;
563 }
564
565 int pthread_mutexattr_init(pthread_mutexattr_t* attr)
566 {
567   attr->type = PTHREAD_MUTEX_DEFAULT;
568   return 0;
569 }
570
571 int pthread_mutexattr_destroy(pthread_mutexattr_t* attr)
572 {
573   return 0;
574 }
575
576 int pthread_attr_setdetachstate(pthread_attr_t *__attr, int __detachstate)
577 {
578         __attr->detachstate = __detachstate;
579         return 0;
580 }
581
582 int pthread_mutexattr_gettype(const pthread_mutexattr_t* attr, int* type)
583 {
584   *type = attr ? attr->type : PTHREAD_MUTEX_DEFAULT;
585   return 0;
586 }
587
588 int pthread_mutexattr_settype(pthread_mutexattr_t* attr, int type)
589 {
590   if(type != PTHREAD_MUTEX_NORMAL)
591     return EINVAL;
592   attr->type = type;
593   return 0;
594 }
595
596 int pthread_mutex_init(pthread_mutex_t* m, const pthread_mutexattr_t* attr)
597 {
598   m->attr = attr;
599   atomic_init(&m->lock, 0);
600   return 0;
601 }
602
603 /* Helper for spinning sync, returns TRUE if it is okay to keep spinning.
604  *
605  * Alternatives include:
606  *              old_count <= num_vcores() (barrier code, pass in old_count as *state, 
607  *                                         but this only works if every awake pthread
608  *                                         will belong to the barrier).
609  *              just spin for a bit       (use *state to track spins)
610  *              FALSE                     (always is safe)
611  *              etc...
612  * 'threads_ready' isn't too great since sometimes it'll be non-zero when it is
613  * about to become 0.  We really want "I have no threads waiting to run that
614  * aren't going to run on their on unless this core yields instead of spins". */
615 /* TODO: consider making this a 2LS op */
616 static inline bool safe_to_spin(unsigned int *state)
617 {
618         return !threads_ready;
619 }
620
621 /* Set *spun to 0 when calling this the first time.  It will yield after 'spins'
622  * calls.  Use this for adaptive mutexes and such. */
623 static inline void spin_to_sleep(unsigned int spins, unsigned int *spun)
624 {
625         if ((*spun)++ == spins) {
626                 pthread_yield();
627                 *spun = 0;
628         }
629 }
630
631 int pthread_mutex_lock(pthread_mutex_t* m)
632 {
633         unsigned int spinner = 0;
634         while(pthread_mutex_trylock(m))
635                 while(*(volatile size_t*)&m->lock) {
636                         cpu_relax();
637                         spin_to_sleep(PTHREAD_MUTEX_SPINS, &spinner);
638                 }
639         /* normally we'd need a wmb() and a wrmb() after locking, but the
640          * atomic_swap handles the CPU mb(), so just a cmb() is necessary. */
641         cmb();
642         return 0;
643 }
644
645 int pthread_mutex_trylock(pthread_mutex_t* m)
646 {
647   return atomic_swap(&m->lock, 1) == 0 ? 0 : EBUSY;
648 }
649
650 int pthread_mutex_unlock(pthread_mutex_t* m)
651 {
652   /* keep reads and writes inside the protected region */
653   rwmb();
654   wmb();
655   atomic_set(&m->lock, 0);
656   return 0;
657 }
658
659 int pthread_mutex_destroy(pthread_mutex_t* m)
660 {
661   return 0;
662 }
663
664 int pthread_cond_init(pthread_cond_t *c, const pthread_condattr_t *a)
665 {
666         TAILQ_INIT(&c->waiters);
667         spin_pdr_init(&c->spdr_lock);
668         if (a) {
669                 c->attr_pshared = a->pshared;
670                 c->attr_clock = a->clock;
671         } else {
672                 c->attr_pshared = PTHREAD_PROCESS_PRIVATE;
673                 c->attr_clock = 0;
674         }
675         return 0;
676 }
677
678 int pthread_cond_destroy(pthread_cond_t *c)
679 {
680         return 0;
681 }
682
683 int pthread_cond_broadcast(pthread_cond_t *c)
684 {
685         unsigned int nr_woken = 0;      /* assuming less than 4 bil threads */
686         struct pthread_queue restartees = TAILQ_HEAD_INITIALIZER(restartees);
687         struct pthread_tcb *pthread_i;
688         spin_pdr_lock(&c->spdr_lock);
689         /* moves all items from waiters onto the end of restartees */
690         TAILQ_CONCAT(&restartees, &c->waiters, next);
691         spin_pdr_unlock(&c->spdr_lock);
692         /* Do the work of pth_thread_runnable().  We're in uth context here, but I
693          * think it's okay.  When we need to (when locking) we drop into VC ctx, as
694          * far as the kernel and other cores are concerned. */
695         TAILQ_FOREACH(pthread_i, &restartees, next) {
696                 pthread_i->state = PTH_RUNNABLE;
697                 nr_woken++;
698         }
699         /* Amortize the lock grabbing over all restartees */
700         mcs_pdr_lock(&queue_lock);
701         threads_ready += nr_woken;
702         TAILQ_CONCAT(&ready_queue, &restartees, next);
703         mcs_pdr_unlock(&queue_lock);
704         if (can_adjust_vcores)
705                 vcore_request(threads_ready);
706         return 0;
707 }
708
709 /* spec says this needs to work regardless of whether or not it holds the mutex
710  * already. */
711 int pthread_cond_signal(pthread_cond_t *c)
712 {
713         struct pthread_tcb *pthread;
714         spin_pdr_lock(&c->spdr_lock);
715         pthread = TAILQ_FIRST(&c->waiters);
716         if (!pthread) {
717                 spin_pdr_unlock(&c->spdr_lock);
718                 return 0;
719         }
720         TAILQ_REMOVE(&c->waiters, pthread, next);
721         spin_pdr_unlock(&c->spdr_lock);
722         pth_thread_runnable((struct uthread*)pthread);
723         return 0;
724 }
725
726 /* Communicate btw cond_wait and its callback */
727 struct cond_junk {
728         pthread_cond_t                          *c;
729         pthread_mutex_t                         *m;
730 };
731
732 /* Callback/bottom half of cond wait.  For those writing these pth callbacks,
733  * the minimum is call generic, set state (communicate with runnable), then do
734  * something that causes it to be runnable in the future (or right now). */
735 static void __pth_wait_cb(struct uthread *uthread, void *junk)
736 {
737         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
738         pthread_cond_t *c = ((struct cond_junk*)junk)->c;
739         pthread_mutex_t *m = ((struct cond_junk*)junk)->m;
740         /* this removes us from the active list; we can reuse next below */
741         __pthread_generic_yield(pthread);
742         pthread->state = PTH_BLK_MUTEX;
743         spin_pdr_lock(&c->spdr_lock);
744         TAILQ_INSERT_TAIL(&c->waiters, pthread, next);
745         spin_pdr_unlock(&c->spdr_lock);
746         pthread_mutex_unlock(m);
747 }
748
749 int pthread_cond_wait(pthread_cond_t *c, pthread_mutex_t *m)
750 {
751         struct cond_junk local_junk;
752         local_junk.c = c;
753         local_junk.m = m;
754         uthread_yield(TRUE, __pth_wait_cb, &local_junk);
755         pthread_mutex_lock(m);
756         return 0;
757 }
758
759 int pthread_condattr_init(pthread_condattr_t *a)
760 {
761         a->pshared = PTHREAD_PROCESS_PRIVATE;
762         a->clock = 0;
763         return 0;
764 }
765
766 int pthread_condattr_destroy(pthread_condattr_t *a)
767 {
768         return 0;
769 }
770
771 int pthread_condattr_getpshared(pthread_condattr_t *a, int *s)
772 {
773         *s = a->pshared;
774         return 0;
775 }
776
777 int pthread_condattr_setpshared(pthread_condattr_t *a, int s)
778 {
779         a->pshared = s;
780         if (s == PTHREAD_PROCESS_SHARED) {
781                 printf("Warning: we don't do shared pthread condvars btw diff MCPs\n");
782                 return -1;
783         }
784         return 0;
785 }
786
787 int pthread_condattr_getclock(const pthread_condattr_t *attr,
788                               clockid_t *clock_id)
789 {
790         *clock_id = attr->clock;
791 }
792
793 int pthread_condattr_setclock(pthread_condattr_t *attr, clockid_t clock_id)
794 {
795         printf("Warning: we don't do pthread condvar clock stuff\n");
796         attr->clock = clock_id;
797 }
798
799 pthread_t pthread_self()
800 {
801   return (struct pthread_tcb*)current_uthread;
802 }
803
804 int pthread_equal(pthread_t t1, pthread_t t2)
805 {
806   return t1 == t2;
807 }
808
809 int pthread_once(pthread_once_t* once_control, void (*init_routine)(void))
810 {
811   if (atomic_swap_u32(once_control, 1) == 0)
812     init_routine();
813   return 0;
814 }
815
816 int pthread_barrier_init(pthread_barrier_t *b,
817                          const pthread_barrierattr_t *a, int count)
818 {
819         b->total_threads = count;
820         b->sense = 0;
821         atomic_set(&b->count, count);
822         spin_pdr_init(&b->lock);
823         TAILQ_INIT(&b->waiters);
824         b->nr_waiters = 0;
825         return 0;
826 }
827
828 struct barrier_junk {
829         pthread_barrier_t                               *b;
830         int                                                             ls;
831 };
832
833 /* Callback/bottom half of barrier. */
834 static void __pth_barrier_cb(struct uthread *uthread, void *junk)
835 {
836         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
837         pthread_barrier_t *b = ((struct barrier_junk*)junk)->b;
838         int ls = ((struct barrier_junk*)junk)->ls;
839         /* Removes from active list, we can reuse.  must also restart */
840         __pthread_generic_yield(pthread);
841         /* TODO: if we used a trylock, we could bail as soon as we see sense */
842         spin_pdr_lock(&b->lock);
843         /* If sense is ls (our free value), we lost the race and shouldn't sleep */
844         if (b->sense == ls) {
845                 /* TODO: i'd like to fast-path the wakeup, skipping pth_runnable */
846                 pthread->state = PTH_BLK_YIELDING;      /* not sure which state for this */
847                 spin_pdr_unlock(&b->lock);
848                 pth_thread_runnable(uthread);
849                 return;
850         }
851         /* otherwise, we sleep */
852         pthread->state = PTH_BLK_MUTEX; /* TODO: consider ignoring this */
853         TAILQ_INSERT_TAIL(&b->waiters, pthread, next);
854         b->nr_waiters++;
855         spin_pdr_unlock(&b->lock);
856 }
857
858 /* We assume that the same threads participating in the barrier this time will
859  * also participate next time.  Imagine a thread stopped right after its fetch
860  * and add - we know it is coming through eventually.  We finish and change the
861  * sense, which should allow the delayed thread to eventually break through.
862  * But if another n threads come in first, we'll set the sense back to the old
863  * value, thereby catching the delayed thread til the next barrier. 
864  *
865  * A note on preemption: if any thread gets preempted and it is never dealt
866  * with, eventually we deadlock, with all threads waiting on the last one to
867  * enter (and any stragglers from one run will be the last in the next run).
868  * One way or another, we need to handle preemptions.  The current 2LS requests
869  * an IPI for a preempt, so we'll be fine.  Any other strategies will need to
870  * consider how barriers work.  Any time we sleep, we'll be okay (since that
871  * frees up our core to handle preemptions/run other threads. */
872 int pthread_barrier_wait(pthread_barrier_t *b)
873 {
874         unsigned int spin_state = 0;
875         int ls = !b->sense;     /* when b->sense is the value we read, then we're free*/
876         int nr_waiters;
877         struct pthread_queue restartees = TAILQ_HEAD_INITIALIZER(restartees);
878         struct pthread_tcb *pthread_i;
879         struct barrier_junk local_junk;
880         
881         long old_count = atomic_fetch_and_add(&b->count, -1);
882
883         if (old_count == 1) {
884                 printd("Thread %d is last to hit the barrier, resetting...\n",
885                        pthread_self()->id);
886                 /* TODO: we might want to grab the lock right away, so a few short
887                  * circuit faster? */
888                 atomic_set(&b->count, b->total_threads);
889                 /* we still need to maintain ordering btw count and sense, in case
890                  * another thread doesn't sleep (if we wrote sense first, they could
891                  * break out, race around, and muck with count before it is time) */
892                 /* wmb(); handled by the spin lock */
893                 spin_pdr_lock(&b->lock);
894                 /* Sense is only protected in addition to decisions to sleep */
895                 b->sense = ls;  /* set to free everyone */
896                 /* All access to nr_waiters is protected by the lock */
897                 if (!b->nr_waiters) {
898                         spin_pdr_unlock(&b->lock);
899                         return PTHREAD_BARRIER_SERIAL_THREAD;
900                 }
901                 TAILQ_CONCAT(&restartees, &b->waiters, next);
902                 nr_waiters = b->nr_waiters;
903                 b->nr_waiters = 0;
904                 spin_pdr_unlock(&b->lock);
905                 /* TODO: do we really need this state tracking? */
906                 TAILQ_FOREACH(pthread_i, &restartees, next)
907                         pthread_i->state = PTH_RUNNABLE;
908                 /* bulk restart waiters (skipping pth_thread_runnable()) */
909                 mcs_pdr_lock(&queue_lock);
910                 threads_ready += nr_waiters;
911                 TAILQ_CONCAT(&ready_queue, &restartees, next);
912                 mcs_pdr_unlock(&queue_lock);
913                 if (can_adjust_vcores)
914                         vcore_request(threads_ready);
915                 return PTHREAD_BARRIER_SERIAL_THREAD;
916         } else {
917                 /* Spin if there are no other threads to run.  No sense sleeping */
918                 do {
919                         if (b->sense == ls)
920                                 return 0;
921                         cpu_relax();
922                 } while (safe_to_spin(&spin_state));
923
924                 /* Try to sleep, when we wake/return, we're free to go */
925                 local_junk.b = b;
926                 local_junk.ls = ls;
927                 uthread_yield(TRUE, __pth_barrier_cb, &local_junk);
928                 // assert(b->sense == ls);
929                 return 0;
930         }
931 }
932
933 int pthread_barrier_destroy(pthread_barrier_t *b)
934 {
935         assert(TAILQ_EMPTY(&b->waiters));
936         assert(!b->nr_waiters);
937         /* Free any locks (if we end up using an MCS) */
938         return 0;
939 }
940
941 int pthread_detach(pthread_t thread)
942 {
943         /* TODO: race on this state.  Someone could be trying to join now */
944         thread->detached = TRUE;
945         return 0;
946 }
947
948 int pthread_kill (pthread_t __threadid, int __signo)
949 {
950         printf("pthread_kill is not yet implemented!");
951         return -1;
952 }
953
954
955 int pthread_sigmask(int how, const sigset_t *set, sigset_t *oset)
956 {
957         printf("pthread_sigmask is not yet implemented!");
958         return -1;
959 }
960
961 int pthread_sigqueue(pthread_t *thread, int sig, const union sigval value)
962 {
963         printf("pthread_sigqueue is not yet implemented!");
964         return -1;
965 }
966
967 int pthread_key_create(pthread_key_t *key, void (*destructor)(void*))
968 {
969         *key = dtls_key_create(destructor);
970         assert(key);
971         return 0;
972 }
973
974 int pthread_key_delete(pthread_key_t key)
975 {
976         dtls_key_delete(key);
977         return 0;
978 }
979
980 void *pthread_getspecific(pthread_key_t key)
981 {
982         return get_dtls(key);
983 }
984
985 int pthread_setspecific(pthread_key_t key, const void *value)
986 {
987         set_dtls(key, (void*)value);
988         return 0;
989 }
990