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