Parlib's rstdio.h -> ros_debug.h
[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 <stdio.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 void pth_preempt_pending(void);
41 void pth_spawn_thread(uintptr_t pc_start, void *data);
42 void pth_blockon_sysc(struct syscall *sysc);
43
44 /* Event Handlers */
45 static void pth_handle_syscall(struct event_msg *ev_msg, unsigned int ev_type,
46                                bool overflow);
47
48 struct schedule_ops pthread_sched_ops = {
49         pth_init,
50         pth_sched_entry,
51         pth_thread_create,
52         pth_thread_runnable,
53         pth_thread_yield,
54         pth_thread_exit,
55         pth_blockon_sysc,
56         0, /* pth_preempt_pending, */
57         0, /* pth_spawn_thread, */
58 };
59
60 /* Publish our sched_ops, overriding the weak defaults */
61 struct schedule_ops *sched_ops = &pthread_sched_ops;
62
63 /* Static helpers */
64 static void __pthread_free_stack(struct pthread_tcb *pt);
65 static int __pthread_allocate_stack(struct pthread_tcb *pt);
66
67 /* Do whatever init you want.  Return a uthread representing thread0 (int
68  * main()) */
69 struct uthread *pth_init(void)
70 {
71         struct mcs_lock_qnode local_qn = {0};
72         /* Tell the kernel where and how we want to receive events.  This is just an
73          * example of what to do to have a notification turned on.  We're turning on
74          * USER_IPIs, posting events to vcore 0's vcpd, and telling the kernel to
75          * send to vcore 0.  Note sys_self_notify will ignore the vcoreid pref.
76          * Also note that enable_kevent() is just an example, and you probably want
77          * to use parts of event.c to do what you want. */
78         enable_kevent(EV_USER_IPI, 0, EVENT_IPI);
79
80         /* Handle syscall events.  Using small ev_qs, with no internal ev_mbox. */
81         ev_handlers[EV_SYSCALL] = pth_handle_syscall;
82         sysc_evq = malloc(sizeof(struct event_queue) * max_vcores());
83         assert(sysc_evq);
84         /* Set up each of the per-vcore syscall event queues so that they point to
85          * the VCPD/default vcore mailbox (for now)  Note you'll need the vcore to
86          * be online to get the events (for now). */
87         for (int i = 0; i < max_vcores(); i++) {
88                 sysc_evq[i].ev_mbox =  &__procdata.vcore_preempt_data[i].ev_mbox;
89                 sysc_evq[i].ev_flags = EVENT_IPI;               /* totally up to you */
90                 sysc_evq[i].ev_vcore = i;
91         }
92         /* Create a pthread_tcb for the main thread */
93         pthread_t t = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
94         assert(t);
95         t->id = get_next_pid();
96         assert(t->id == 0);
97
98         /* Put the new pthread on the active queue */
99         mcs_lock_notifsafe(&queue_lock, &local_qn);
100         threads_active++;
101         TAILQ_INSERT_TAIL(&active_queue, t, next);
102         mcs_unlock_notifsafe(&queue_lock, &local_qn);
103         return (struct uthread*)t;
104 }
105
106 /* Called from vcore entry.  Options usually include restarting whoever was
107  * running there before or running a new thread.  Events are handled out of
108  * event.c (table of function pointers, stuff like that). */
109 void __attribute__((noreturn)) pth_sched_entry(void)
110 {
111         uint32_t vcoreid = vcore_id();
112         if (current_uthread) {
113                 run_current_uthread();
114                 assert(0);
115         }
116         /* no one currently running, so lets get someone from the ready queue */
117         struct pthread_tcb *new_thread = NULL;
118         struct mcs_lock_qnode local_qn = {0};
119         /* For now, let's spin and handle events til we get a thread to run.  This
120          * will help catch races, instead of only having one core ever run a thread
121          * (if there is just one, etc).  Also, we don't need the EVENT_IPIs for this
122          * to work (since we poll handle_events() */
123         while (!new_thread) {
124                 handle_events(vcoreid);
125                 mcs_lock_notifsafe(&queue_lock, &local_qn);
126                 new_thread = TAILQ_FIRST(&ready_queue);
127                 if (new_thread) {
128                         TAILQ_REMOVE(&ready_queue, new_thread, next);
129                         TAILQ_INSERT_TAIL(&active_queue, new_thread, next);
130                         threads_active++;
131                         threads_ready--;
132                 }
133                 mcs_unlock_notifsafe(&queue_lock, &local_qn);
134         }
135         /* Instead of yielding, you could spin, turn off the core, set an alarm,
136          * whatever.  You want some logic to decide this.  Uthread code wil have
137          * helpers for this (like how we provide run_uthread()) */
138         if (!new_thread) {
139                 /* Note, we currently don't get here (due to the while loop) */
140                 printd("[P] No threads, vcore %d is yielding\n", vcore_id());
141                 /* Not actually yielding - just spin for now, so we can get syscall
142                  * unblocking events */
143                 vcore_idle();
144                 //sys_yield(0);
145                 assert(0);
146         }
147         assert(((struct uthread*)new_thread)->state != UT_RUNNING);
148         run_uthread((struct uthread*)new_thread);
149         assert(0);
150 }
151
152 /* Could move this, along with start_routine and arg, into the 2LSs */
153 static void __pthread_run(void)
154 {
155         struct pthread_tcb *me = pthread_self();
156         pthread_exit(me->start_routine(me->arg));
157 }
158
159 /* Responible for creating the uthread and initializing its user trap frame */
160 struct uthread *pth_thread_create(void (*func)(void), void *udata)
161 {
162         struct pthread_tcb *pthread;
163         pthread_attr_t *attr = (pthread_attr_t*)udata;
164         pthread = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
165         assert(pthread);
166         pthread->stacksize = PTHREAD_STACK_SIZE;        /* default */
167         pthread->id = get_next_pid();
168         pthread->detached = FALSE;                              /* default */
169         /* Respect the attributes */
170         if (attr) {
171                 if (attr->stacksize)                                    /* don't set a 0 stacksize */
172                         pthread->stacksize = attr->stacksize;
173                 if (attr->detachstate == PTHREAD_CREATE_DETACHED)
174                         pthread->detached = TRUE;
175         }
176         /* allocate a stack */
177         if (__pthread_allocate_stack(pthread))
178                 printf("We're fucked\n");
179         /* Set the u_tf to start up in __pthread_run, which will call the real
180          * start_routine and pass it the arg.  Note those aren't set until later in
181          * pthread_create(). */
182         init_user_tf(&pthread->uthread.utf, (uint32_t)__pthread_run, 
183                  (uint32_t)(pthread->stacktop));
184         return (struct uthread*)pthread;
185 }
186
187 void pth_thread_runnable(struct uthread *uthread)
188 {
189         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
190         struct mcs_lock_qnode local_qn = {0};
191         /* Insert the newly created thread into the ready queue of threads.
192          * It will be removed from this queue later when vcore_entry() comes up */
193         mcs_lock_notifsafe(&queue_lock, &local_qn);
194         TAILQ_INSERT_TAIL(&ready_queue, pthread, next);
195         threads_ready++;
196         mcs_unlock_notifsafe(&queue_lock, &local_qn);
197         /* Smarter schedulers should look at the num_vcores() and how much work is
198          * going on to make a decision about how many vcores to request. */
199         vcore_request(threads_ready);
200 }
201
202 /* The calling thread is yielding.  Do what you need to do to restart (like put
203  * yourself on a runqueue), or do some accounting.  Eventually, this might be a
204  * little more generic than just yield. */
205 void pth_thread_yield(struct uthread *uthread)
206 {
207         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
208         struct mcs_lock_qnode local_qn = {0};
209         /* Take from the active list, and put on the ready list (tail).  Don't do
210          * this until we are done completely with the thread, since it can be
211          * restarted somewhere else. */
212         mcs_lock_notifsafe(&queue_lock, &local_qn);
213         threads_active--;
214         TAILQ_REMOVE(&active_queue, pthread, next);
215         threads_ready++;
216         TAILQ_INSERT_TAIL(&ready_queue, pthread, next);
217         mcs_unlock_notifsafe(&queue_lock, &local_qn);
218 }
219
220 /* Thread is exiting, do your 2LS specific stuff.  You're in vcore context.
221  * Don't use the thread's TLS or stack or anything. */
222 void pth_thread_exit(struct uthread *uthread)
223 {
224         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
225         struct mcs_lock_qnode local_qn = {0};
226         /* Remove from the active runqueue */
227         mcs_lock_notifsafe(&queue_lock, &local_qn);
228         threads_active--;
229         TAILQ_REMOVE(&active_queue, pthread, next);
230         mcs_unlock_notifsafe(&queue_lock, &local_qn);
231         /* Cleanup, mirroring pth_thread_create() */
232         __pthread_free_stack(pthread);
233         /* TODO: race on detach state */
234         if (pthread->detached)
235                 free(pthread);
236         else
237                 pthread->finished = 1;
238 }
239
240 void pth_preempt_pending(void)
241 {
242 }
243
244 void pth_spawn_thread(uintptr_t pc_start, void *data)
245 {
246 }
247
248 /* Restarts a uthread hanging off a syscall.  For the simple pthread case, we
249  * just make it runnable and let the main scheduler code handle it.
250  *
251  * TODO: ought to have a queue of waiters on syscalls, and this should remove it
252  * from the list.  The list is needed in case we miss syscall events. */
253 static void restart_thread(struct syscall *sysc)
254 {
255         struct uthread *restartee = (struct uthread*)sysc->u_data;
256         assert(restartee);
257         assert(restartee->state == UT_BLOCKED);
258         assert(restartee->sysc == sysc);
259         restartee->sysc = 0;    /* so we don't 'reblock' on this later */
260         uthread_runnable(restartee);
261 }
262
263 /* This handler is usually run in vcore context, though I can imagine it being
264  * called by a uthread in some other threading library. */
265 static void pth_handle_syscall(struct event_msg *ev_msg, unsigned int ev_type,
266                                bool overflow)
267 {
268         struct syscall *sysc;
269         assert(in_vcore_context());
270         /* TODO: handle overflow!! */
271         if (overflow)
272                 printf("FUUUUUUUUUUUUUUUUCK, OVERFLOW!!!!!!!\n");
273         if (!ev_msg) /* just as bad as overflow */
274                 return;
275         sysc = ev_msg->ev_arg3;
276         assert(sysc);
277         restart_thread(sysc);
278 }
279
280 /* This will be called from vcore context, after the current thread has yielded
281  * and is trying to block on sysc.  Need to put it somewhere were we can wake it
282  * up when the sysc is done.  For now, we'll have the kernel send us an event
283  * when the syscall is done. */
284 void pth_blockon_sysc(struct syscall *sysc)
285 {
286         int old_flags;
287         bool need_to_restart = FALSE;
288
289         assert(current_uthread->state == UT_BLOCKED);
290         /* rip from the active queue */
291         struct mcs_lock_qnode local_qn = {0};
292         struct pthread_tcb *pthread = (struct pthread_tcb*)current_uthread;
293         mcs_lock_notifsafe(&queue_lock, &local_qn);
294         threads_active--;
295         TAILQ_REMOVE(&active_queue, pthread, next);
296         mcs_unlock_notifsafe(&queue_lock, &local_qn);
297
298         /* TODO: need to register the sysc or uthread in case we lose the
299          * message.  can put it on a (per-core) tailq or something and rip it
300          * out when it unblocks. */
301
302         /* Set things up so we can wake this thread up later */
303         sysc->u_data = current_uthread;
304         /* Register our vcore's syscall ev_q to hear about this syscall. */
305         if (!register_evq(sysc, &sysc_evq[vcore_id()])) {
306                 /* Lost the race with the call being done.  The kernel won't send the
307                  * event.  Just restart him. */
308                 restart_thread(sysc);
309         }
310         /* GIANT WARNING: do not touch the thread after this point. */
311 }
312
313 /* Pthread interface stuff and helpers */
314
315 int pthread_attr_init(pthread_attr_t *a)
316 {
317         a->stacksize = PTHREAD_STACK_SIZE;
318         a->detachstate = PTHREAD_CREATE_JOINABLE;
319         return 0;
320 }
321
322 int pthread_attr_destroy(pthread_attr_t *a)
323 {
324         return 0;
325 }
326
327 static void __pthread_free_stack(struct pthread_tcb *pt)
328 {
329         assert(!munmap(pt->stacktop - pt->stacksize, pt->stacksize));
330 }
331
332 static int __pthread_allocate_stack(struct pthread_tcb *pt)
333 {
334         assert(pt->stacksize);
335         void* stackbot = mmap(0, pt->stacksize,
336                               PROT_READ|PROT_WRITE|PROT_EXEC,
337                               MAP_POPULATE|MAP_ANONYMOUS, -1, 0);
338         if (stackbot == MAP_FAILED)
339                 return -1; // errno set by mmap
340         pt->stacktop = stackbot + pt->stacksize;
341         return 0;
342 }
343
344 // Warning, this will reuse numbers eventually
345 static int get_next_pid(void)
346 {
347         static uint32_t next_pid = 0;
348         return next_pid++;
349 }
350
351 int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize)
352 {
353         attr->stacksize = stacksize;
354         return 0;
355 }
356 int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize)
357 {
358         *stacksize = attr->stacksize;
359         return 0;
360 }
361
362 int pthread_create(pthread_t* thread, const pthread_attr_t* attr,
363                    void *(*start_routine)(void *), void* arg)
364 {
365         struct pthread_tcb *pthread =
366                (struct pthread_tcb*)uthread_create(__pthread_run, (void*)attr);
367         if (!pthread)
368                 return -1;
369         pthread->start_routine = start_routine;
370         pthread->arg = arg;
371         uthread_runnable((struct uthread*)pthread);
372         *thread = pthread;
373         return 0;
374 }
375
376 int pthread_join(pthread_t thread, void** retval)
377 {
378         /* Not sure if this is the right semantics.  There is a race if we deref
379          * thread and he is already freed (which would have happened if he was
380          * detached. */
381         if (thread->detached) {
382                 printf("[pthread] trying to join on a detached pthread");
383                 return -1;
384         }
385         while (!thread->finished)
386                 pthread_yield();
387         if (retval)
388                 *retval = thread->retval;
389         free(thread);
390         return 0;
391 }
392
393 int pthread_yield(void)
394 {
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         /* TODO: race on this state.  Someone could be trying to join now */
628         thread->detached = TRUE;
629         return 0;
630 }