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