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