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