Pulled code specific to all 2LS out of pthread.c
[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 *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 struct uthread *pth_thread_create(void *udata)
115 {
116         struct pthread_tcb *pthread;
117         pthread_attr_t *attr = (pthread_attr_t*)udata;
118         pthread = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
119         pthread->stacksize = PTHREAD_STACK_SIZE;        /* default */
120         pthread->id = get_next_pid();
121         pthread->detached = FALSE;                              /* default */
122         /* Respect the attributes */
123         if (attr) {
124                 if (attr->stacksize)                                    /* don't set a 0 stacksize */
125                         pthread->stacksize = attr->stacksize;
126                 if (attr->detachstate == PTHREAD_CREATE_DETACHED)
127                         pthread->detached = TRUE;
128         }
129         /* allocate a stack */
130         if (__pthread_allocate_stack(pthread))
131                 printf("We're fucked\n");
132         return (struct uthread*)pthread;
133 }
134
135 void pth_thread_runnable(struct uthread *uthread)
136 {
137         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
138         /* Insert the newly created thread into the ready queue of threads.
139          * It will be removed from this queue later when vcore_entry() comes up */
140         mcs_lock_lock(&queue_lock);
141         TAILQ_INSERT_TAIL(&ready_queue, pthread, next);
142         threads_ready++;
143         mcs_lock_unlock(&queue_lock);
144 }
145
146 /* The calling thread is yielding.  Do what you need to do to restart (like put
147  * yourself on a runqueue), or do some accounting.  Eventually, this might be a
148  * little more generic than just yield. */
149 void pth_thread_yield(struct uthread *uthread)
150 {
151         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
152         /* Take from the active list, and put on the ready list (tail).  Don't do
153          * this until we are done completely with the thread, since it can be
154          * restarted somewhere else. */
155         mcs_lock_lock(&queue_lock);
156         threads_active--;
157         TAILQ_REMOVE(&active_queue, pthread, next);
158         threads_ready++;
159         TAILQ_INSERT_TAIL(&ready_queue, pthread, next);
160         mcs_lock_unlock(&queue_lock);
161 }
162
163 /* Thread is exiting, do your 2LS specific stuff.  You're in vcore context.
164  * Don't use the thread's TLS or stack or anything. */
165 void pth_thread_exit(struct uthread *uthread)
166 {
167         struct pthread_tcb *pthread = (struct pthread_tcb*)uthread;
168         /* Remove from the active runqueue */
169         mcs_lock_lock(&queue_lock);
170         threads_active--;
171         TAILQ_REMOVE(&active_queue, pthread, next);
172         mcs_lock_unlock(&queue_lock);
173         /* Cleanup, mirroring pth_thread_create() */
174         __pthread_free_stack(pthread);
175         /* TODO: race on detach state */
176         if (pthread->detached)
177                 free(pthread);
178         /* Once we do this, our joiner can free us.  He won't free us if we're
179          * detached, but there is still a potential race there (since he's accessing
180          * someone who is freed. */
181         pthread->finished = 1;
182 }
183
184 void pth_preempt_pending(void)
185 {
186 }
187
188 void pth_spawn_thread(uintptr_t pc_start, void *data)
189 {
190 }
191
192 /* Pthread interface stuff and helpers */
193
194 int pthread_attr_init(pthread_attr_t *a)
195 {
196         a->stacksize = PTHREAD_STACK_SIZE;
197         a->detachstate = PTHREAD_CREATE_JOINABLE;
198         return 0;
199 }
200
201 int pthread_attr_destroy(pthread_attr_t *a)
202 {
203         return 0;
204 }
205
206 static void __pthread_free_stack(struct pthread_tcb *pt)
207 {
208         assert(!munmap(pt->uthread.stacktop - PTHREAD_STACK_SIZE, PTHREAD_STACK_SIZE));
209 }
210
211 static int __pthread_allocate_stack(struct pthread_tcb *pt)
212 {
213         assert(pt->stacksize);
214         void* stackbot = mmap(0, pt->stacksize,
215                               PROT_READ|PROT_WRITE|PROT_EXEC,
216                               MAP_POPULATE|MAP_ANONYMOUS, -1, 0);
217         if (stackbot == MAP_FAILED)
218                 return -1; // errno set by mmap
219         pt->uthread.stacktop = stackbot + pt->stacksize;
220         return 0;
221 }
222
223 // Warning, this will reuse numbers eventually
224 static int get_next_pid(void)
225 {
226         static uint32_t next_pid = 0;
227         return next_pid++;
228 }
229
230 int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize)
231 {
232         attr->stacksize = stacksize;
233         return 0;
234 }
235 int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize)
236 {
237         *stacksize = attr->stacksize;
238         return 0;
239 }
240
241 int pthread_create(pthread_t* thread, const pthread_attr_t* attr,
242                    void *(*start_routine)(void *), void* arg)
243 {
244         struct uthread *uthread = uthread_create(start_routine, arg, (void*)attr);
245         if (!uthread)
246                 return -1;
247         *thread = (struct pthread_tcb*)uthread;
248         return 0;
249 }
250
251 int pthread_join(pthread_t thread, void** retval)
252 {
253         /* Not sure if this is the right semantics.  There is a race if we deref
254          * thread and he is already freed (which would have happened if he was
255          * detached. */
256         if (thread->detached) {
257                 printf("[pthread] trying to join on a detached pthread");
258                 return -1;
259         }
260         while (!thread->finished)
261                 pthread_yield();
262         if (retval)
263                 *retval = thread->uthread.retval;
264         free(thread);
265         return 0;
266 }
267
268 int pthread_yield(void)
269 {
270         uthread_yield();
271         return 0;
272 }
273
274 int pthread_mutexattr_init(pthread_mutexattr_t* attr)
275 {
276   attr->type = PTHREAD_MUTEX_DEFAULT;
277   return 0;
278 }
279
280 int pthread_mutexattr_destroy(pthread_mutexattr_t* attr)
281 {
282   return 0;
283 }
284
285 int pthread_attr_setdetachstate(pthread_attr_t *__attr, int __detachstate)
286 {
287         __attr->detachstate = __detachstate;
288         return 0;
289 }
290
291 int pthread_mutexattr_gettype(const pthread_mutexattr_t* attr, int* type)
292 {
293   *type = attr ? attr->type : PTHREAD_MUTEX_DEFAULT;
294   return 0;
295 }
296
297 int pthread_mutexattr_settype(pthread_mutexattr_t* attr, int type)
298 {
299   if(type != PTHREAD_MUTEX_NORMAL)
300     return EINVAL;
301   attr->type = type;
302   return 0;
303 }
304
305 int pthread_mutex_init(pthread_mutex_t* m, const pthread_mutexattr_t* attr)
306 {
307   m->attr = attr;
308   m->lock = 0;
309   return 0;
310 }
311
312 /* Set *spun to 0 when calling this the first time.  It will yield after 'spins'
313  * calls.  Use this for adaptive mutexes and such. */
314 static inline void spin_to_sleep(unsigned int spins, unsigned int *spun)
315 {
316         if ((*spun)++ == spins) {
317                 pthread_yield();
318                 *spun = 0;
319         }
320 }
321
322 int pthread_mutex_lock(pthread_mutex_t* m)
323 {
324         unsigned int spinner = 0;
325         while(pthread_mutex_trylock(m))
326                 while(*(volatile size_t*)&m->lock) {
327                         cpu_relax();
328                         spin_to_sleep(PTHREAD_MUTEX_SPINS, &spinner);
329                 }
330         return 0;
331 }
332
333 int pthread_mutex_trylock(pthread_mutex_t* m)
334 {
335   return atomic_swap(&m->lock,1) == 0 ? 0 : EBUSY;
336 }
337
338 int pthread_mutex_unlock(pthread_mutex_t* m)
339 {
340   /* Need to prevent the compiler (and some arches) from reordering older
341    * stores */
342   wmb();
343   m->lock = 0;
344   return 0;
345 }
346
347 int pthread_mutex_destroy(pthread_mutex_t* m)
348 {
349   return 0;
350 }
351
352 int pthread_cond_init(pthread_cond_t *c, const pthread_condattr_t *a)
353 {
354   c->attr = a;
355   memset(c->waiters,0,sizeof(c->waiters));
356   memset(c->in_use,0,sizeof(c->in_use));
357   c->next_waiter = 0;
358   return 0;
359 }
360
361 int pthread_cond_destroy(pthread_cond_t *c)
362 {
363   return 0;
364 }
365
366 int pthread_cond_broadcast(pthread_cond_t *c)
367 {
368   memset(c->waiters,0,sizeof(c->waiters));
369   return 0;
370 }
371
372 int pthread_cond_signal(pthread_cond_t *c)
373 {
374   int i;
375   for(i = 0; i < MAX_PTHREADS; i++)
376   {
377     if(c->waiters[i])
378     {
379       c->waiters[i] = 0;
380       break;
381     }
382   }
383   return 0;
384 }
385
386 int pthread_cond_wait(pthread_cond_t *c, pthread_mutex_t *m)
387 {
388   int old_waiter = c->next_waiter;
389   int my_waiter = c->next_waiter;
390   
391   //allocate a slot
392   while (atomic_swap (& (c->in_use[my_waiter]), SLOT_IN_USE) == SLOT_IN_USE)
393   {
394     my_waiter = (my_waiter + 1) % MAX_PTHREADS;
395     assert (old_waiter != my_waiter);  // do not want to wrap around
396   }
397   c->waiters[my_waiter] = WAITER_WAITING;
398   c->next_waiter = (my_waiter+1) % MAX_PTHREADS;  // race on next_waiter but ok, because it is advisary
399
400   pthread_mutex_unlock(m);
401
402   volatile int* poll = &c->waiters[my_waiter];
403   while(*poll);
404   c->in_use[my_waiter] = SLOT_FREE;
405   pthread_mutex_lock(m);
406
407   return 0;
408 }
409
410 int pthread_condattr_init(pthread_condattr_t *a)
411 {
412   a = PTHREAD_PROCESS_PRIVATE;
413   return 0;
414 }
415
416 int pthread_condattr_destroy(pthread_condattr_t *a)
417 {
418   return 0;
419 }
420
421 int pthread_condattr_setpshared(pthread_condattr_t *a, int s)
422 {
423   a->pshared = s;
424   return 0;
425 }
426
427 int pthread_condattr_getpshared(pthread_condattr_t *a, int *s)
428 {
429   *s = a->pshared;
430   return 0;
431 }
432
433 pthread_t pthread_self()
434 {
435   return (struct pthread_tcb*)current_thread;
436 }
437
438 int pthread_equal(pthread_t t1, pthread_t t2)
439 {
440   return t1 == t2;
441 }
442
443 /* This function cannot be migrated to a different vcore by the userspace
444  * scheduler.  Will need to sort that shit out. */
445 void pthread_exit(void *ret)
446 {
447         uthread_exit(ret);
448 }
449
450 int pthread_once(pthread_once_t* once_control, void (*init_routine)(void))
451 {
452   if(atomic_swap(once_control,1) == 0)
453     init_routine();
454   return 0;
455 }
456
457 int pthread_barrier_init(pthread_barrier_t* b, const pthread_barrierattr_t* a, int count)
458 {
459   b->nprocs = b->count = count;
460   b->sense = 0;
461   pthread_mutex_init(&b->pmutex, 0);
462   return 0;
463 }
464
465 int pthread_barrier_wait(pthread_barrier_t* b)
466 {
467   unsigned int spinner = 0;
468   int ls = !b->sense;
469
470   pthread_mutex_lock(&b->pmutex);
471   int count = --b->count;
472   pthread_mutex_unlock(&b->pmutex);
473
474   if(count == 0)
475   {
476     printd("Thread %d is last to hit the barrier, resetting...\n", pthread_self()->id);
477     b->count = b->nprocs;
478         wmb();
479     b->sense = ls;
480     return PTHREAD_BARRIER_SERIAL_THREAD;
481   }
482   else
483   {
484     while(b->sense != ls) {
485       cpu_relax();
486       spin_to_sleep(PTHREAD_BARRIER_SPINS, &spinner);
487     }
488     return 0;
489   }
490 }
491
492 int pthread_barrier_destroy(pthread_barrier_t* b)
493 {
494   pthread_mutex_destroy(&b->pmutex);
495   return 0;
496 }
497
498 int pthread_detach(pthread_t thread)
499 {
500         thread->detached = TRUE;
501         return 0;
502 }