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