Support for blocking and restarting uthreads (XCC)
[akaros.git] / user / pthread / pthread.c
1 #include <ros/arch/trapframe.h>
2 #include <pthread.h>
3 #include <vcore.h>
4 #include <mcs.h>
5 #include <stdlib.h>
6 #include <string.h>
7 #include <assert.h>
8 #include <rstdio.h>
9 #include <errno.h>
10 #include <parlib.h>
11 #include <ros/event.h>
12 #include <arch/atomic.h>
13 #include <arch/arch.h>
14 #include <sys/queue.h>
15 #include <sys/mman.h>
16 #include <assert.h>
17 #include <event.h>
18
19 struct pthread_queue ready_queue = TAILQ_HEAD_INITIALIZER(ready_queue);
20 struct pthread_queue active_queue = TAILQ_HEAD_INITIALIZER(active_queue);
21 mcs_lock_t queue_lock = MCS_LOCK_INIT;
22 pthread_once_t init_once = PTHREAD_ONCE_INIT;
23 int threads_ready = 0;
24 int threads_active = 0;
25
26 /* Array of syscall event queues, one per vcore, alloced in pth_init() */
27 struct event_queue *sysc_evq;
28
29 /* Helper / local functions */
30 static int get_next_pid(void);
31 static inline void spin_to_sleep(unsigned int spins, unsigned int *spun);
32
33 /* Pthread 2LS operations */
34 struct uthread *pth_init(void);
35 void pth_sched_entry(void);
36 struct uthread *pth_thread_create(void (*func)(void), void *udata);
37 void pth_thread_runnable(struct uthread *uthread);
38 void pth_thread_yield(struct uthread *uthread);
39 void pth_thread_exit(struct uthread *uthread);
40 unsigned int pth_vcores_wanted(void);
41 void pth_preempt_pending(void);
42 void pth_spawn_thread(uintptr_t pc_start, void *data);
43 void pth_blockon_sysc(struct syscall *sysc);
44
45 /* Event Handlers */
46 static void pth_handle_syscall(struct event_msg *ev_msg, unsigned int ev_type,
47                                bool overflow);
48
49 struct schedule_ops pthread_sched_ops = {
50         pth_init,
51         pth_sched_entry,
52         pth_thread_create,
53         pth_thread_runnable,
54         pth_thread_yield,
55         pth_thread_exit,
56         pth_blockon_sysc,
57         pth_vcores_wanted,
58         0, /* pth_preempt_pending, */
59         0, /* pth_spawn_thread, */
60 };
61
62 /* Publish our sched_ops, overriding the weak defaults */
63 struct schedule_ops *sched_ops = &pthread_sched_ops;
64
65 /* Static helpers */
66 static void __pthread_free_stack(struct pthread_tcb *pt);
67 static int __pthread_allocate_stack(struct pthread_tcb *pt);
68
69 /* Do whatever init you want.  Return a uthread representing thread0 (int
70  * main()) */
71 struct uthread *pth_init(void)
72 {
73         struct mcs_lock_qnode local_qn = {0};
74         /* Tell the kernel where and how we want to receive events.  This is just an
75          * example of what to do to have a notification turned on.  We're turning on
76          * USER_IPIs, posting events to vcore 0's vcpd, and telling the kernel to
77          * send to vcore 0.  Note sys_self_notify will ignore the vcoreid pref.
78          * Also note that enable_kevent() is just an example, and you probably want
79          * to use parts of event.c to do what you want. */
80         enable_kevent(EV_USER_IPI, 0, EVENT_IPI);
81
82         /* Handle syscall events.  Using small ev_qs, with no internal ev_mbox. */
83         ev_handlers[EV_SYSCALL] = pth_handle_syscall;
84         sysc_evq = malloc(sizeof(struct event_queue) * max_vcores());
85         assert(sysc_evq);
86         /* Set up each of the per-vcore syscall event queues so that they point to
87          * the VCPD/default vcore mailbox (for now)  Note you'll need the vcore to
88          * be online to get the events (for now). */
89         for (int i = 0; i < max_vcores(); i++) {
90                 sysc_evq[i].ev_mbox =  &__procdata.vcore_preempt_data[i].ev_mbox;
91                 sysc_evq[i].ev_flags = EVENT_IPI;               /* totally up to you */
92                 sysc_evq[i].ev_vcore = i;
93         }
94         /* Create a pthread_tcb for the main thread */
95         pthread_t t = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
96         t->id = get_next_pid();
97         assert(t->id == 0);
98
99         /* Put the new pthread on the active queue */
100         mcs_lock_notifsafe(&queue_lock, &local_qn);
101         threads_active++;
102         TAILQ_INSERT_TAIL(&active_queue, t, next);
103         mcs_unlock_notifsafe(&queue_lock, &local_qn);
104         return (struct uthread*)t;
105 }
106
107 /* Called from vcore entry.  Options usually include restarting whoever was
108  * running there before or running a new thread.  Events are handled out of
109  * event.c (table of function pointers, stuff like that). */
110 void __attribute__((noreturn)) pth_sched_entry(void)
111 {
112         uint32_t vcoreid = vcore_id();
113         if (current_uthread) {
114                 run_current_uthread();
115                 assert(0);
116         }
117         /* no one currently running, so lets get someone from the ready queue */
118         struct pthread_tcb *new_thread = NULL;
119         struct mcs_lock_qnode local_qn = {0};
120         mcs_lock_notifsafe(&queue_lock, &local_qn);
121         new_thread = TAILQ_FIRST(&ready_queue);
122         if (new_thread) {
123                 TAILQ_REMOVE(&ready_queue, new_thread, next);
124                 TAILQ_INSERT_TAIL(&active_queue, new_thread, next);
125                 threads_active++;
126                 threads_ready--;
127         }
128         mcs_unlock_notifsafe(&queue_lock, &local_qn);
129         /* Instead of yielding, you could spin, turn off the core, set an alarm,
130          * whatever.  You want some logic to decide this.  Uthread code wil have
131          * helpers for this (like how we provide run_uthread()) */
132         if (!new_thread) {
133                 /* TODO: consider doing something more intelligent here */
134                 printd("[P] No threads, vcore %d is yielding\n", vcore_id());
135                 /* Not actually yielding - just spin for now, so we can get syscall
136                  * unblocking events */
137                 vcore_idle();
138                 //sys_yield(0);
139                 assert(0);
140         }
141         assert(((struct uthread*)new_thread)->state != UT_RUNNING);
142         run_uthread((struct uthread*)new_thread);
143         assert(0);
144 }
145
146 /* Could move this, along with start_routine and arg, into the 2LSs */
147 static void __pthread_run(void)
148 {
149         struct pthread_tcb *me = pthread_self();
150         pthread_exit(me->start_routine(me->arg));
151 }
152
153 /* Responible for creating the uthread and initializing its user trap frame */
154 struct uthread *pth_thread_create(void (*func)(void), void *udata)
155 {
156         struct pthread_tcb *pthread;
157         pthread_attr_t *attr = (pthread_attr_t*)udata;
158         pthread = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
159         pthread->stacksize = PTHREAD_STACK_SIZE;        /* default */
160         pthread->id = get_next_pid();
161         pthread->detached = FALSE;                              /* default */
162         /* Respect the attributes */
163         if (attr) {
164                 if (attr->stacksize)                                    /* don't set a 0 stacksize */
165                         pthread->stacksize = attr->stacksize;
166                 if (attr->detachstate == PTHREAD_CREATE_DETACHED)
167                         pthread->detached = TRUE;
168         }
169         /* allocate a stack */
170         if (__pthread_allocate_stack(pthread))
171                 printf("We're fucked\n");
172         /* Set the u_tf to start up in __pthread_run, which will call the real
173          * start_routine and pass it the arg.  Note those aren't set until later in
174          * pthread_create(). */
175         init_user_tf(&pthread->uthread.utf, (uint32_t)__pthread_run, 
176                  (uint32_t)(pthread->stacktop));
177         return (struct uthread*)pthread;
178 }
179
180 void pth_thread_runnable(struct uthread *uthread)
181 {
182         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
183         struct mcs_lock_qnode local_qn = {0};
184         /* Insert the newly created thread into the ready queue of threads.
185          * It will be removed from this queue later when vcore_entry() comes up */
186         mcs_lock_notifsafe(&queue_lock, &local_qn);
187         TAILQ_INSERT_TAIL(&ready_queue, pthread, next);
188         threads_ready++;
189         mcs_unlock_notifsafe(&queue_lock, &local_qn);
190 }
191
192 /* The calling thread is yielding.  Do what you need to do to restart (like put
193  * yourself on a runqueue), or do some accounting.  Eventually, this might be a
194  * little more generic than just yield. */
195 void pth_thread_yield(struct uthread *uthread)
196 {
197         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
198         struct mcs_lock_qnode local_qn = {0};
199         /* Take from the active list, and put on the ready list (tail).  Don't do
200          * this until we are done completely with the thread, since it can be
201          * restarted somewhere else. */
202         mcs_lock_notifsafe(&queue_lock, &local_qn);
203         threads_active--;
204         TAILQ_REMOVE(&active_queue, pthread, next);
205         threads_ready++;
206         TAILQ_INSERT_TAIL(&ready_queue, pthread, next);
207         mcs_unlock_notifsafe(&queue_lock, &local_qn);
208 }
209
210 /* Thread is exiting, do your 2LS specific stuff.  You're in vcore context.
211  * Don't use the thread's TLS or stack or anything. */
212 void pth_thread_exit(struct uthread *uthread)
213 {
214         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
215         struct mcs_lock_qnode local_qn = {0};
216         /* Remove from the active runqueue */
217         mcs_lock_notifsafe(&queue_lock, &local_qn);
218         threads_active--;
219         TAILQ_REMOVE(&active_queue, pthread, next);
220         mcs_unlock_notifsafe(&queue_lock, &local_qn);
221         /* Cleanup, mirroring pth_thread_create() */
222         __pthread_free_stack(pthread);
223         /* TODO: race on detach state */
224         if (pthread->detached)
225                 free(pthread);
226         /* Once we do this, our joiner can free us.  He won't free us if we're
227          * detached, but there is still a potential race there (since he's accessing
228          * someone who is freed. */
229         pthread->finished = 1;
230 }
231
232 /* Returns how many *more* vcores we want.  Smarter schedulers should look at
233  * the num_vcores() and how much work is going on to make this decision. */
234 unsigned int pth_vcores_wanted(void)
235 {
236         return 1;
237 }
238
239 void pth_preempt_pending(void)
240 {
241 }
242
243 void pth_spawn_thread(uintptr_t pc_start, void *data)
244 {
245 }
246
247 /* Restarts a uthread hanging off a syscall.  For the simple pthread case, we
248  * just make it runnable and let the main scheduler code handle it.
249  *
250  * TODO: ought to have a queue of waiters on syscalls, and this should remove it
251  * from the list.  The list is needed in case we miss syscall events. */
252 static void restart_thread(struct syscall *sysc)
253 {
254         struct uthread *restartee = (struct uthread*)sysc->u_data;
255         assert(restartee);
256         assert(restartee->state == UT_BLOCKED);
257         assert(restartee->sysc == sysc);
258         restartee->sysc = 0;    /* so we don't 'reblock' on this later */
259         uthread_runnable(restartee);
260 }
261
262 /* This handler is usually run in vcore context, though I can imagine it being
263  * called by a uthread in some other threading library. */
264 static void pth_handle_syscall(struct event_msg *ev_msg, unsigned int ev_type,
265                                bool overflow)
266 {
267         struct syscall *sysc;
268         assert(in_vcore_context());
269         /* TODO: handle overflow!! */
270         if (overflow)
271                 printf("FUUUUUUUUUUUUUUUUCK, OVERFLOW!!!!!!!\n");
272         if (!ev_msg) /* just as bad as overflow */
273                 return;
274         sysc = ev_msg->ev_arg3;
275         assert(sysc);
276         restart_thread(sysc);
277 }
278
279 /* This will be called from vcore context, after the current thread has yielded
280  * and is trying to block on sysc.  Need to put it somewhere were we can wake it
281  * up when the sysc is done.  For now, we'll have the kernel send us an event
282  * when the syscall is done. */
283 void pth_blockon_sysc(struct syscall *sysc)
284 {
285         int old_flags;
286         bool need_to_restart = FALSE;
287
288         assert(current_uthread->state == UT_BLOCKED);
289         /* rip from the active queue */
290         struct mcs_lock_qnode local_qn = {0};
291         struct pthread_tcb *pthread = (struct pthread_tcb*)current_uthread;
292         mcs_lock_notifsafe(&queue_lock, &local_qn);
293         threads_active--;
294         TAILQ_REMOVE(&active_queue, pthread, next);
295         mcs_unlock_notifsafe(&queue_lock, &local_qn);
296
297         /* TODO: need to register the sysc or uthread in case we lose the
298          * message.  can put it on a (per-core) tailq or something and rip it
299          * out when it unblocks. */
300
301         /* Set things up so we can wake this thread up later */
302         sysc->u_data = current_uthread;
303         /* Register our vcore's syscall ev_q to hear about this syscall. */
304         if (!register_evq(sysc, &sysc_evq[vcore_id()])) {
305                 /* Lost the race with the call being done.  The kernel won't send the
306                  * event.  Just restart him. */
307                 restart_thread(sysc);
308         }
309         /* GIANT WARNING: do not touch the thread after this point. */
310 }
311
312 /* Pthread interface stuff and helpers */
313
314 int pthread_attr_init(pthread_attr_t *a)
315 {
316         a->stacksize = PTHREAD_STACK_SIZE;
317         a->detachstate = PTHREAD_CREATE_JOINABLE;
318         return 0;
319 }
320
321 int pthread_attr_destroy(pthread_attr_t *a)
322 {
323         return 0;
324 }
325
326 static void __pthread_free_stack(struct pthread_tcb *pt)
327 {
328         assert(!munmap(pt->stacktop - PTHREAD_STACK_SIZE, PTHREAD_STACK_SIZE));
329 }
330
331 static int __pthread_allocate_stack(struct pthread_tcb *pt)
332 {
333         assert(pt->stacksize);
334         void* stackbot = mmap(0, pt->stacksize,
335                               PROT_READ|PROT_WRITE|PROT_EXEC,
336                               MAP_POPULATE|MAP_ANONYMOUS, -1, 0);
337         if (stackbot == MAP_FAILED)
338                 return -1; // errno set by mmap
339         pt->stacktop = stackbot + pt->stacksize;
340         return 0;
341 }
342
343 // Warning, this will reuse numbers eventually
344 static int get_next_pid(void)
345 {
346         static uint32_t next_pid = 0;
347         return next_pid++;
348 }
349
350 int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize)
351 {
352         attr->stacksize = stacksize;
353         return 0;
354 }
355 int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize)
356 {
357         *stacksize = attr->stacksize;
358         return 0;
359 }
360
361 int pthread_create(pthread_t* thread, const pthread_attr_t* attr,
362                    void *(*start_routine)(void *), void* arg)
363 {
364         struct pthread_tcb *pthread =
365                (struct pthread_tcb*)uthread_create(__pthread_run, (void*)attr);
366         if (!pthread)
367                 return -1;
368         pthread->start_routine = start_routine;
369         pthread->arg = arg;
370         uthread_runnable((struct uthread*)pthread);
371         *thread = pthread;
372         return 0;
373 }
374
375 int pthread_join(pthread_t thread, void** retval)
376 {
377         /* Not sure if this is the right semantics.  There is a race if we deref
378          * thread and he is already freed (which would have happened if he was
379          * detached. */
380         if (thread->detached) {
381                 printf("[pthread] trying to join on a detached pthread");
382                 return -1;
383         }
384         while (!thread->finished)
385                 pthread_yield();
386         if (retval)
387                 *retval = thread->retval;
388         free(thread);
389         return 0;
390 }
391
392 int pthread_yield(void)
393 {
394         assert(!in_vcore_context());    /* try and catch the yield bug */
395         uthread_yield();
396         return 0;
397 }
398
399 int pthread_mutexattr_init(pthread_mutexattr_t* attr)
400 {
401   attr->type = PTHREAD_MUTEX_DEFAULT;
402   return 0;
403 }
404
405 int pthread_mutexattr_destroy(pthread_mutexattr_t* attr)
406 {
407   return 0;
408 }
409
410 int pthread_attr_setdetachstate(pthread_attr_t *__attr, int __detachstate)
411 {
412         __attr->detachstate = __detachstate;
413         return 0;
414 }
415
416 int pthread_mutexattr_gettype(const pthread_mutexattr_t* attr, int* type)
417 {
418   *type = attr ? attr->type : PTHREAD_MUTEX_DEFAULT;
419   return 0;
420 }
421
422 int pthread_mutexattr_settype(pthread_mutexattr_t* attr, int type)
423 {
424   if(type != PTHREAD_MUTEX_NORMAL)
425     return EINVAL;
426   attr->type = type;
427   return 0;
428 }
429
430 int pthread_mutex_init(pthread_mutex_t* m, const pthread_mutexattr_t* attr)
431 {
432   m->attr = attr;
433   m->lock = 0;
434   return 0;
435 }
436
437 /* Set *spun to 0 when calling this the first time.  It will yield after 'spins'
438  * calls.  Use this for adaptive mutexes and such. */
439 static inline void spin_to_sleep(unsigned int spins, unsigned int *spun)
440 {
441         if ((*spun)++ == spins) {
442                 pthread_yield();
443                 *spun = 0;
444         }
445 }
446
447 int pthread_mutex_lock(pthread_mutex_t* m)
448 {
449         unsigned int spinner = 0;
450         while(pthread_mutex_trylock(m))
451                 while(*(volatile size_t*)&m->lock) {
452                         cpu_relax();
453                         spin_to_sleep(PTHREAD_MUTEX_SPINS, &spinner);
454                 }
455         return 0;
456 }
457
458 int pthread_mutex_trylock(pthread_mutex_t* m)
459 {
460   return atomic_swap(&m->lock,1) == 0 ? 0 : EBUSY;
461 }
462
463 int pthread_mutex_unlock(pthread_mutex_t* m)
464 {
465   /* Need to prevent the compiler (and some arches) from reordering older
466    * stores */
467   wmb();
468   m->lock = 0;
469   return 0;
470 }
471
472 int pthread_mutex_destroy(pthread_mutex_t* m)
473 {
474   return 0;
475 }
476
477 int pthread_cond_init(pthread_cond_t *c, const pthread_condattr_t *a)
478 {
479   c->attr = a;
480   memset(c->waiters,0,sizeof(c->waiters));
481   memset(c->in_use,0,sizeof(c->in_use));
482   c->next_waiter = 0;
483   return 0;
484 }
485
486 int pthread_cond_destroy(pthread_cond_t *c)
487 {
488   return 0;
489 }
490
491 int pthread_cond_broadcast(pthread_cond_t *c)
492 {
493   memset(c->waiters,0,sizeof(c->waiters));
494   return 0;
495 }
496
497 int pthread_cond_signal(pthread_cond_t *c)
498 {
499   int i;
500   for(i = 0; i < MAX_PTHREADS; i++)
501   {
502     if(c->waiters[i])
503     {
504       c->waiters[i] = 0;
505       break;
506     }
507   }
508   return 0;
509 }
510
511 int pthread_cond_wait(pthread_cond_t *c, pthread_mutex_t *m)
512 {
513   int old_waiter = c->next_waiter;
514   int my_waiter = c->next_waiter;
515   
516   //allocate a slot
517   while (atomic_swap (& (c->in_use[my_waiter]), SLOT_IN_USE) == SLOT_IN_USE)
518   {
519     my_waiter = (my_waiter + 1) % MAX_PTHREADS;
520     assert (old_waiter != my_waiter);  // do not want to wrap around
521   }
522   c->waiters[my_waiter] = WAITER_WAITING;
523   c->next_waiter = (my_waiter+1) % MAX_PTHREADS;  // race on next_waiter but ok, because it is advisary
524
525   pthread_mutex_unlock(m);
526
527   volatile int* poll = &c->waiters[my_waiter];
528   while(*poll);
529   c->in_use[my_waiter] = SLOT_FREE;
530   pthread_mutex_lock(m);
531
532   return 0;
533 }
534
535 int pthread_condattr_init(pthread_condattr_t *a)
536 {
537   a = PTHREAD_PROCESS_PRIVATE;
538   return 0;
539 }
540
541 int pthread_condattr_destroy(pthread_condattr_t *a)
542 {
543   return 0;
544 }
545
546 int pthread_condattr_setpshared(pthread_condattr_t *a, int s)
547 {
548   a->pshared = s;
549   return 0;
550 }
551
552 int pthread_condattr_getpshared(pthread_condattr_t *a, int *s)
553 {
554   *s = a->pshared;
555   return 0;
556 }
557
558 pthread_t pthread_self()
559 {
560   return (struct pthread_tcb*)current_uthread;
561 }
562
563 int pthread_equal(pthread_t t1, pthread_t t2)
564 {
565   return t1 == t2;
566 }
567
568 /* This function cannot be migrated to a different vcore by the userspace
569  * scheduler.  Will need to sort that shit out. */
570 void pthread_exit(void *ret)
571 {
572         struct pthread_tcb *pthread = pthread_self();
573         pthread->retval = ret;
574         uthread_exit();
575 }
576
577 int pthread_once(pthread_once_t* once_control, void (*init_routine)(void))
578 {
579   if(atomic_swap(once_control,1) == 0)
580     init_routine();
581   return 0;
582 }
583
584 int pthread_barrier_init(pthread_barrier_t* b, const pthread_barrierattr_t* a, int count)
585 {
586   b->nprocs = b->count = count;
587   b->sense = 0;
588   pthread_mutex_init(&b->pmutex, 0);
589   return 0;
590 }
591
592 int pthread_barrier_wait(pthread_barrier_t* b)
593 {
594   unsigned int spinner = 0;
595   int ls = !b->sense;
596
597   pthread_mutex_lock(&b->pmutex);
598   int count = --b->count;
599   pthread_mutex_unlock(&b->pmutex);
600
601   if(count == 0)
602   {
603     printd("Thread %d is last to hit the barrier, resetting...\n", pthread_self()->id);
604     b->count = b->nprocs;
605         wmb();
606     b->sense = ls;
607     return PTHREAD_BARRIER_SERIAL_THREAD;
608   }
609   else
610   {
611     while(b->sense != ls) {
612       cpu_relax();
613       spin_to_sleep(PTHREAD_BARRIER_SPINS, &spinner);
614     }
615     return 0;
616   }
617 }
618
619 int pthread_barrier_destroy(pthread_barrier_t* b)
620 {
621   pthread_mutex_destroy(&b->pmutex);
622   return 0;
623 }
624
625 int pthread_detach(pthread_t thread)
626 {
627         thread->detached = TRUE;
628         return 0;
629 }