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