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