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