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