2LS handles pending preemptions
[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 __thread struct pthread_tcb *current_thread = 0;
31
32 void _pthread_init()
33 {
34         if (vcore_init())
35                 printf("vcore_init() failed, we're fucked!\n");
36         
37         assert(vcore_id() == 0);
38
39         /* Tell the kernel where and how we want to receive events.  This is just an
40          * example of what to do to have a notification turned on.  We're turning on
41          * USER_IPIs, posting events to vcore 0's vcpd, and telling the kernel to
42          * send to vcore 0.  Note sys_self_notify will ignore the vcoreid pref.
43          * Also note that enable_kevent() is just an example, and you probably want
44          * to use parts of event.c to do what you want. */
45         enable_kevent(EV_USER_IPI, 0, EVENT_IPI);
46
47         /* don't forget to enable notifs on vcore0.  if you don't, the kernel will
48          * restart your _S with notifs disabled, which is a path to confusion. */
49         enable_notifs(0);
50
51         /* Create a pthread_tcb for the main thread */
52         pthread_t t = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
53         t->id = get_next_pid();
54         assert(t->id == 0);
55         /* Put the new pthread on the active queue */
56         mcs_lock_lock(&queue_lock);
57         threads_active++;
58         TAILQ_INSERT_TAIL(&active_queue, t, next);
59         mcs_lock_unlock(&queue_lock);
60         
61         /* Save a pointer to the newly created threads tls region into its tcb */
62         t->tls_desc = get_tls_desc(0);
63         /* Save a pointer to the pthread in its own TLS */
64         current_thread = t;
65
66         /* Change temporarily to vcore0s tls region so we can save the newly created
67          * tcb into its current_thread variable and then restore it.  One minor
68          * issue is that vcore0's transition-TLS isn't TLS_INITed yet.  Until it is
69          * (right before vcore_entry(), don't try and take the address of any of
70          * its TLS vars. */
71         extern void** vcore_thread_control_blocks;
72         set_tls_desc(vcore_thread_control_blocks[0], 0);
73         current_thread = t;
74         set_tls_desc(t->tls_desc, 0);
75
76         // TODO: consider replacing this when we have an interface allowing
77         // requesting absolute num vcores, and moving it to pthread_create and
78         // asking for 2
79         vcore_request(1);
80 }
81
82 void __attribute__((noreturn)) vcore_entry()
83 {
84         uint32_t vcoreid = vcore_id();
85
86         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
87
88         /* Should always have notifications disabled when coming in here. */
89         assert(vcpd->notif_enabled == FALSE);
90
91         check_preempt_pending(vcoreid);
92         handle_events(vcoreid);
93         // TODO: consider making this restart path work for restarting as well as
94         // freshly starting
95         if (current_thread) {
96                 vcpd->notif_pending = 0;
97                 /* Do one last check for notifs after clearing pending */
98                 // TODO: call the handle_notif() here (first)
99
100                 set_tls_desc(current_thread->tls_desc, vcoreid);
101                 /* Pop the user trap frame */
102                 pop_ros_tf(&vcpd->notif_tf, vcoreid);
103                 assert(0);
104         }
105
106         /* no one currently running, so lets get someone from the ready queue */
107         struct pthread_tcb *new_thread = NULL;
108         mcs_lock_lock(&queue_lock);
109         new_thread = TAILQ_FIRST(&ready_queue);
110         if (new_thread) {
111                 TAILQ_REMOVE(&ready_queue, new_thread, next);
112                 TAILQ_INSERT_TAIL(&active_queue, new_thread, next);
113                 threads_active++;
114                 threads_ready--;
115         }
116         mcs_lock_unlock(&queue_lock);
117         if (!new_thread) {
118                 /* TODO: consider doing something more intelligent here */
119                 printd("[P] No threads, vcore %d is yielding\n", vcoreid);
120                 sys_yield(0);
121         }
122         /* Save a ptr to the pthread running in the transition context's TLS */
123         current_thread = new_thread;
124         printd("[P] Vcore %d is starting pthread %d\n", vcoreid, new_thread->id);
125
126         vcpd->notif_pending = 0;
127         /* Do one last check for notifs after clearing pending */
128         // TODO: call the handle_notif() here (first)
129         set_tls_desc(new_thread->tls_desc, vcoreid);
130
131         /* Load silly state (Floating point) too.  For real */
132         // TODO: (HSS)
133
134         /* Pop the user trap frame */
135         pop_ros_tf(&new_thread->utf, vcoreid);
136         assert(0);
137 }
138
139 int pthread_attr_init(pthread_attr_t *a)
140 {
141         a->stacksize = PTHREAD_STACK_SIZE;
142         a->detachstate = PTHREAD_CREATE_JOINABLE;
143         return 0;
144 }
145
146 int pthread_attr_destroy(pthread_attr_t *a)
147 {
148         return 0;
149 }
150
151 /* TODO: probably don't want to dealloc.  Considering caching */
152 static void __pthread_free_tls(struct pthread_tcb *pt)
153 {
154         extern void _dl_deallocate_tls (void *tcb, bool dealloc_tcb) internal_function;
155
156         assert(pt->tls_desc);
157         _dl_deallocate_tls(pt->tls_desc, TRUE);
158         pt->tls_desc = NULL;
159 }
160
161 static int __pthread_allocate_tls(struct pthread_tcb *pt)
162 {
163         assert(!pt->tls_desc);
164         pt->tls_desc = allocate_tls();
165         if (!pt->tls_desc) {
166                 errno = ENOMEM;
167                 return -1;
168         }
169         return 0;
170 }
171
172
173 static void __pthread_free_stack(struct pthread_tcb *pt)
174 {
175         assert(!munmap(pt->stacktop - PTHREAD_STACK_SIZE, PTHREAD_STACK_SIZE));
176 }
177
178 static int __pthread_allocate_stack(struct pthread_tcb *pt)
179 {
180         assert(pt->stacksize);
181         void* stackbot = mmap(0, pt->stacksize,
182                               PROT_READ|PROT_WRITE|PROT_EXEC,
183                               MAP_POPULATE|MAP_ANONYMOUS, -1, 0);
184         if (stackbot == MAP_FAILED)
185                 return -1; // errno set by mmap
186         pt->stacktop = stackbot + pt->stacksize;
187         return 0;
188 }
189
190 void __pthread_run(void)
191 {
192         struct pthread_tcb *me = current_thread;
193         pthread_exit(me->start_routine(me->arg));
194 }
195
196 // Warning, this will reuse numbers eventually
197 static int get_next_pid(void)
198 {
199         static uint32_t next_pid = 0;
200         return next_pid++;
201 }
202
203
204 int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize)
205 {
206         attr->stacksize = stacksize;
207         return 0;
208 }
209 int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize)
210 {
211         *stacksize = attr->stacksize;
212         return 0;
213 }
214
215 int pthread_create(pthread_t* thread, const pthread_attr_t* attr,
216                    void *(*start_routine)(void *), void* arg)
217 {
218         /* After this init, we are an MCP and the caller is a pthread */
219         pthread_once(&init_once,&_pthread_init);
220
221         struct pthread_tcb *t = pthread_self();
222         assert(t); /* TODO/FYI: doesn't prevent this from being in vcore context */
223         /* Don't migrate this thread to anothe vcore, since it depends on being on
224          * the same vcore throughout. */
225         t->dont_migrate = TRUE;
226         uint32_t vcoreid = vcore_id();
227         *thread = (pthread_t)calloc(1, sizeof(struct pthread_tcb));
228         (*thread)->start_routine = start_routine;
229         (*thread)->arg = arg;
230         (*thread)->stacksize = PTHREAD_STACK_SIZE;      /* default */
231         (*thread)->id = get_next_pid();
232         (*thread)->detached = FALSE;                            /* default */
233         /* Respect the attributes*/
234         if (attr) {
235                 if (attr->stacksize)                                    /* don't set a 0 stacksize */
236                         (*thread)->stacksize = attr->stacksize;
237                 if (attr->detachstate == PTHREAD_CREATE_DETACHED)
238                         (*thread)->detached = TRUE;
239         }
240         if (__pthread_allocate_stack(*thread) ||  __pthread_allocate_tls(*thread))
241                 printf("We're fucked\n");
242         /* Save the ptr to the new pthread in that pthread's TLS */
243         set_tls_desc((*thread)->tls_desc, vcoreid);
244         current_thread = *thread;
245         set_tls_desc(t->tls_desc, vcoreid);
246         /* Set the u_tf to start up in __pthread_run, which will call the real
247          * start_routine and pass it the arg. */
248         init_user_tf(&(*thread)->utf, (uint32_t)__pthread_run, 
249                  (uint32_t)((*thread)->stacktop));
250         /* Insert the newly created thread into the ready queue of threads.
251          * It will be removed from this queue later when vcore_entry() comes up */
252         mcs_lock_lock(&queue_lock);
253         TAILQ_INSERT_TAIL(&ready_queue, *thread, next);
254         threads_ready++;
255         mcs_lock_unlock(&queue_lock);
256         /* Okay to migrate now. */
257         t->dont_migrate = FALSE;
258         /* Attempt to request a new core, may or may not get it... */
259         vcore_request(1);
260         return 0;
261 }
262
263 int pthread_join(pthread_t thread, void** retval)
264 {
265         /* Not sure if this is the right semantics.  There is a race if we deref
266          * thread and he is already freed (which would have happened if he was
267          * detached. */
268         if (thread->detached) {
269                 printf("[pthread] trying to join on a detached pthread");
270                 return -1;
271         }
272         while (!thread->finished)
273                 pthread_yield();
274         if (retval)
275                 *retval = thread->retval;
276         free(thread);
277         return 0;
278 }
279
280 static void __attribute__((noinline, noreturn)) 
281 __pthread_yield(struct pthread_tcb *t)
282 {
283         /* TODO: want to set this to FALSE once we no longer depend on being on this
284          * vcore.  Though if we are using TLS, we are depending on the vcore.  Since
285          * notifs are disabled and we are in a transition context, we probably
286          * shouldn't be moved anyway.  It does mean that a pthread could get jammed.
287          * If we do this after putting it on the active list, we'll have a race on
288          * dont_migrate. */
289         t->dont_migrate = FALSE;
290         /* Take from the active list, and put on the ready list (tail).  Don't do
291          * this until we are done completely with the thread, since it can be
292          * restarted somewhere else. */
293         mcs_lock_lock(&queue_lock);
294         threads_active--;
295         TAILQ_REMOVE(&active_queue, t, next);
296         threads_ready++;
297         TAILQ_INSERT_TAIL(&ready_queue, t, next);
298         mcs_lock_unlock(&queue_lock);
299         /* Leave the current vcore completely */
300         current_thread = NULL; // this might be okay, even with a migration
301         /* Go back to the entry point, where we can handle notifications or
302          * reschedule someone. */
303         vcore_entry();
304 }
305
306 int pthread_yield(void)
307 {
308         struct pthread_tcb *t = pthread_self();
309         volatile bool yielding = TRUE; /* signal to short circuit when restarting */
310
311         /* TODO: (HSS) Save silly state */
312         // save_fp_state(&t->as);
313
314         /* Don't migrate this thread to another vcore, since it depends on being on
315          * the same vcore throughout (once it disables notifs). */
316         t->dont_migrate = TRUE;
317         uint32_t vcoreid = vcore_id();
318         printd("[P] Pthread id %d is yielding on vcore %d\n", t->id, vcoreid);
319         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
320         /* once we do this, we might miss a notif_pending, so we need to enter vcore
321          * entry later.  Need to disable notifs so we don't get in weird loops with
322          * save_ros_tf() and pop_ros_tf(). */
323         disable_notifs(vcoreid);
324         /* take the current state and save it into t->utf when this pthread
325          * restarts, it will continue from right after this, see yielding is false,
326          * and short ciruit the function. */
327         save_ros_tf(&t->utf);
328         if (!yielding)
329                 goto yield_return_path;
330         yielding = FALSE; /* for when it starts back up */
331         /* Change to the transition context (both TLS and stack). */
332         extern void** vcore_thread_control_blocks;
333         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
334         assert(current_thread == t);    
335         /* After this, make sure you don't use local variables.  Note the warning in
336          * pthread_exit() */
337         set_stack_pointer((void*)vcpd->transition_stack);
338         /* Finish exiting in another function. */
339         __pthread_yield(current_thread);
340         /* Should never get here */
341         assert(0);
342         /* Will jump here when the pthread's trapframe is restarted/popped. */
343 yield_return_path:
344         printd("[P] pthread %d returning from a yield!\n", t->id);
345         return 0;
346 }
347
348 int pthread_mutexattr_init(pthread_mutexattr_t* attr)
349 {
350   attr->type = PTHREAD_MUTEX_DEFAULT;
351   return 0;
352 }
353
354 int pthread_mutexattr_destroy(pthread_mutexattr_t* attr)
355 {
356   return 0;
357 }
358
359
360 int pthread_attr_setdetachstate(pthread_attr_t *__attr, int __detachstate)
361 {
362         __attr->detachstate = __detachstate;
363         return 0;
364 }
365
366 int pthread_mutexattr_gettype(const pthread_mutexattr_t* attr, int* type)
367 {
368   *type = attr ? attr->type : PTHREAD_MUTEX_DEFAULT;
369   return 0;
370 }
371
372 int pthread_mutexattr_settype(pthread_mutexattr_t* attr, int type)
373 {
374   if(type != PTHREAD_MUTEX_NORMAL)
375     return EINVAL;
376   attr->type = type;
377   return 0;
378 }
379
380 int pthread_mutex_init(pthread_mutex_t* m, const pthread_mutexattr_t* attr)
381 {
382   m->attr = attr;
383   m->lock = 0;
384   return 0;
385 }
386
387 /* Set *spun to 0 when calling this the first time.  It will yield after 'spins'
388  * calls.  Use this for adaptive mutexes and such. */
389 static inline void spin_to_sleep(unsigned int spins, unsigned int *spun)
390 {
391         if ((*spun)++ == spins) {
392                 pthread_yield();
393                 *spun = 0;
394         }
395 }
396
397 int pthread_mutex_lock(pthread_mutex_t* m)
398 {
399         unsigned int spinner = 0;
400         while(pthread_mutex_trylock(m))
401                 while(*(volatile size_t*)&m->lock) {
402                         cpu_relax();
403                         spin_to_sleep(PTHREAD_MUTEX_SPINS, &spinner);
404                 }
405         return 0;
406 }
407
408 int pthread_mutex_trylock(pthread_mutex_t* m)
409 {
410   return atomic_swap(&m->lock,1) == 0 ? 0 : EBUSY;
411 }
412
413 int pthread_mutex_unlock(pthread_mutex_t* m)
414 {
415   /* Need to prevent the compiler (and some arches) from reordering older
416    * stores */
417   wmb();
418   m->lock = 0;
419   return 0;
420 }
421
422 int pthread_mutex_destroy(pthread_mutex_t* m)
423 {
424   return 0;
425 }
426
427 int pthread_cond_init(pthread_cond_t *c, const pthread_condattr_t *a)
428 {
429   c->attr = a;
430   memset(c->waiters,0,sizeof(c->waiters));
431   memset(c->in_use,0,sizeof(c->in_use));
432   c->next_waiter = 0;
433   return 0;
434 }
435
436 int pthread_cond_destroy(pthread_cond_t *c)
437 {
438   return 0;
439 }
440
441 int pthread_cond_broadcast(pthread_cond_t *c)
442 {
443   memset(c->waiters,0,sizeof(c->waiters));
444   return 0;
445 }
446
447 int pthread_cond_signal(pthread_cond_t *c)
448 {
449   int i;
450   for(i = 0; i < MAX_PTHREADS; i++)
451   {
452     if(c->waiters[i])
453     {
454       c->waiters[i] = 0;
455       break;
456     }
457   }
458   return 0;
459 }
460
461 int pthread_cond_wait(pthread_cond_t *c, pthread_mutex_t *m)
462 {
463   int old_waiter = c->next_waiter;
464   int my_waiter = c->next_waiter;
465   
466   //allocate a slot
467   while (atomic_swap (& (c->in_use[my_waiter]), SLOT_IN_USE) == SLOT_IN_USE)
468   {
469     my_waiter = (my_waiter + 1) % MAX_PTHREADS;
470     assert (old_waiter != my_waiter);  // do not want to wrap around
471   }
472   c->waiters[my_waiter] = WAITER_WAITING;
473   c->next_waiter = (my_waiter+1) % MAX_PTHREADS;  // race on next_waiter but ok, because it is advisary
474
475   pthread_mutex_unlock(m);
476
477   volatile int* poll = &c->waiters[my_waiter];
478   while(*poll);
479   c->in_use[my_waiter] = SLOT_FREE;
480   pthread_mutex_lock(m);
481
482   return 0;
483 }
484
485 int pthread_condattr_init(pthread_condattr_t *a)
486 {
487   a = PTHREAD_PROCESS_PRIVATE;
488   return 0;
489 }
490
491 int pthread_condattr_destroy(pthread_condattr_t *a)
492 {
493   return 0;
494 }
495
496 int pthread_condattr_setpshared(pthread_condattr_t *a, int s)
497 {
498   a->pshared = s;
499   return 0;
500 }
501
502 int pthread_condattr_getpshared(pthread_condattr_t *a, int *s)
503 {
504   *s = a->pshared;
505   return 0;
506 }
507
508 pthread_t pthread_self()
509 {
510   return current_thread;
511 }
512
513 int pthread_equal(pthread_t t1, pthread_t t2)
514 {
515   return t1 == t2;
516 }
517
518 /* Need to have this as a separate, non-inlined function since we clobber the
519  * stack pointer before calling it, and don't want the compiler to play games
520  * with my hart. */
521 static void __attribute__((noinline, noreturn)) 
522 __pthread_exit(struct pthread_tcb *t)
523 {
524         __pthread_free_tls(t);
525         __pthread_free_stack(t);
526         /* TODO: race on detach state */
527         if (t->detached)
528                 free(t);
529         /* Once we do this, our joiner can free us.  He won't free us if we're
530          * detached, but there is still a potential race there (since he's accessing
531          * someone who is freed. */
532         t->finished = 1;
533         current_thread = NULL;
534         /* Go back to the entry point, where we can handle notifications or
535          * reschedule someone. */
536         vcore_entry();
537 }
538
539 /* This function cannot be migrated to a different vcore by the userspace
540  * scheduler.  Will need to sort that shit out.  */
541 void pthread_exit(void* ret)
542 {
543         struct pthread_tcb *t = pthread_self();
544         /* Don't migrate this thread to anothe vcore, since it depends on being on
545          * the same vcore throughout. */
546         t->dont_migrate = TRUE; // won't set this to false later, since he is dying
547
548         uint32_t vcoreid = vcore_id();
549         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
550
551         t->retval = ret;
552         mcs_lock_lock(&queue_lock);
553         threads_active--;
554         TAILQ_REMOVE(&active_queue, t, next);
555         mcs_lock_unlock(&queue_lock);
556
557         printd("[P] Pthread id %d is exiting on vcore %d\n", t->id, vcoreid);
558         
559         /* once we do this, we might miss a notif_pending, so we need to enter vcore
560          * entry later. */
561         disable_notifs(vcoreid);
562
563         /* Change to the transition context (both TLS and stack). */
564         extern void** vcore_thread_control_blocks;
565         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
566         assert(current_thread == t);    
567         /* After this, make sure you don't use local variables.  Also, make sure the
568          * compiler doesn't use them without telling you (TODO).
569          *
570          * In each arch's set_stack_pointer, make sure you subtract off as much room
571          * as you need to any local vars that might be pushed before calling the
572          * next function, or for whatever other reason the compiler/hardware might
573          * walk up the stack a bit when calling a noreturn function. */
574         set_stack_pointer((void*)vcpd->transition_stack);
575         /* Finish exiting in another function.  Ugh. */
576         __pthread_exit(current_thread);
577 }
578
579 int pthread_once(pthread_once_t* once_control, void (*init_routine)(void))
580 {
581   if(atomic_swap(once_control,1) == 0)
582     init_routine();
583   return 0;
584 }
585
586 int pthread_barrier_init(pthread_barrier_t* b, const pthread_barrierattr_t* a, int count)
587 {
588   b->nprocs = b->count = count;
589   b->sense = 0;
590   pthread_mutex_init(&b->pmutex, 0);
591   return 0;
592 }
593
594 int pthread_barrier_wait(pthread_barrier_t* b)
595 {
596   unsigned int spinner = 0;
597   int ls = !b->sense;
598
599   pthread_mutex_lock(&b->pmutex);
600   int count = --b->count;
601   pthread_mutex_unlock(&b->pmutex);
602
603   if(count == 0)
604   {
605     printd("Thread %d is last to hit the barrier, resetting...\n", pthread_self()->id);
606     b->count = b->nprocs;
607         wmb();
608     b->sense = ls;
609     return PTHREAD_BARRIER_SERIAL_THREAD;
610   }
611   else
612   {
613     while(b->sense != ls) {
614       cpu_relax();
615       spin_to_sleep(PTHREAD_BARRIER_SPINS, &spinner);
616     }
617     return 0;
618   }
619 }
620
621 int pthread_barrier_destroy(pthread_barrier_t* b)
622 {
623   pthread_mutex_destroy(&b->pmutex);
624   return 0;
625 }
626
627 int pthread_detach(pthread_t thread)
628 {
629         thread->detached = TRUE;
630         return 0;
631 }