Moves retvals, start_routine, and args to the 2LSs
[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 /* Helper / local functions */
27 static int get_next_pid(void);
28 static inline void spin_to_sleep(unsigned int spins, unsigned int *spun);
29
30 /* Pthread 2LS operations */
31 struct uthread *pth_init(void);
32 void pth_sched_entry(void);
33 struct uthread *pth_thread_create(void (*func)(void), void *udata);
34 void pth_thread_runnable(struct uthread *uthread);
35 void pth_thread_yield(struct uthread *uthread);
36 void pth_thread_exit(struct uthread *uthread);
37 void pth_preempt_pending(void);
38 void pth_spawn_thread(uintptr_t pc_start, void *data);
39
40 struct schedule_ops pthread_sched_ops = {
41         pth_init,
42         pth_sched_entry,
43         pth_thread_create,
44         pth_thread_runnable,
45         pth_thread_yield,
46         pth_thread_exit,
47         0, /* pth_preempt_pending, */
48         0, /* pth_spawn_thread, */
49 };
50
51 /* Publish our sched_ops, overriding the weak defaults */
52 struct schedule_ops *sched_ops = &pthread_sched_ops;
53
54 /* Static helpers */
55 static void __pthread_free_stack(struct pthread_tcb *pt);
56 static int __pthread_allocate_stack(struct pthread_tcb *pt);
57
58 /* Do whatever init you want.  Return a uthread representing thread0 (int
59  * main()) */
60 struct uthread *pth_init(void)
61 {
62         /* Tell the kernel where and how we want to receive events.  This is just an
63          * example of what to do to have a notification turned on.  We're turning on
64          * USER_IPIs, posting events to vcore 0's vcpd, and telling the kernel to
65          * send to vcore 0.  Note sys_self_notify will ignore the vcoreid pref.
66          * Also note that enable_kevent() is just an example, and you probably want
67          * to use parts of event.c to do what you want. */
68         enable_kevent(EV_USER_IPI, 0, EVENT_IPI);
69
70         /* Create a pthread_tcb for the main thread */
71         pthread_t t = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
72         t->id = get_next_pid();
73         assert(t->id == 0);
74
75         /* Put the new pthread on the active queue */
76         mcs_lock_lock(&queue_lock);
77         threads_active++;
78         TAILQ_INSERT_TAIL(&active_queue, t, next);
79         mcs_lock_unlock(&queue_lock);
80         return (struct uthread*)t;
81 }
82
83 /* Called from vcore entry.  Options usually include restarting whoever was
84  * running there before or running a new thread.  Events are handled out of
85  * event.c (table of function pointers, stuff like that). */
86 void pth_sched_entry(void)
87 {
88         if (current_thread) {
89                 run_current_uthread();
90                 assert(0);
91         }
92         /* no one currently running, so lets get someone from the ready queue */
93         struct pthread_tcb *new_thread = NULL;
94         mcs_lock_lock(&queue_lock);
95         new_thread = TAILQ_FIRST(&ready_queue);
96         if (new_thread) {
97                 TAILQ_REMOVE(&ready_queue, new_thread, next);
98                 TAILQ_INSERT_TAIL(&active_queue, new_thread, next);
99                 threads_active++;
100                 threads_ready--;
101         }
102         mcs_lock_unlock(&queue_lock);
103         /* For now, this dumb logic is done here */
104         if (!new_thread) {
105                 /* TODO: consider doing something more intelligent here */
106                 printd("[P] No threads, vcore %d is yielding\n", vcore_id());
107                 sys_yield(0);
108                 assert(0);
109         }
110         run_uthread((struct uthread*)new_thread);
111         assert(0);
112 }
113
114 /* Could move this, along with start_routine and arg, into the 2LSs */
115 static void __pthread_run(void)
116 {
117         struct pthread_tcb *me = pthread_self();
118         pthread_exit(me->start_routine(me->arg));
119 }
120
121 /* Responible for creating the uthread and initializing its user trap frame */
122 struct uthread *pth_thread_create(void (*func)(void), void *udata)
123 {
124         struct pthread_tcb *pthread;
125         pthread_attr_t *attr = (pthread_attr_t*)udata;
126         pthread = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
127         pthread->stacksize = PTHREAD_STACK_SIZE;        /* default */
128         pthread->id = get_next_pid();
129         pthread->detached = FALSE;                              /* default */
130         /* Respect the attributes */
131         if (attr) {
132                 if (attr->stacksize)                                    /* don't set a 0 stacksize */
133                         pthread->stacksize = attr->stacksize;
134                 if (attr->detachstate == PTHREAD_CREATE_DETACHED)
135                         pthread->detached = TRUE;
136         }
137         /* allocate a stack */
138         if (__pthread_allocate_stack(pthread))
139                 printf("We're fucked\n");
140         /* Set the u_tf to start up in __pthread_run, which will call the real
141          * start_routine and pass it the arg.  Note those aren't set until later in
142          * pthread_create(). */
143         init_user_tf(&pthread->uthread.utf, (uint32_t)__pthread_run, 
144                  (uint32_t)(pthread->stacktop));
145         return (struct uthread*)pthread;
146 }
147
148 void pth_thread_runnable(struct uthread *uthread)
149 {
150         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
151         /* Insert the newly created thread into the ready queue of threads.
152          * It will be removed from this queue later when vcore_entry() comes up */
153         mcs_lock_lock(&queue_lock);
154         TAILQ_INSERT_TAIL(&ready_queue, pthread, next);
155         threads_ready++;
156         mcs_lock_unlock(&queue_lock);
157 }
158
159 /* The calling thread is yielding.  Do what you need to do to restart (like put
160  * yourself on a runqueue), or do some accounting.  Eventually, this might be a
161  * little more generic than just yield. */
162 void pth_thread_yield(struct uthread *uthread)
163 {
164         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
165         /* Take from the active list, and put on the ready list (tail).  Don't do
166          * this until we are done completely with the thread, since it can be
167          * restarted somewhere else. */
168         mcs_lock_lock(&queue_lock);
169         threads_active--;
170         TAILQ_REMOVE(&active_queue, pthread, next);
171         threads_ready++;
172         TAILQ_INSERT_TAIL(&ready_queue, pthread, next);
173         mcs_lock_unlock(&queue_lock);
174 }
175
176 /* Thread is exiting, do your 2LS specific stuff.  You're in vcore context.
177  * Don't use the thread's TLS or stack or anything. */
178 void pth_thread_exit(struct uthread *uthread)
179 {
180         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
181         /* Remove from the active runqueue */
182         mcs_lock_lock(&queue_lock);
183         threads_active--;
184         TAILQ_REMOVE(&active_queue, pthread, next);
185         mcs_lock_unlock(&queue_lock);
186         /* Cleanup, mirroring pth_thread_create() */
187         __pthread_free_stack(pthread);
188         /* TODO: race on detach state */
189         if (pthread->detached)
190                 free(pthread);
191         /* Once we do this, our joiner can free us.  He won't free us if we're
192          * detached, but there is still a potential race there (since he's accessing
193          * someone who is freed. */
194         pthread->finished = 1;
195 }
196
197 void pth_preempt_pending(void)
198 {
199 }
200
201 void pth_spawn_thread(uintptr_t pc_start, void *data)
202 {
203 }
204
205 /* Pthread interface stuff and helpers */
206
207 int pthread_attr_init(pthread_attr_t *a)
208 {
209         a->stacksize = PTHREAD_STACK_SIZE;
210         a->detachstate = PTHREAD_CREATE_JOINABLE;
211         return 0;
212 }
213
214 int pthread_attr_destroy(pthread_attr_t *a)
215 {
216         return 0;
217 }
218
219 static void __pthread_free_stack(struct pthread_tcb *pt)
220 {
221         assert(!munmap(pt->stacktop - PTHREAD_STACK_SIZE, PTHREAD_STACK_SIZE));
222 }
223
224 static int __pthread_allocate_stack(struct pthread_tcb *pt)
225 {
226         assert(pt->stacksize);
227         void* stackbot = mmap(0, pt->stacksize,
228                               PROT_READ|PROT_WRITE|PROT_EXEC,
229                               MAP_POPULATE|MAP_ANONYMOUS, -1, 0);
230         if (stackbot == MAP_FAILED)
231                 return -1; // errno set by mmap
232         pt->stacktop = stackbot + pt->stacksize;
233         return 0;
234 }
235
236 // Warning, this will reuse numbers eventually
237 static int get_next_pid(void)
238 {
239         static uint32_t next_pid = 0;
240         return next_pid++;
241 }
242
243 int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize)
244 {
245         attr->stacksize = stacksize;
246         return 0;
247 }
248 int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize)
249 {
250         *stacksize = attr->stacksize;
251         return 0;
252 }
253
254 int pthread_create(pthread_t* thread, const pthread_attr_t* attr,
255                    void *(*start_routine)(void *), void* arg)
256 {
257         struct pthread_tcb *pthread =
258                (struct pthread_tcb*)uthread_create(__pthread_run, (void*)attr);
259         if (!pthread)
260                 return -1;
261         pthread->start_routine = start_routine;
262         pthread->arg = arg;
263         uthread_runnable((struct uthread*)pthread);
264         *thread = pthread;
265         return 0;
266 }
267
268 int pthread_join(pthread_t thread, void** retval)
269 {
270         /* Not sure if this is the right semantics.  There is a race if we deref
271          * thread and he is already freed (which would have happened if he was
272          * detached. */
273         if (thread->detached) {
274                 printf("[pthread] trying to join on a detached pthread");
275                 return -1;
276         }
277         while (!thread->finished)
278                 pthread_yield();
279         if (retval)
280                 *retval = thread->retval;
281         free(thread);
282         return 0;
283 }
284
285 int pthread_yield(void)
286 {
287         uthread_yield();
288         return 0;
289 }
290
291 int pthread_mutexattr_init(pthread_mutexattr_t* attr)
292 {
293   attr->type = PTHREAD_MUTEX_DEFAULT;
294   return 0;
295 }
296
297 int pthread_mutexattr_destroy(pthread_mutexattr_t* attr)
298 {
299   return 0;
300 }
301
302 int pthread_attr_setdetachstate(pthread_attr_t *__attr, int __detachstate)
303 {
304         __attr->detachstate = __detachstate;
305         return 0;
306 }
307
308 int pthread_mutexattr_gettype(const pthread_mutexattr_t* attr, int* type)
309 {
310   *type = attr ? attr->type : PTHREAD_MUTEX_DEFAULT;
311   return 0;
312 }
313
314 int pthread_mutexattr_settype(pthread_mutexattr_t* attr, int type)
315 {
316   if(type != PTHREAD_MUTEX_NORMAL)
317     return EINVAL;
318   attr->type = type;
319   return 0;
320 }
321
322 int pthread_mutex_init(pthread_mutex_t* m, const pthread_mutexattr_t* attr)
323 {
324   m->attr = attr;
325   m->lock = 0;
326   return 0;
327 }
328
329 /* Set *spun to 0 when calling this the first time.  It will yield after 'spins'
330  * calls.  Use this for adaptive mutexes and such. */
331 static inline void spin_to_sleep(unsigned int spins, unsigned int *spun)
332 {
333         if ((*spun)++ == spins) {
334                 pthread_yield();
335                 *spun = 0;
336         }
337 }
338
339 int pthread_mutex_lock(pthread_mutex_t* m)
340 {
341         unsigned int spinner = 0;
342         while(pthread_mutex_trylock(m))
343                 while(*(volatile size_t*)&m->lock) {
344                         cpu_relax();
345                         spin_to_sleep(PTHREAD_MUTEX_SPINS, &spinner);
346                 }
347         return 0;
348 }
349
350 int pthread_mutex_trylock(pthread_mutex_t* m)
351 {
352   return atomic_swap(&m->lock,1) == 0 ? 0 : EBUSY;
353 }
354
355 int pthread_mutex_unlock(pthread_mutex_t* m)
356 {
357   /* Need to prevent the compiler (and some arches) from reordering older
358    * stores */
359   wmb();
360   m->lock = 0;
361   return 0;
362 }
363
364 int pthread_mutex_destroy(pthread_mutex_t* m)
365 {
366   return 0;
367 }
368
369 int pthread_cond_init(pthread_cond_t *c, const pthread_condattr_t *a)
370 {
371   c->attr = a;
372   memset(c->waiters,0,sizeof(c->waiters));
373   memset(c->in_use,0,sizeof(c->in_use));
374   c->next_waiter = 0;
375   return 0;
376 }
377
378 int pthread_cond_destroy(pthread_cond_t *c)
379 {
380   return 0;
381 }
382
383 int pthread_cond_broadcast(pthread_cond_t *c)
384 {
385   memset(c->waiters,0,sizeof(c->waiters));
386   return 0;
387 }
388
389 int pthread_cond_signal(pthread_cond_t *c)
390 {
391   int i;
392   for(i = 0; i < MAX_PTHREADS; i++)
393   {
394     if(c->waiters[i])
395     {
396       c->waiters[i] = 0;
397       break;
398     }
399   }
400   return 0;
401 }
402
403 int pthread_cond_wait(pthread_cond_t *c, pthread_mutex_t *m)
404 {
405   int old_waiter = c->next_waiter;
406   int my_waiter = c->next_waiter;
407   
408   //allocate a slot
409   while (atomic_swap (& (c->in_use[my_waiter]), SLOT_IN_USE) == SLOT_IN_USE)
410   {
411     my_waiter = (my_waiter + 1) % MAX_PTHREADS;
412     assert (old_waiter != my_waiter);  // do not want to wrap around
413   }
414   c->waiters[my_waiter] = WAITER_WAITING;
415   c->next_waiter = (my_waiter+1) % MAX_PTHREADS;  // race on next_waiter but ok, because it is advisary
416
417   pthread_mutex_unlock(m);
418
419   volatile int* poll = &c->waiters[my_waiter];
420   while(*poll);
421   c->in_use[my_waiter] = SLOT_FREE;
422   pthread_mutex_lock(m);
423
424   return 0;
425 }
426
427 int pthread_condattr_init(pthread_condattr_t *a)
428 {
429   a = PTHREAD_PROCESS_PRIVATE;
430   return 0;
431 }
432
433 int pthread_condattr_destroy(pthread_condattr_t *a)
434 {
435   return 0;
436 }
437
438 int pthread_condattr_setpshared(pthread_condattr_t *a, int s)
439 {
440   a->pshared = s;
441   return 0;
442 }
443
444 int pthread_condattr_getpshared(pthread_condattr_t *a, int *s)
445 {
446   *s = a->pshared;
447   return 0;
448 }
449
450 pthread_t pthread_self()
451 {
452   return (struct pthread_tcb*)current_thread;
453 }
454
455 int pthread_equal(pthread_t t1, pthread_t t2)
456 {
457   return t1 == t2;
458 }
459
460 /* This function cannot be migrated to a different vcore by the userspace
461  * scheduler.  Will need to sort that shit out. */
462 void pthread_exit(void *ret)
463 {
464         struct pthread_tcb *pthread = pthread_self();
465         pthread->retval = ret;
466         uthread_exit();
467 }
468
469 int pthread_once(pthread_once_t* once_control, void (*init_routine)(void))
470 {
471   if(atomic_swap(once_control,1) == 0)
472     init_routine();
473   return 0;
474 }
475
476 int pthread_barrier_init(pthread_barrier_t* b, const pthread_barrierattr_t* a, int count)
477 {
478   b->nprocs = b->count = count;
479   b->sense = 0;
480   pthread_mutex_init(&b->pmutex, 0);
481   return 0;
482 }
483
484 int pthread_barrier_wait(pthread_barrier_t* b)
485 {
486   unsigned int spinner = 0;
487   int ls = !b->sense;
488
489   pthread_mutex_lock(&b->pmutex);
490   int count = --b->count;
491   pthread_mutex_unlock(&b->pmutex);
492
493   if(count == 0)
494   {
495     printd("Thread %d is last to hit the barrier, resetting...\n", pthread_self()->id);
496     b->count = b->nprocs;
497         wmb();
498     b->sense = ls;
499     return PTHREAD_BARRIER_SERIAL_THREAD;
500   }
501   else
502   {
503     while(b->sense != ls) {
504       cpu_relax();
505       spin_to_sleep(PTHREAD_BARRIER_SPINS, &spinner);
506     }
507     return 0;
508   }
509 }
510
511 int pthread_barrier_destroy(pthread_barrier_t* b)
512 {
513   pthread_mutex_destroy(&b->pmutex);
514   return 0;
515 }
516
517 int pthread_detach(pthread_t thread)
518 {
519         thread->detached = TRUE;
520         return 0;
521 }