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