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