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