parlib: have 2LS libraries #include parlib/stdio.h
[akaros.git] / user / pthread / pthread.c
1 #include <ros/trapframe.h>
2 #include "pthread.h"
3 #include <parlib/vcore.h>
4 #include <parlib/mcs.h>
5 #include <stdlib.h>
6 #include <string.h>
7 #include <parlib/assert.h>
8 #include <errno.h>
9 #include <parlib/parlib.h>
10 #include <ros/event.h>
11 #include <parlib/arch/atomic.h>
12 #include <parlib/arch/arch.h>
13 #include <sys/queue.h>
14 #include <sys/mman.h>
15 #include <parlib/event.h>
16 #include <parlib/ucq.h>
17 #include <parlib/signal.h>
18 #include <parlib/arch/trap.h>
19 #include <parlib/ros_debug.h>
20 #include <parlib/stdio.h>
21 #include <sys/fork_cb.h>
22
23 #include <parlib/alarm.h>
24 #include <futex.h>
25 #include <parlib/serialize.h>
26
27 /* TODO: eventually, we probably want to split this into the pthreads interface
28  * and a default 2LS.  That way, apps can use the pthreads interface and use any
29  * 2LS.  Here's a few blockers:
30  * - pthread_cleanup(): probably support at the uthread level
31  * - attrs and creation: probably use a default stack size and handle detached
32  * - getattrs_np: return -1, mostly due to the stackaddr.  Callers probably want
33  *   a real 2LS operation.
34  * Then we can split pthreads into parlib/default_sched.c (replaces thread0) and
35  * pthread.c.  After that, we can have a signal handling thread (even for
36  * 'thread0'), which allows us to close() or do other vcore-ctx-unsafe ops. */
37
38 struct pthread_queue ready_queue = TAILQ_HEAD_INITIALIZER(ready_queue);
39 struct pthread_queue active_queue = TAILQ_HEAD_INITIALIZER(active_queue);
40 struct mcs_pdr_lock queue_lock;
41 int threads_ready = 0;
42 int threads_active = 0;
43 atomic_t threads_total;
44 bool need_tls = TRUE;
45 static uint64_t fork_generation;
46 #define INIT_FORK_GENERATION 1
47
48 /* Array of per-vcore structs to manage waiting on syscalls and handling
49  * overflow.  Init'd in pth_init(). */
50 struct sysc_mgmt *sysc_mgmt = 0;
51
52 /* Helper / local functions */
53 static int get_next_pid(void);
54 static inline void pthread_exit_no_cleanup(void *ret);
55
56 /* Pthread 2LS operations */
57 static void pth_sched_init(void);
58 static void pth_sched_entry(void);
59 static void pth_thread_runnable(struct uthread *uthread);
60 static void pth_thread_paused(struct uthread *uthread);
61 static void pth_thread_blockon_sysc(struct uthread *uthread, void *sysc);
62 static void pth_thread_has_blocked(struct uthread *uthread, int flags);
63 static void pth_thread_refl_fault(struct uthread *uth,
64                                   struct user_context *ctx);
65 static void pth_thread_exited(struct uthread *uth);
66 static struct uthread *pth_thread_create(void *(*func)(void *), void *arg);
67 static void pth_thread_bulk_runnable(uth_sync_t *wakees);
68
69 /* Event Handlers */
70 static void pth_handle_syscall(struct event_msg *ev_msg, unsigned int ev_type,
71                                void *data);
72
73 struct schedule_ops pthread_sched_ops = {
74         .sched_init = pth_sched_init,
75         .sched_entry = pth_sched_entry,
76         .thread_runnable = pth_thread_runnable,
77         .thread_paused = pth_thread_paused,
78         .thread_blockon_sysc = pth_thread_blockon_sysc,
79         .thread_has_blocked = pth_thread_has_blocked,
80         .thread_refl_fault = pth_thread_refl_fault,
81         .thread_exited = pth_thread_exited,
82         .thread_create = pth_thread_create,
83         .thread_bulk_runnable = pth_thread_bulk_runnable,
84 };
85
86 struct schedule_ops *sched_ops = &pthread_sched_ops;
87
88 /* Static helpers */
89 static void __pthread_free_stack(struct pthread_tcb *pt);
90 static int __pthread_allocate_stack(struct pthread_tcb *pt);
91 static void __pth_yield_cb(struct uthread *uthread, void *junk);
92
93 /* Called from vcore entry.  Options usually include restarting whoever was
94  * running there before or running a new thread.  Events are handled out of
95  * event.c (table of function pointers, stuff like that). */
96 static void __attribute__((noreturn)) pth_sched_entry(void)
97 {
98         uint32_t vcoreid = vcore_id();
99         if (current_uthread) {
100                 /* Prep the pthread to run any pending posix signal handlers
101                  * registered via pthread_kill once it is restored. */
102                 uthread_prep_pending_signals(current_uthread);
103                 /* Run the thread itself */
104                 run_current_uthread();
105                 assert(0);
106         }
107         /* no one currently running, so lets get someone from the ready queue */
108         struct pthread_tcb *new_thread = NULL;
109
110         /* Try to get a thread.  If we get one, we'll break out and run it.  If
111          * not, we'll try to yield.  vcore_yield() might return, if we lost a
112          * race and had a new event come in, one that may make us able to get a
113          * new_thread */
114         do {
115                 handle_events(vcoreid);
116                 __check_preempt_pending(vcoreid);
117                 mcs_pdr_lock(&queue_lock);
118                 TAILQ_FOREACH(new_thread, &ready_queue, tq_next) {
119                         if (new_thread->fork_generation < fork_generation)
120                                 continue;
121                         break;
122                 }
123                 if (new_thread) {
124                         TAILQ_REMOVE(&ready_queue, new_thread, tq_next);
125                         assert(new_thread->state == PTH_RUNNABLE);
126                         new_thread->state = PTH_RUNNING;
127                         TAILQ_INSERT_TAIL(&active_queue, new_thread, tq_next);
128                         threads_active++;
129                         threads_ready--;
130                         mcs_pdr_unlock(&queue_lock);
131                         /* If you see what looks like the same uthread running
132                          * in multiple places, your list might be jacked up.
133                          * Turn this on. */
134                         printd("[P] got uthread %08p on vc %d state %08p flags %08p\n",
135                                new_thread, vcoreid,
136                                ((struct uthread*)new_thread)->state,
137                                ((struct uthread*)new_thread)->flags);
138                         break;
139                 }
140                 mcs_pdr_unlock(&queue_lock);
141                 /* no new thread, try to yield */
142                 printd("[P] No threads, vcore %d is yielding\n", vcore_id());
143                 /* TODO: you can imagine having something smarter here, like
144                  * spin for a bit before yielding. */
145                 vcore_yield(FALSE);
146         } while (1);
147         /* Prep the pthread to run any pending posix signal handlers registered
148          * via pthread_kill once it is restored. */
149         uthread_prep_pending_signals((struct uthread*)new_thread);
150         /* Run the thread itself */
151         run_uthread((struct uthread*)new_thread);
152         assert(0);
153 }
154
155 /* Could move this, along with start_routine and arg, into the 2LSs */
156 static void __pthread_run(void)
157 {
158         struct pthread_tcb *me = pthread_self();
159         pthread_exit_no_cleanup(me->start_routine(me->arg));
160 }
161
162 /* GIANT WARNING: if you make any changes to this, also change the broadcast
163  * wakeups (cond var, barrier, etc) */
164 static void pth_thread_runnable(struct uthread *uthread)
165 {
166         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
167
168         /* At this point, the 2LS can see why the thread blocked and was woken
169          * up in the first place (coupling these things together).  On the yield
170          * path, the 2LS was involved and was able to set the state.  Now when
171          * we get the thread back, we can take a look. */
172         printd("pthread %08p runnable, state was %d\n", pthread,
173                pthread->state);
174         switch (pthread->state) {
175         case (PTH_CREATED):
176         case (PTH_BLK_YIELDING):
177         case (PTH_BLK_SYSC):
178         case (PTH_BLK_PAUSED):
179         case (PTH_BLK_MUTEX):
180         case (PTH_BLK_MISC):
181                 /* can do whatever for each of these cases */
182                 break;
183         default:
184                 panic("Odd state %d for pthread %08p\n", pthread->state,
185                       pthread);
186         }
187         pthread->state = PTH_RUNNABLE;
188         /* Insert the newly created thread into the ready queue of threads.  It
189          * will be removed from this queue later when vcore_entry() comes up */
190         mcs_pdr_lock(&queue_lock);
191         /* Again, GIANT WARNING: if you change this, change batch wakeup code */
192         TAILQ_INSERT_TAIL(&ready_queue, pthread, tq_next);
193         threads_ready++;
194         mcs_pdr_unlock(&queue_lock);
195         /* Smarter schedulers should look at the num_vcores() and how much work
196          * is going on to make a decision about how many vcores to request. */
197         vcore_request_more(threads_ready);
198 }
199
200 /* For some reason not under its control, the uthread stopped running (compared
201  * to yield, which was caused by uthread/2LS code).
202  *
203  * The main case for this is if the vcore was preempted or if the vcore it was
204  * running on needed to stop.  You are given a uthread that looks like it took a
205  * notif, and had its context/silly state copied out to the uthread struct.
206  * (copyout_uthread).  Note that this will be called in the context (TLS) of the
207  * vcore that is losing the uthread.  If that vcore is running, it'll be in a
208  * preempt-event handling loop (not in your 2LS code).  If this is a big
209  * problem, I'll change it. */
210 static void pth_thread_paused(struct uthread *uthread)
211 {
212         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
213
214         __pthread_generic_yield(pthread);
215         /* communicate to pth_thread_runnable */
216         pthread->state = PTH_BLK_PAUSED;
217         /* At this point, you could do something clever, like put it at the
218          * front of the runqueue, see if it was holding a lock, do some
219          * accounting, or whatever. */
220         pth_thread_runnable(uthread);
221 }
222
223 /* Restarts a uthread hanging off a syscall.  For the simple pthread case, we
224  * just make it runnable and let the main scheduler code handle it. */
225 static void restart_thread(struct syscall *sysc)
226 {
227         struct uthread *ut_restartee = (struct uthread*)sysc->u_data;
228         /* uthread stuff here: */
229         assert(ut_restartee);
230         assert(((struct pthread_tcb*)ut_restartee)->state == PTH_BLK_SYSC);
231         assert(ut_restartee->sysc == sysc);     /* set in uthread.c */
232         ut_restartee->sysc = 0; /* so we don't 'reblock' on this later */
233         pth_thread_runnable(ut_restartee);
234 }
235
236 /* This handler is usually run in vcore context, though I can imagine it being
237  * called by a uthread in some other threading library. */
238 static void pth_handle_syscall(struct event_msg *ev_msg, unsigned int ev_type,
239                                void *data)
240 {
241         struct syscall *sysc;
242         assert(in_vcore_context());
243         /* if we just got a bit (not a msg), it should be because the process is
244          * still an SCP and hasn't started using the MCP ev_q yet (using the
245          * simple ev_q and glibc's blockon) or because the bit is still set from
246          * an old ev_q (blocking syscalls from before we could enter vcore ctx).
247          * Either way, just return.  Note that if you screwed up the pth ev_q
248          * and made it NO_MSG, you'll never notice (we used to assert(ev_msg)).
249          * */
250         if (!ev_msg)
251                 return;
252         /* It's a bug if we don't have a msg (we're handling a syscall
253          * bit-event) */
254         assert(ev_msg);
255         /* Get the sysc from the message and just restart it */
256         sysc = ev_msg->ev_arg3;
257         assert(sysc);
258         restart_thread(sysc);
259 }
260
261 /* This will be called from vcore context, after the current thread has yielded
262  * and is trying to block on sysc.  Need to put it somewhere were we can wake it
263  * up when the sysc is done.  For now, we'll have the kernel send us an event
264  * when the syscall is done. */
265 static void pth_thread_blockon_sysc(struct uthread *uthread, void *syscall)
266 {
267         struct syscall *sysc = (struct syscall*)syscall;
268         int old_flags;
269         uint32_t vcoreid = vcore_id();
270         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
271
272         __pthread_generic_yield(pthread);
273         pthread->state = PTH_BLK_SYSC;
274         /* Set things up so we can wake this thread up later */
275         sysc->u_data = uthread;
276         /* Register our vcore's syscall ev_q to hear about this syscall. */
277         if (!register_evq(sysc, sysc_mgmt[vcoreid].ev_q)) {
278                 /* Lost the race with the call being done.  The kernel won't
279                  * send the event.  Just restart him. */
280                 restart_thread(sysc);
281         }
282         /* GIANT WARNING: do not touch the thread after this point. */
283 }
284
285 static void pth_thread_has_blocked(struct uthread *uthread, int flags)
286 {
287         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
288
289         __pthread_generic_yield(pthread);
290         /* Whatever we do here, we are mostly communicating to our future selves
291          * in pth_thread_runnable(), which gets called by whoever triggered this
292          * callback */
293         switch (flags) {
294         case UTH_EXT_BLK_YIELD:
295                 pthread->state = PTH_BLK_YIELDING;
296                 break;
297         case UTH_EXT_BLK_MUTEX:
298                 pthread->state = PTH_BLK_MUTEX;
299                 break;
300         default:
301                 pthread->state = PTH_BLK_MISC;
302         };
303 }
304
305 static void __signal_and_restart(struct uthread *uthread,
306                                  int signo, int code, void *addr)
307 {
308         uthread_prep_signal_from_fault(uthread, signo, code, addr);
309         pth_thread_runnable(uthread);
310 }
311
312 static void handle_div_by_zero(struct uthread *uthread, unsigned int err,
313                                unsigned long aux)
314 {
315         __signal_and_restart(uthread, SIGFPE, FPE_INTDIV, (void*)aux);
316 }
317
318 // checks that usys in go passes its arguments correctly
319 // it only automatically checks with 7 arguments, print is for the rest
320 int go_usys_tester(uint64_t a, uint64_t b, uint64_t c, uint64_t d, uint64_t e,
321                    uint64_t f, uint64_t g, uint64_t h, uint64_t i, uint64_t j,
322                    uint64_t k, uint64_t l)
323 {
324         printf("a = %lu, b = %lu, c = %lu, d = %lu, e = %lu, f = %lu, g = %lu, h = %lu, i = %lu, j = %lu, k = %lu, l = %lu\n",
325                 a, b, c, d, e, f, g, h, i, j, k, l);
326         uint64_t ret_val = 0;
327
328         ret_val |= a;
329         ret_val |= (b << 8);
330         ret_val |= (c << 16);
331         ret_val |= (d << 24);
332         ret_val |= (e << 32);
333         ret_val |= (f << 40);
334         ret_val |= (g << 48);
335         return ret_val;
336 }
337
338 struct alarm_waiter *abort_syscall_at_abs_unix(uint64_t deadline)
339 {
340         // note the malloc of waiter instead of it going on the stack
341         struct alarm_waiter *waiter = malloc(sizeof(struct alarm_waiter));
342
343         init_awaiter(waiter, alarm_abort_sysc);
344         waiter->data = current_uthread;
345         set_awaiter_abs_unix(waiter, deadline);
346         set_alarm(waiter);
347         return waiter;
348 }
349
350 bool unset_alarm_with_free(struct alarm_waiter *waiter)
351 {
352         // we need to free the waiter we created in abort_syscall_at_abs_unix
353         bool ret = unset_alarm(waiter);
354
355         free(waiter);
356         return ret;
357 }
358
359 // ros_syscall_sync, but makes sure errors are zeros if there is no error
360 void go_syscall(struct syscall *sysc)
361 {
362         ros_syscall_sync(sysc);
363         if (!syscall_retval_is_error(sysc->num, sysc->retval)) {
364                 sysc->err = 0;
365                 sysc->errstr[0] = 0;
366         }
367 }
368
369 static void set_up_go_table(void **table)
370 {
371         table[0] = abort_syscall_at_abs_unix;
372         table[1] = unset_alarm_with_free;
373         table[2] = go_syscall;
374         table[3] = go_usys_tester;
375         table[4] = futex;
376         table[5] = serialize_argv_envp;
377         table[6] = free;
378         assert(table[7] == (void*) 0xDEADBEEF);
379 }
380
381 static void handle_gp_fault(struct uthread *uthread, unsigned int err,
382                             unsigned long aux)
383 {
384         //TODO this code is x86-64 only
385         uint64_t rax = uthread->u_ctx.tf.hw_tf.tf_rax;
386
387         // we fault with a known high 16 bits in go to set up a function pointer
388         // table, the address of the table is the low 48 bits
389         if (rax >> 48 == 0xDEAD) {
390                 set_up_go_table((void **)(0xFFFFFFFFFFFFUL & rax));
391                 // we jump over the call instruction which is 2 bytes
392                 uthread->u_ctx.tf.hw_tf.tf_rip += 2;
393                 pth_thread_runnable(uthread);
394                 return;
395         }
396         __signal_and_restart(uthread, SIGSEGV, SEGV_ACCERR, (void*)aux);
397 }
398
399 static void handle_page_fault(struct uthread *uthread, unsigned int err,
400                               unsigned long aux)
401 {
402         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
403         if (!(err & PF_VMR_BACKED)) {
404                 __signal_and_restart(uthread, SIGSEGV, SEGV_MAPERR, (void*)aux);
405         } else {
406                 syscall_async(&uthread->local_sysc, SYS_populate_va, aux, 1);
407                 __block_uthread_on_async_sysc(uthread);
408         }
409 }
410
411 static void pth_thread_refl_hw_fault(struct uthread *uthread,
412                                      unsigned int trap_nr,
413                                      unsigned int err, unsigned long aux)
414 {
415         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
416
417         __pthread_generic_yield(pthread);
418         pthread->state = PTH_BLK_SYSC;
419
420         switch (trap_nr) {
421         case HW_TRAP_DIV_ZERO:
422                 handle_div_by_zero(uthread, err, aux);
423                 break;
424         case HW_TRAP_GP_FAULT:
425                 handle_gp_fault(uthread, err, aux);
426                 break;
427         case HW_TRAP_PAGE_FAULT:
428                 handle_page_fault(uthread, err, aux);
429                 break;
430         default:
431                 printf("Pthread has unhandled fault: %d, err: %d, aux: %p\n",
432                        trap_nr, err, aux);
433                 /* Note that uthread.c already copied out our ctx into the uth
434                  * struct */
435                 print_user_context(&uthread->u_ctx);
436                 printf("Turn on printx to spew unhandled, malignant trap info\n");
437                 exit(-1);
438         }
439 }
440
441 static void pth_thread_refl_fault(struct uthread *uth,
442                                   struct user_context *ctx)
443 {
444         switch (ctx->type) {
445         case ROS_HW_CTX:
446                 pth_thread_refl_hw_fault(uth, __arch_refl_get_nr(ctx),
447                                          __arch_refl_get_err(ctx),
448                                          __arch_refl_get_aux(ctx));
449                 break;
450         default:
451                 assert(0);
452         }
453 }
454
455 static void pth_thread_exited(struct uthread *uth)
456 {
457         struct pthread_tcb *pthread = (struct pthread_tcb*)uth;
458
459         __pthread_generic_yield(pthread);
460         /* Catch some bugs */
461         pthread->state = PTH_EXITING;
462         /* Destroy the pthread */
463         uthread_cleanup(uth);
464         /* Cleanup, mirroring pthread_create() */
465         __pthread_free_stack(pthread);
466         /* If we were the last pthread, we exit for the whole process.  Keep in
467          * mind that thread0 is counted in this, so this will only happen if
468          * that thread calls pthread_exit(). */
469         if ((atomic_fetch_and_add(&threads_total, -1) == 1))
470                 exit(0);
471 }
472
473 /* Careful, if someone used the pthread_need_tls() hack to turn off TLS, it will
474  * also be turned off for these threads. */
475 static struct uthread *pth_thread_create(void *(*func)(void *), void *arg)
476 {
477         struct pthread_tcb *pth;
478         int ret;
479
480         ret = pthread_create(&pth, NULL, func, arg);
481         return ret == 0 ? (struct uthread*)pth : NULL;
482 }
483
484 static void pth_thread_bulk_runnable(uth_sync_t *wakees)
485 {
486         struct uthread *uth_i;
487         struct pthread_tcb *pth_i;
488
489         /* Amortize the lock grabbing over all restartees */
490         mcs_pdr_lock(&queue_lock);
491         while ((uth_i = __uth_sync_get_next(wakees))) {
492                 pth_i = (struct pthread_tcb*)uth_i;
493                 pth_i->state = PTH_RUNNABLE;
494                 TAILQ_INSERT_TAIL(&ready_queue, pth_i, tq_next);
495                 threads_ready++;
496         }
497         mcs_pdr_unlock(&queue_lock);
498         vcore_request_more(threads_ready);
499 }
500
501 /* Akaros pthread extensions / hacks */
502
503 /* Careful using this - glibc and gcc are likely to use TLS without you knowing
504  * it. */
505 void pthread_need_tls(bool need)
506 {
507         need_tls = need;
508 }
509
510 /* Pthread interface stuff and helpers */
511
512 int pthread_attr_init(pthread_attr_t *a)
513 {
514         a->stackaddr = 0;
515         a->stacksize = PTHREAD_STACK_SIZE;
516         a->detachstate = PTHREAD_CREATE_JOINABLE;
517         /* priority and policy should be set by anyone changing inherit. */
518         a->sched_priority = 0;
519         a->sched_policy = 0;
520         a->sched_inherit = PTHREAD_INHERIT_SCHED;
521         return 0;
522 }
523
524 int pthread_attr_destroy(pthread_attr_t *a)
525 {
526         return 0;
527 }
528
529 static void __pthread_free_stack(struct pthread_tcb *pt)
530 {
531         int ret = munmap(pt->stacktop - pt->stacksize, pt->stacksize);
532         assert(!ret);
533 }
534
535 static int __pthread_allocate_stack(struct pthread_tcb *pt)
536 {
537         int force_a_page_fault;
538         assert(pt->stacksize);
539         void* stackbot = mmap(0, pt->stacksize,
540                               PROT_READ | PROT_WRITE | PROT_EXEC,
541                               MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
542         if (stackbot == MAP_FAILED)
543                 return -1; // errno set by mmap
544         pt->stacktop = stackbot + pt->stacksize;
545         /* Want the top of the stack populated, but not the rest of the stack;
546          * that'll grow on demand (up to pt->stacksize) */
547         force_a_page_fault = ACCESS_ONCE(*(int*)(pt->stacktop - sizeof(int)));
548         return 0;
549 }
550
551 // Warning, this will reuse numbers eventually
552 static int get_next_pid(void)
553 {
554         static uint32_t next_pid = 0;
555         return next_pid++;
556 }
557
558 int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize)
559 {
560         attr->stacksize = stacksize;
561         return 0;
562 }
563
564 int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize)
565 {
566         *stacksize = attr->stacksize;
567         return 0;
568 }
569
570 int pthread_attr_setguardsize(pthread_attr_t *attr, size_t guardsize)
571 {
572         attr->guardsize = guardsize;
573         return 0;
574 }
575
576 int pthread_attr_getguardsize(pthread_attr_t *attr, size_t *guardsize)
577 {
578         *guardsize = attr->guardsize;
579         return 0;
580 }
581
582 int pthread_attr_getstack(const pthread_attr_t *__restrict __attr,
583                           void **__stackaddr, size_t *__stacksize)
584 {
585         *__stackaddr = __attr->stackaddr;
586         *__stacksize = __attr->stacksize;
587         return 0;
588 }
589
590 int pthread_getattr_np(pthread_t __th, pthread_attr_t *__attr)
591 {
592         struct uthread *uth = (struct uthread*)__th;
593
594         __attr->stackaddr = __th->stacktop - __th->stacksize;
595         __attr->stacksize = __th->stacksize;
596         if (atomic_read(&uth->join_ctl.state) == UTH_JOIN_DETACHED)
597                 __attr->detachstate = PTHREAD_CREATE_DETACHED;
598         else
599                 __attr->detachstate = PTHREAD_CREATE_JOINABLE;
600         return 0;
601 }
602
603 /* All multi-threading is suspended during a fork.  Thread0 will continue to
604  * run, which could come up if SYS_fork blocks or we get interrupted.  Parents
605  * will continue threading after the fork, like normal.  Old threads in the
606  * child will never run again.  New threads in the child will run. */
607 static void pth_pre_fork(void)
608 {
609         struct pthread_tcb *pth_0 = (struct pthread_tcb*)current_uthread;
610
611         if (!uthread_is_thread0(current_uthread))
612                 panic("Tried to fork from a non-thread0 thread!");
613         if (in_multi_mode())
614                 panic("Tried to fork from an MCP!");
615         pth_0->fork_generation = fork_generation + 1;
616         /* in case we get interrupted after incrementing the global gen */
617         cmb();
618         /* We're single-core and thread0 here, so we can modify fork_generation
619          */
620         fork_generation++;
621         /* At this point, whether we come back as the child or the parent, no
622          * old thread (from the previous generation) will run. */
623 }
624
625 static void pth_post_fork(pid_t ret)
626 {
627         struct pthread_tcb *pth_0 = (struct pthread_tcb*)current_uthread;
628
629         if (ret) {
630                 fork_generation--;
631                 pth_0->fork_generation = fork_generation;
632         }
633 }
634
635 /* Do whatever init you want.  At some point call uthread_2ls_init() and pass it
636  * a uthread representing thread0 (int main()) */
637 void pth_sched_init(void)
638 {
639         uintptr_t mmap_block;
640         struct pthread_tcb *t;
641         int ret;
642
643         mcs_pdr_init(&queue_lock);
644         fork_generation = INIT_FORK_GENERATION;
645         /* Create a pthread_tcb for the main thread */
646         ret = posix_memalign((void**)&t, __alignof__(struct pthread_tcb),
647                              sizeof(struct pthread_tcb));
648         assert(!ret);
649         /* aggressively 0 for bugs */
650         memset(t, 0, sizeof(struct pthread_tcb));
651         t->id = get_next_pid();
652         t->fork_generation = fork_generation;
653         t->stacksize = USTACK_NUM_PAGES * PGSIZE;
654         t->stacktop = (void*)USTACKTOP;
655         t->state = PTH_RUNNING;
656         /* implies that sigmasks are longs, which they are. */
657         assert(t->id == 0);
658         SLIST_INIT(&t->cr_stack);
659         /* Put the new pthread (thread0) on the active queue */
660         mcs_pdr_lock(&queue_lock);
661         threads_active++;
662         TAILQ_INSERT_TAIL(&active_queue, t, tq_next);
663         mcs_pdr_unlock(&queue_lock);
664         /* Tell the kernel where and how we want to receive events.  This is
665          * just an example of what to do to have a notification turned on.
666          * We're turning on USER_IPIs, posting events to vcore 0's vcpd, and
667          * telling the kernel to send to vcore 0.  Note sys_self_notify will
668          * ignore the vcoreid and private preference.  Also note that
669          * enable_kevent() is just an example, and you probably want to use
670          * parts of event.c to do what you want. */
671         enable_kevent(EV_USER_IPI, 0, EVENT_IPI | EVENT_VCORE_PRIVATE);
672         /* Set up the per-vcore structs to track outstanding syscalls */
673         sysc_mgmt = malloc(sizeof(struct sysc_mgmt) * max_vcores());
674         assert(sysc_mgmt);
675 #if 1   /* Independent ev_mboxes per vcore */
676         /* Get a block of pages for our per-vcore (but non-VCPD) ev_qs */
677         mmap_block = (uintptr_t)mmap(0, PGSIZE * 2 * max_vcores(),
678                                      PROT_WRITE | PROT_READ,
679                                      MAP_POPULATE | MAP_ANONYMOUS | MAP_PRIVATE,
680                                      -1, 0);
681         assert(mmap_block);
682         /* Could be smarter and do this on demand (in case we don't actually
683          * want max_vcores()). */
684         for (int i = 0; i < max_vcores(); i++) {
685                 /* Each vcore needs to point to a non-VCPD ev_q */
686                 sysc_mgmt[i].ev_q = get_eventq_raw();
687                 sysc_mgmt[i].ev_q->ev_flags = EVENT_IPI | EVENT_INDIR |
688                                               EVENT_SPAM_INDIR | EVENT_WAKEUP;
689                 sysc_mgmt[i].ev_q->ev_vcore = i;
690                 sysc_mgmt[i].ev_q->ev_mbox->type = EV_MBOX_UCQ;
691                 ucq_init_raw(&sysc_mgmt[i].ev_q->ev_mbox->ucq,
692                              mmap_block + (2 * i    ) * PGSIZE, 
693                              mmap_block + (2 * i + 1) * PGSIZE); 
694         }
695         /* Technically, we should munmap and free what we've alloc'd, but the
696          * kernel will clean it up for us when we exit. */
697 #endif 
698 #if 0   /* One global ev_mbox, separate ev_q per vcore */
699         struct event_mbox *sysc_mbox = malloc(sizeof(struct event_mbox));
700         uintptr_t two_pages = (uintptr_t)mmap(0, PGSIZE * 2, PROT_WRITE |
701                                               PROT_READ, MAP_POPULATE |
702                                               MAP_ANONYMOUS | MAP_PRIVATE, -1,
703                                               0);
704         printd("Global ucq: %08p\n", &sysc_mbox->ev_msgs);
705         assert(sysc_mbox);
706         assert(two_pages);
707         memset(sysc_mbox, 0, sizeof(struct event_mbox));
708         sysc_mbox->type = EV_MBOX_UCQ;
709         ucq_init_raw(&sysc_mbox->ucq, two_pages, two_pages + PGSIZE);
710         for (int i = 0; i < max_vcores(); i++) {
711                 sysc_mgmt[i].ev_q = get_eventq_slim();
712                 sysc_mgmt[i].ev_q->ev_flags = EVENT_IPI | EVENT_INDIR |
713                                               EVENT_SPAM_INDIR | EVENT_WAKEUP;
714                 sysc_mgmt[i].ev_q->ev_vcore = i;
715                 sysc_mgmt[i].ev_q->ev_mbox = sysc_mbox;
716         }
717 #endif
718         uthread_2ls_init((struct uthread*)t, pth_handle_syscall, NULL);
719         atomic_init(&threads_total, 1);                 /* one for thread0 */
720         pre_fork_2ls = pth_pre_fork;
721         post_fork_2ls = pth_post_fork;
722 }
723
724 /* Make sure our scheduler runs inside an MCP rather than an SCP. */
725 void pthread_mcp_init()
726 {
727         /* Prevent this from happening more than once. */
728         parlib_init_once_racy(return);
729
730         uthread_mcp_init();
731         /* From here forward we are an MCP running on vcore 0. Could consider
732          * doing other pthread specific initialization based on knowing we are
733          * an mcp after this point. */
734 }
735
736 int __pthread_create(pthread_t *thread, const pthread_attr_t *attr,
737                      void *(*start_routine)(void *), void *arg)
738 {
739         struct uth_thread_attr uth_attr = {0};
740         struct pthread_tcb *parent;
741         struct pthread_tcb *pthread;
742         int ret;
743
744         /* For now, unconditionally become an mcp when creating a pthread (if
745          * not one already). This may change in the future once we support 2LSs
746          * in an SCP. */
747         pthread_mcp_init();
748
749         parent = (struct pthread_tcb*)current_uthread;
750         ret = posix_memalign((void**)&pthread, __alignof__(struct pthread_tcb),
751                              sizeof(struct pthread_tcb));
752         assert(!ret);
753         /* aggressively 0 for bugs*/
754         memset(pthread, 0, sizeof(struct pthread_tcb));
755         pthread->stacksize = PTHREAD_STACK_SIZE;        /* default */
756         pthread->state = PTH_CREATED;
757         pthread->id = get_next_pid();
758         pthread->fork_generation = fork_generation;
759         SLIST_INIT(&pthread->cr_stack);
760         /* Respect the attributes */
761         if (attr) {
762                 if (attr->stacksize)    /* don't set a 0 stacksize */
763                         pthread->stacksize = attr->stacksize;
764                 if (attr->detachstate == PTHREAD_CREATE_DETACHED)
765                         uth_attr.detached = TRUE;
766         }
767         /* allocate a stack */
768         if (__pthread_allocate_stack(pthread))
769                 printf("We're fucked\n");
770         /* Set the u_tf to start up in __pthread_run, which will call the real
771          * start_routine and pass it the arg.  Note those aren't set until later
772          * in pthread_create(). */
773         init_user_ctx(&pthread->uthread.u_ctx, (uintptr_t)&__pthread_run,
774                       (uintptr_t)(pthread->stacktop));
775         pthread->start_routine = start_routine;
776         pthread->arg = arg;
777         /* Initialize the uthread */
778         if (need_tls)
779                 uth_attr.want_tls = TRUE;
780         uthread_init((struct uthread*)pthread, &uth_attr);
781         *thread = pthread;
782         atomic_inc(&threads_total);
783         return 0;
784 }
785
786 int pthread_create(pthread_t *thread, const pthread_attr_t *attr,
787                    void *(*start_routine)(void *), void *arg)
788 {
789         if (!__pthread_create(thread, attr, start_routine, arg))
790                 pth_thread_runnable((struct uthread*)*thread);
791         return 0;
792 }
793
794 /* Helper that all pthread-controlled yield paths call.  Just does some
795  * accounting.  This is another example of how the much-loathed (and loved)
796  * active queue is keeping us honest.  Need to export for sem and friends. */
797 void __pthread_generic_yield(struct pthread_tcb *pthread)
798 {
799         mcs_pdr_lock(&queue_lock);
800         threads_active--;
801         TAILQ_REMOVE(&active_queue, pthread, tq_next);
802         mcs_pdr_unlock(&queue_lock);
803 }
804
805 int pthread_join(struct pthread_tcb *join_target, void **retval)
806 {
807         uthread_join((struct uthread*)join_target, retval);
808         return 0;
809 }
810
811 static inline void pthread_exit_no_cleanup(void *ret)
812 {
813         struct pthread_tcb *pthread = pthread_self();
814
815         while (SLIST_FIRST(&pthread->cr_stack))
816                 pthread_cleanup_pop(FALSE);
817         destroy_dtls();
818         uth_2ls_thread_exit(ret);
819 }
820
821 void pthread_exit(void *ret)
822 {
823         struct pthread_tcb *pthread = pthread_self();
824         while (SLIST_FIRST(&pthread->cr_stack))
825                 pthread_cleanup_pop(TRUE);
826         pthread_exit_no_cleanup(ret);
827 }
828
829 /* Cooperative yielding of the processor, to allow other threads to run */
830 int pthread_yield(void)
831 {
832         uthread_sched_yield();
833         return 0;
834 }
835
836 int pthread_cancel(pthread_t __th)
837 {
838         fprintf(stderr, "Unsupported %s!", __FUNCTION__);
839         abort();
840         return -1;
841 }
842
843 void pthread_cleanup_push(void (*routine)(void *), void *arg)
844 {
845         struct pthread_tcb *p = pthread_self();
846         struct pthread_cleanup_routine *r = malloc(sizeof(*r));
847
848         r->routine = routine;
849         r->arg = arg;
850         SLIST_INSERT_HEAD(&p->cr_stack, r, cr_next);
851 }
852
853 void pthread_cleanup_pop(int execute)
854 {
855         struct pthread_tcb *p = pthread_self();
856         struct pthread_cleanup_routine *r = SLIST_FIRST(&p->cr_stack);
857
858         if (r) {
859                 SLIST_REMOVE_HEAD(&p->cr_stack, cr_next);
860                 if (execute)
861                         r->routine(r->arg);
862                 free(r);
863         }
864 }
865
866 int pthread_mutexattr_init(pthread_mutexattr_t *attr)
867 {
868         attr->type = PTHREAD_MUTEX_DEFAULT;
869         return 0;
870 }
871
872 int pthread_mutexattr_destroy(pthread_mutexattr_t *attr)
873 {
874         return 0;
875 }
876
877 int pthread_attr_setdetachstate(pthread_attr_t *__attr, int __detachstate)
878 {
879         __attr->detachstate = __detachstate;
880         return 0;
881 }
882
883 int pthread_mutexattr_gettype(const pthread_mutexattr_t *attr, int *type)
884 {
885         *type = attr ? attr->type : PTHREAD_MUTEX_DEFAULT;
886         return 0;
887 }
888
889 static bool __pthread_mutex_type_ok(int type)
890 {
891         switch (type) {
892         case PTHREAD_MUTEX_NORMAL:
893         case PTHREAD_MUTEX_RECURSIVE:
894                 return TRUE;
895         }
896         return FALSE;
897 }
898
899 int pthread_mutexattr_settype(pthread_mutexattr_t *attr, int type)
900 {
901         if (!__pthread_mutex_type_ok(type))
902                 return EINVAL;
903         attr->type = type;
904         return 0;
905 }
906
907 int pthread_mutex_init(pthread_mutex_t *m, const pthread_mutexattr_t *attr)
908 {
909         if (attr) {
910                 if (!__pthread_mutex_type_ok(attr->type))
911                         return EINVAL;
912                 m->type = attr->type;
913         } else {
914                 m->type = PTHREAD_MUTEX_NORMAL;
915         }
916         switch (m->type) {
917         case PTHREAD_MUTEX_NORMAL:
918                 uth_mutex_init(&m->mtx);
919                 break;
920         case PTHREAD_MUTEX_RECURSIVE:
921                 uth_recurse_mutex_init(&m->r_mtx);
922                 break;
923         }
924         return 0;
925 }
926
927 int pthread_mutex_lock(pthread_mutex_t *m)
928 {
929         switch (m->type) {
930         case PTHREAD_MUTEX_NORMAL:
931                 uth_mutex_lock(&m->mtx);
932                 break;
933         case PTHREAD_MUTEX_RECURSIVE:
934                 uth_recurse_mutex_lock(&m->r_mtx);
935                 break;
936         default:
937                 panic("Bad pth mutex type %d!", m->type);
938         }
939         return 0;
940 }
941
942 int pthread_mutex_trylock(pthread_mutex_t *m)
943 {
944         bool got_it;
945
946         switch (m->type) {
947         case PTHREAD_MUTEX_NORMAL:
948                 got_it = uth_mutex_trylock(&m->mtx);
949                 break;
950         case PTHREAD_MUTEX_RECURSIVE:
951                 got_it = uth_recurse_mutex_trylock(&m->r_mtx);
952                 break;
953         default:
954                 panic("Bad pth mutex type %d!", m->type);
955         }
956         return got_it ? 0 : EBUSY;
957 }
958
959 int pthread_mutex_unlock(pthread_mutex_t *m)
960 {
961         switch (m->type) {
962         case PTHREAD_MUTEX_NORMAL:
963                 uth_mutex_unlock(&m->mtx);
964                 break;
965         case PTHREAD_MUTEX_RECURSIVE:
966                 uth_recurse_mutex_unlock(&m->r_mtx);
967                 break;
968         default:
969                 panic("Bad pth mutex type %d!", m->type);
970         }
971         return 0;
972 }
973
974 int pthread_mutex_destroy(pthread_mutex_t *m)
975 {
976         switch (m->type) {
977         case PTHREAD_MUTEX_NORMAL:
978                 uth_mutex_destroy(&m->mtx);
979                 break;
980         case PTHREAD_MUTEX_RECURSIVE:
981                 uth_recurse_mutex_destroy(&m->r_mtx);
982                 break;
983         default:
984                 panic("Bad pth mutex type %d!", m->type);
985         }
986         return 0;
987 }
988
989 int pthread_mutex_timedlock(pthread_mutex_t *m, const struct timespec *abstime)
990 {
991         bool got_it;
992
993         switch (m->type) {
994         case PTHREAD_MUTEX_NORMAL:
995                 got_it = uth_mutex_timed_lock(&m->mtx, abstime);
996                 break;
997         case PTHREAD_MUTEX_RECURSIVE:
998                 got_it = uth_recurse_mutex_timed_lock(&m->r_mtx, abstime);
999                 break;
1000         default:
1001                 panic("Bad pth mutex type %d!", m->type);
1002         }
1003         return got_it ? 0 : ETIMEDOUT;
1004 }
1005
1006 int pthread_cond_init(pthread_cond_t *c, const pthread_condattr_t *a)
1007 {
1008         if (a) {
1009                 if (a->pshared != PTHREAD_PROCESS_PRIVATE)
1010                         fprintf(stderr,
1011                                 "pthreads only supports private condvars");
1012                 /* We also ignore clock_id */
1013         }
1014         uth_cond_var_init(c);
1015         return 0;
1016 }
1017
1018 int pthread_cond_destroy(pthread_cond_t *c)
1019 {
1020         uth_cond_var_destroy(c);
1021         return 0;
1022 }
1023
1024 int pthread_cond_broadcast(pthread_cond_t *c)
1025 {
1026         uth_cond_var_broadcast(c);
1027         return 0;
1028 }
1029
1030 /* spec says this needs to work regardless of whether or not it holds the mutex
1031  * already. */
1032 int pthread_cond_signal(pthread_cond_t *c)
1033 {
1034         uth_cond_var_signal(c);
1035         return 0;
1036 }
1037
1038 int pthread_cond_wait(pthread_cond_t *c, pthread_mutex_t *m)
1039 {
1040         switch (m->type) {
1041         case PTHREAD_MUTEX_NORMAL:
1042                 uth_cond_var_wait(c, &m->mtx);
1043                 break;
1044         case PTHREAD_MUTEX_RECURSIVE:
1045                 uth_cond_var_wait_recurse(c, &m->r_mtx);
1046                 break;
1047         default:
1048                 panic("Bad pth mutex type %d!", m->type);
1049         }
1050         return 0;
1051 }
1052
1053 int pthread_cond_timedwait(pthread_cond_t *c, pthread_mutex_t *m,
1054                            const struct timespec *abstime)
1055 {
1056         bool got_it;
1057
1058         switch (m->type) {
1059         case PTHREAD_MUTEX_NORMAL:
1060                 got_it = uth_cond_var_timed_wait(c, &m->mtx, abstime);
1061                 break;
1062         case PTHREAD_MUTEX_RECURSIVE:
1063                 got_it = uth_cond_var_timed_wait_recurse(c, &m->r_mtx, abstime);
1064                 break;
1065         default:
1066                 panic("Bad pth mutex type %d!", m->type);
1067         }
1068         return got_it ? 0 : ETIMEDOUT;
1069 }
1070
1071 int pthread_condattr_init(pthread_condattr_t *a)
1072 {
1073         a->pshared = PTHREAD_PROCESS_PRIVATE;
1074         a->clock = 0;
1075         return 0;
1076 }
1077
1078 int pthread_condattr_destroy(pthread_condattr_t *a)
1079 {
1080         return 0;
1081 }
1082
1083 int pthread_condattr_getpshared(pthread_condattr_t *a, int *s)
1084 {
1085         *s = a->pshared;
1086         return 0;
1087 }
1088
1089 int pthread_condattr_setpshared(pthread_condattr_t *a, int s)
1090 {
1091         a->pshared = s;
1092         if (s == PTHREAD_PROCESS_SHARED) {
1093                 printf("Warning: we don't do shared pthread condvars btw diff MCPs\n");
1094                 return -1;
1095         }
1096         return 0;
1097 }
1098
1099 int pthread_condattr_getclock(const pthread_condattr_t *attr,
1100                               clockid_t *clock_id)
1101 {
1102         *clock_id = attr->clock;
1103         return 0;
1104 }
1105
1106 int pthread_condattr_setclock(pthread_condattr_t *attr, clockid_t clock_id)
1107 {
1108         printf("Warning: we don't do pthread condvar clock stuff\n");
1109         attr->clock = clock_id;
1110         return 0;
1111 }
1112
1113 int pthread_rwlock_init(pthread_rwlock_t *rwl, const pthread_rwlockattr_t *a)
1114 {
1115         uth_rwlock_init(rwl);
1116         return 0;
1117 }
1118
1119 int pthread_rwlock_destroy(pthread_rwlock_t *rwl)
1120 {
1121         uth_rwlock_destroy(rwl);
1122         return 0;
1123 }
1124
1125 int pthread_rwlock_rdlock(pthread_rwlock_t *rwl)
1126 {
1127         uth_rwlock_rdlock(rwl);
1128         return 0;
1129 }
1130
1131 int pthread_rwlock_tryrdlock(pthread_rwlock_t *rwl)
1132 {
1133         return uth_rwlock_try_rdlock(rwl) ? 0 : EBUSY;
1134 }
1135
1136 int pthread_rwlock_wrlock(pthread_rwlock_t *rwl)
1137 {
1138         uth_rwlock_wrlock(rwl);
1139         return 0;
1140 }
1141
1142 int pthread_rwlock_trywrlock(pthread_rwlock_t *rwl)
1143 {
1144         return uth_rwlock_try_wrlock(rwl) ? 0 : EBUSY;
1145 }
1146
1147 int pthread_rwlock_unlock(pthread_rwlock_t *rwl)
1148 {
1149         uth_rwlock_unlock(rwl);
1150         return 0;
1151 }
1152
1153 pthread_t pthread_self(void)
1154 {
1155         return (struct pthread_tcb*)uthread_self();
1156 }
1157
1158 int pthread_equal(pthread_t t1, pthread_t t2)
1159 {
1160         return t1 == t2;
1161 }
1162
1163 int pthread_once(pthread_once_t *once_control, void (*init_routine)(void))
1164 {
1165         /* pthread_once's init routine doesn't take an argument, like parlibs.
1166          * This means the func will be run with an argument passed to it, but
1167          * it'll be ignored. */
1168         parlib_run_once(once_control, (void (*)(void *))init_routine, NULL);
1169         /* The return for pthread_once isn't an error from the function, it's
1170          * just an overall error.  Note pthread's init_routine() has no return
1171          * value. */
1172         return 0;
1173 }
1174
1175 int pthread_barrier_init(pthread_barrier_t *b,
1176                          const pthread_barrierattr_t *a, int count)
1177 {
1178         b->total_threads = count;
1179         b->sense = 0;
1180         atomic_set(&b->count, count);
1181         spin_pdr_init(&b->lock);
1182         __uth_sync_init(&b->waiters);
1183         b->nr_waiters = 0;
1184         return 0;
1185 }
1186
1187 struct barrier_junk {
1188         pthread_barrier_t               *b;
1189         int                             ls;
1190 };
1191
1192 /* Helper for spinning sync, returns TRUE if it is okay to keep spinning.
1193  *
1194  * Alternatives include:
1195  *      old_count <= num_vcores() (barrier code, pass in old_count as *state,
1196  *                                 but this only works if every awake pthread
1197  *                                 will belong to the barrier).
1198  *      just spin for a bit       (use *state to track spins)
1199  *      FALSE                     (always is safe)
1200  *      etc...
1201  * 'threads_ready' isn't too great since sometimes it'll be non-zero when it is
1202  * about to become 0.  We really want "I have no threads waiting to run that
1203  * aren't going to run on their on unless this core yields instead of spins". */
1204 /* TODO: consider making this a 2LS op */
1205 static inline bool safe_to_spin(unsigned int *state)
1206 {
1207         return (*state)++ % PTHREAD_BARRIER_SPINS;
1208 }
1209
1210 /* Callback/bottom half of barrier. */
1211 static void __pth_barrier_cb(struct uthread *uthread, void *junk)
1212 {
1213         pthread_barrier_t *b = ((struct barrier_junk*)junk)->b;
1214         int ls = ((struct barrier_junk*)junk)->ls;
1215
1216         uthread_has_blocked(uthread, UTH_EXT_BLK_MUTEX);
1217         /* TODO: if we used a trylock, we could bail as soon as we see sense */
1218         spin_pdr_lock(&b->lock);
1219         /* If sense is ls (our free value), we lost the race and shouldn't sleep
1220          */
1221         if (b->sense == ls) {
1222                 spin_pdr_unlock(&b->lock);
1223                 uthread_runnable(uthread);
1224                 return;
1225         }
1226         /* otherwise, we sleep */
1227         __uth_sync_enqueue(uthread, &b->waiters);
1228         b->nr_waiters++;
1229         spin_pdr_unlock(&b->lock);
1230 }
1231
1232 /* We assume that the same threads participating in the barrier this time will
1233  * also participate next time.  Imagine a thread stopped right after its fetch
1234  * and add - we know it is coming through eventually.  We finish and change the
1235  * sense, which should allow the delayed thread to eventually break through.
1236  * But if another n threads come in first, we'll set the sense back to the old
1237  * value, thereby catching the delayed thread til the next barrier. 
1238  *
1239  * A note on preemption: if any thread gets preempted and it is never dealt
1240  * with, eventually we deadlock, with all threads waiting on the last one to
1241  * enter (and any stragglers from one run will be the last in the next run).
1242  * One way or another, we need to handle preemptions.  The current 2LS requests
1243  * an IPI for a preempt, so we'll be fine.  Any other strategies will need to
1244  * consider how barriers work.  Any time we sleep, we'll be okay (since that
1245  * frees up our core to handle preemptions/run other threads. */
1246 int pthread_barrier_wait(pthread_barrier_t *b)
1247 {
1248         unsigned int spin_state = 0;
1249         /* when b->sense is the value we read, then we're free*/
1250         int ls = !b->sense;
1251         uth_sync_t restartees;
1252         struct uthread *uth_i;
1253         struct barrier_junk local_junk;
1254         
1255         long old_count = atomic_fetch_and_add(&b->count, -1);
1256
1257         if (old_count == 1) {
1258                 /* TODO: we might want to grab the lock right away, so a few
1259                  * short circuit faster? */
1260                 atomic_set(&b->count, b->total_threads);
1261                 /* we still need to maintain ordering btw count and sense, in
1262                  * case another thread doesn't sleep (if we wrote sense first,
1263                  * they could break out, race around, and muck with count before
1264                  * it is time) */
1265                 /* wmb(); handled by the spin lock */
1266                 spin_pdr_lock(&b->lock);
1267                 /* Sense is only protected in addition to decisions to sleep */
1268                 b->sense = ls;  /* set to free everyone */
1269                 /* All access to nr_waiters is protected by the lock */
1270                 if (!b->nr_waiters) {
1271                         spin_pdr_unlock(&b->lock);
1272                         return PTHREAD_BARRIER_SERIAL_THREAD;
1273                 }
1274                 __uth_sync_init(&restartees);
1275                 __uth_sync_swap(&restartees, &b->waiters);
1276                 b->nr_waiters = 0;
1277                 spin_pdr_unlock(&b->lock);
1278                 __uth_sync_wake_all(&restartees);
1279                 return PTHREAD_BARRIER_SERIAL_THREAD;
1280         } else {
1281                 /* Spin if there are no other threads to run.  No sense sleeping
1282                  */
1283                 do {
1284                         if (b->sense == ls)
1285                                 return 0;
1286                         cpu_relax();
1287                 } while (safe_to_spin(&spin_state));
1288
1289                 /* Try to sleep, when we wake/return, we're free to go */
1290                 local_junk.b = b;
1291                 local_junk.ls = ls;
1292                 uthread_yield(TRUE, __pth_barrier_cb, &local_junk);
1293                 // assert(b->sense == ls);
1294                 return 0;
1295         }
1296 }
1297
1298 int pthread_barrier_destroy(pthread_barrier_t *b)
1299 {
1300         assert(!b->nr_waiters);
1301         __uth_sync_destroy(&b->waiters);
1302         /* Free any locks (if we end up using an MCS) */
1303         return 0;
1304 }
1305
1306 int pthread_detach(pthread_t thread)
1307 {
1308         uthread_detach((struct uthread*)thread);
1309         return 0;
1310 }
1311
1312 int pthread_kill(pthread_t thread, int signo)
1313 {
1314         return uthread_signal(&thread->uthread, signo);
1315 }
1316
1317 int pthread_sigmask(int how, const sigset_t *set, sigset_t *oset)
1318 {
1319         int ret = sigprocmask(how, set, oset);
1320
1321         /* Ensures any pending signals we just unmasked get processed. */
1322         if (set && ret == 0)
1323                 pthread_yield();
1324         return ret;
1325 }
1326
1327 int pthread_sigqueue(pthread_t *thread, int sig, const union sigval value)
1328 {
1329         printf("pthread_sigqueue is not yet implemented!");
1330         return -1;
1331 }
1332
1333 int pthread_key_create(pthread_key_t *key, void (*destructor)(void*))
1334 {
1335         *key = dtls_key_create(destructor);
1336         assert(key);
1337         return 0;
1338 }
1339
1340 int pthread_key_delete(pthread_key_t key)
1341 {
1342         dtls_key_delete(key);
1343         return 0;
1344 }
1345
1346 void *pthread_getspecific(pthread_key_t key)
1347 {
1348         return get_dtls(key);
1349 }
1350
1351 int pthread_setspecific(pthread_key_t key, const void *value)
1352 {
1353         set_dtls(key, (void*)value);
1354         return 0;
1355 }
1356
1357
1358 /* Scheduling Stuff.  Actually, these don't tell the 2LS anything - they just
1359  * pretend to muck with attrs and params, as expected by pthreads apps. */
1360
1361 int pthread_attr_setschedparam(pthread_attr_t *attr,
1362                                const struct sched_param *param)
1363 {
1364         /* The set of acceptable priorities are based on the scheduling policy.
1365          * We'll just accept any old number, since we might not know the policy
1366          * yet.  I didn't see anything in the man pages saying attr had to have
1367          * a policy set before setting priority. */
1368         attr->sched_priority = param->sched_priority;
1369         return 0;
1370 }
1371
1372 int pthread_attr_getschedparam(pthread_attr_t *attr,
1373                                struct sched_param *param)
1374 {
1375         param->sched_priority = attr->sched_priority;
1376         return 0;
1377 }
1378
1379 int pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy)
1380 {
1381         attr->sched_policy = policy;
1382         return 0;
1383 }
1384
1385 int pthread_attr_getschedpolicy(pthread_attr_t *attr, int *policy)
1386 {
1387         *policy = attr->sched_policy;
1388         return 0;
1389 }
1390
1391 /* We only support SCOPE_PROCESS, so we don't even use the attr. */
1392 int pthread_attr_setscope(pthread_attr_t *attr, int scope)
1393 {
1394         if (scope != PTHREAD_SCOPE_PROCESS)
1395                 return -ENOTSUP;
1396         return 0;
1397 }
1398
1399 int pthread_attr_getscope(pthread_attr_t *attr, int *scope)
1400 {
1401         *scope = PTHREAD_SCOPE_PROCESS;
1402         return 0;
1403 }
1404
1405 /* Inheritance refers to policy, priority, scope */
1406 int pthread_attr_setinheritsched(pthread_attr_t *attr,
1407                                  int inheritsched)
1408 {
1409         switch (inheritsched) {
1410                 case PTHREAD_INHERIT_SCHED:
1411                 case PTHREAD_EXPLICIT_SCHED:
1412                         break;
1413                 default:
1414                         return -EINVAL;
1415         }
1416         attr->sched_inherit = inheritsched;
1417         return 0;
1418 }
1419
1420 int pthread_attr_getinheritsched(const pthread_attr_t *attr,
1421                                  int *inheritsched)
1422 {
1423         *inheritsched = attr->sched_inherit;
1424         return 0;
1425 }
1426
1427 int pthread_setschedparam(pthread_t thread, int policy,
1428                            const struct sched_param *param)
1429 {
1430         return 0;
1431 }
1432
1433 int pthread_getschedparam(pthread_t thread, int *policy,
1434                            struct sched_param *param)
1435 {
1436         /* Faking {FIFO, 0}.  It's up to the 2LS to do whatever it wants. */
1437         *policy = SCHED_FIFO;
1438         param->sched_priority = 0;
1439         return 0;
1440 }