Remote mbox can deal with recursive calls (XCC)
[akaros.git] / user / parlib / uthread.c
1 #include <ros/arch/membar.h>
2 #include <arch/atomic.h>
3 #include <parlib.h>
4 #include <vcore.h>
5 #include <uthread.h>
6 #include <event.h>
7
8 /* Which operations we'll call for the 2LS.  Will change a bit with Lithe.  For
9  * now, there are no defaults.  2LSs can override sched_ops. */
10 struct schedule_ops default_2ls_ops = {0};
11 struct schedule_ops *sched_ops __attribute__((weak)) = &default_2ls_ops;
12
13 __thread struct uthread *current_uthread = 0;
14 /* ev_q for all preempt messages (handled here to keep 2LSs from worrying
15  * extensively about the details.  Will call out when necessary. */
16 struct event_queue *preempt_ev_q;
17
18 /* static helpers: */
19 static int __uthread_allocate_tls(struct uthread *uthread);
20 static int __uthread_reinit_tls(struct uthread *uthread);
21 static void __uthread_free_tls(struct uthread *uthread);
22 static void __run_current_uthread_raw(void);
23 static void handle_vc_preempt(struct event_msg *ev_msg, unsigned int ev_type);
24
25 /* The real 2LS calls this, passing in a uthread representing thread0.  When it
26  * returns, you're in _M mode, still running thread0, on vcore0 */
27 int uthread_lib_init(struct uthread *uthread)
28 {
29         /* Make sure this only runs once */
30         static bool initialized = FALSE;
31         if (initialized)
32                 return -1;
33         initialized = TRUE;
34         /* Init the vcore system */
35         assert(!vcore_init());
36         assert(uthread);
37         /* Save a pointer to thread0's tls region (the glibc one) into its tcb */
38         uthread->tls_desc = get_tls_desc(0);
39         /* Save a pointer to the uthread in its own TLS */
40         current_uthread = uthread;
41         /* Thread is currently running (it is 'us') */
42         uthread->state = UT_RUNNING;
43         /* Change temporarily to vcore0s tls region so we can save the newly created
44          * tcb into its current_uthread variable and then restore it.  One minor
45          * issue is that vcore0's transition-TLS isn't TLS_INITed yet.  Until it is
46          * (right before vcore_entry(), don't try and take the address of any of
47          * its TLS vars. */
48         extern void** vcore_thread_control_blocks;
49         set_tls_desc(vcore_thread_control_blocks[0], 0);
50         current_uthread = uthread;
51         set_tls_desc(uthread->tls_desc, 0);
52         assert(!in_vcore_context());
53         /* Receive preemption events */
54         ev_handlers[EV_VCORE_PREEMPT] = handle_vc_preempt;
55         preempt_ev_q = get_big_event_q();
56         preempt_ev_q->ev_flags = EVENT_IPI | EVENT_INDIR | EVENT_FALLBACK |
57                                  EVENT_NOTHROTTLE | EVENT_VCORE_MUST_RUN;
58         register_kevent_q(preempt_ev_q, EV_VCORE_PREEMPT);
59         /* For now, send CHECK_MSGS to the preempt ev_q */
60         register_kevent_q(preempt_ev_q, EV_CHECK_MSGS);
61         printd("[user] registered %08p (flags %08p) for preempt messages\n",
62                preempt_ev_q, preempt_ev_q->ev_flags);
63         /* Get ourselves into _M mode.  Could consider doing this elsewhere... */
64         while (!in_multi_mode()) {
65                 vcore_request(1);
66                 /* TODO: consider blocking */
67                 cpu_relax();
68         }
69         return 0;
70 }
71
72 /* 2LSs shouldn't call uthread_vcore_entry directly */
73 void __attribute__((noreturn)) uthread_vcore_entry(void)
74 {
75         uint32_t vcoreid = vcore_id();
76         struct preempt_data *vcpd = vcpd_of(vcoreid);
77         /* Should always have notifications disabled when coming in here. */
78         assert(!notif_is_enabled(vcoreid));
79         assert(in_vcore_context());
80         /* If someone is stealing our uthread (from when we were preempted before),
81          * we can't touch our uthread.  But we might be the last vcore around, so
82          * we'll handle preemption events. */
83         while (atomic_read(&vcpd->flags) & VC_UTHREAD_STEALING) {
84                 handle_event_q(preempt_ev_q);
85                 cpu_relax();
86         }
87         /* If we have a current uthread that is DONT_MIGRATE, pop it real quick and
88          * let it disable notifs (like it wants to).  Other than dealing with
89          * preemption events, we shouldn't do anything in vc_ctx when we have a
90          * DONT_MIGRATE uthread. */
91         if (current_uthread && (current_uthread->flags & UTHREAD_DONT_MIGRATE))
92                 __run_current_uthread_raw();
93         /* Check and see if we wanted ourselves to handle a remote VCPD mbox.  Want
94          * to do this after we've handled STEALING and DONT_MIGRATE. */
95         try_handle_remote_mbox();
96         /* Otherwise, go about our usual vcore business (messages, etc). */
97         check_preempt_pending(vcoreid);
98         handle_events(vcoreid);
99         assert(in_vcore_context());     /* double check, in case an event changed it */
100         assert(sched_ops->sched_entry);
101         sched_ops->sched_entry();
102         /* 2LS sched_entry should never return */
103         assert(0);
104 }
105
106 /* Does the uthread initialization of a uthread that the caller created.  Call
107  * this whenever you are "starting over" with a thread. */
108 void uthread_init(struct uthread *new_thread)
109 {
110         /* don't remove this assert without dealing with 'caller' below.  if we want
111          * to call this while in vcore context, we'll need to handle the TLS
112          * swapping a little differently */
113         assert(!in_vcore_context());
114         uint32_t vcoreid;
115         assert(new_thread);
116         new_thread->state = UT_CREATED;
117         /* They should have zero'd the uthread.  Let's check critical things: */
118         assert(!new_thread->flags && !new_thread->sysc);
119         /* Get a TLS.  If we already have one, reallocate/refresh it */
120         if (new_thread->tls_desc)
121                 assert(!__uthread_reinit_tls(new_thread));
122         else
123                 assert(!__uthread_allocate_tls(new_thread));
124         /* Switch into the new guys TLS and let it know who it is */
125         struct uthread *caller = current_uthread;
126         assert(caller);
127         /* We need to disable notifs here (in addition to not migrating), since we
128          * could get interrupted when we're in the other guy's TLS, and when the
129          * vcore restarts us, it will put us in our old TLS, not the one we were in
130          * when we were interrupted.  We need to not migrate, since once we know the
131          * vcoreid, we depend on being on the same vcore throughout. */
132         caller->flags |= UTHREAD_DONT_MIGRATE;
133         /* not concerned about cross-core memory ordering, so no CPU mbs needed */
134         cmb();  /* don't let the compiler issue the vcore read before the write */
135         /* Note the first time we call this, we technically aren't on a vcore */
136         vcoreid = vcore_id();
137         disable_notifs(vcoreid);
138         /* Save the new_thread to the new uthread in that uthread's TLS */
139         set_tls_desc(new_thread->tls_desc, vcoreid);
140         current_uthread = new_thread;
141         /* Switch back to the caller */
142         set_tls_desc(caller->tls_desc, vcoreid);
143         /* Okay to migrate now, and enable interrupts/notifs.  This could be called
144          * from vcore context, so only enable if we're in _M and in vcore context. */
145         caller->flags &= ~UTHREAD_DONT_MIGRATE;         /* turn this on first */
146         if (!in_vcore_context() && in_multi_mode())
147                 enable_notifs(vcoreid);
148         cmb();  /* issue this write after we're done with vcoreid */
149 }
150
151 void uthread_runnable(struct uthread *uthread)
152 {
153         /* Allow the 2LS to make the thread runnable, and do whatever. */
154         assert(sched_ops->thread_runnable);
155         uthread->state = UT_RUNNABLE;
156         sched_ops->thread_runnable(uthread);
157 }
158
159 /* Need to have this as a separate, non-inlined function since we clobber the
160  * stack pointer before calling it, and don't want the compiler to play games
161  * with my hart. */
162 static void __attribute__((noinline, noreturn)) 
163 __uthread_yield(void)
164 {
165         struct uthread *uthread = current_uthread;
166         assert(in_vcore_context());
167         assert(!notif_is_enabled(vcore_id()));
168         /* Note: we no longer care if the thread is exiting, the 2LS will call
169          * uthread_destroy() */
170         uthread->flags &= ~UTHREAD_DONT_MIGRATE;
171         /* Determine if we're blocking on a syscall or just yielding.  Might end
172          * up doing this differently when/if we have more ways to yield. */
173         if (uthread->sysc) {
174                 uthread->state = UT_BLOCKED;
175                 assert(sched_ops->thread_blockon_sysc);
176                 sched_ops->thread_blockon_sysc(uthread->sysc);
177         } else { /* generic yield */
178                 uthread->state = UT_RUNNABLE;
179                 assert(sched_ops->thread_yield);
180                 /* 2LS will save the thread somewhere for restarting.  Later on,
181                  * we'll probably have a generic function for all sorts of waiting.
182                  */
183                 sched_ops->thread_yield(uthread);
184         }
185         /* Leave the current vcore completely */
186         current_uthread = NULL;
187         /* Go back to the entry point, where we can handle notifications or
188          * reschedule someone. */
189         uthread_vcore_entry();
190 }
191
192 /* Calling thread yields.  Both exiting and yielding calls this, the difference
193  * is the thread's state (in the flags). */
194 void uthread_yield(bool save_state)
195 {
196         struct uthread *uthread = current_uthread;
197         volatile bool yielding = TRUE; /* signal to short circuit when restarting */
198         /* TODO: (HSS) Save silly state */
199         // if (save_state)
200         //      save_fp_state(&t->as);
201         assert(!in_vcore_context());
202         assert(uthread->state == UT_RUNNING);
203         /* Don't migrate this thread to another vcore, since it depends on being on
204          * the same vcore throughout (once it disables notifs).  The race is that we
205          * read vcoreid, then get interrupted / migrated before disabling notifs. */
206         uthread->flags |= UTHREAD_DONT_MIGRATE;
207         cmb();  /* don't let DONT_MIGRATE write pass the vcoreid read */
208         uint32_t vcoreid = vcore_id();
209         printd("[U] Uthread %08p is yielding on vcore %d\n", uthread, vcoreid);
210         struct preempt_data *vcpd = vcpd_of(vcoreid);
211         /* once we do this, we might miss a notif_pending, so we need to enter vcore
212          * entry later.  Need to disable notifs so we don't get in weird loops with
213          * save_ros_tf() and pop_ros_tf(). */
214         disable_notifs(vcoreid);
215         /* take the current state and save it into t->utf when this pthread
216          * restarts, it will continue from right after this, see yielding is false,
217          * and short ciruit the function.  Don't do this if we're dying. */
218         if (save_state)
219                 save_ros_tf(&uthread->utf);
220         cmb();  /* Force a reread of yielding. Technically save_ros_tf() is enough*/
221         /* Restart path doesn't matter if we're dying */
222         if (!yielding)
223                 goto yield_return_path;
224         yielding = FALSE; /* for when it starts back up */
225         /* Signal the current state is in utf.  Need to do this only the first time
226          * through (not on the yield return path that comes after save_ros_tf) */
227         uthread->flags |= UTHREAD_SAVED;
228         /* Change to the transition context (both TLS and stack). */
229         extern void** vcore_thread_control_blocks;
230         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
231         assert(current_uthread == uthread);     
232         assert(in_vcore_context());     /* technically, we aren't fully in vcore context */
233         /* After this, make sure you don't use local variables.  Also, make sure the
234          * compiler doesn't use them without telling you (TODO).
235          *
236          * In each arch's set_stack_pointer, make sure you subtract off as much room
237          * as you need to any local vars that might be pushed before calling the
238          * next function, or for whatever other reason the compiler/hardware might
239          * walk up the stack a bit when calling a noreturn function. */
240         set_stack_pointer((void*)vcpd->transition_stack);
241         /* Finish exiting in another function. */
242         __uthread_yield();
243         /* Should never get here */
244         assert(0);
245         /* Will jump here when the uthread's trapframe is restarted/popped. */
246 yield_return_path:
247         printd("[U] Uthread %08p returning from a yield!\n", uthread);
248 }
249
250 /* Cleans up the uthread (the stuff we did in uthread_init()).  If you want to
251  * destroy a currently running uthread, you'll want something like
252  * pthread_exit(), which yields, and calls this from its sched_ops yield. */
253 void uthread_cleanup(struct uthread *uthread)
254 {
255         printd("[U] thread %08p on vcore %d is DYING!\n", uthread, vcore_id());
256         uthread->state = UT_DYING;
257         /* we alloc and manage the TLS, so lets get rid of it */
258         __uthread_free_tls(uthread);
259 }
260
261 /* Attempts to block on sysc, returning when it is done or progress has been
262  * made. */
263 void ros_syscall_blockon(struct syscall *sysc)
264 {
265         if (in_vcore_context()) {
266                 /* vcore's don't know what to do yet, so do the default (spin) */
267                 __ros_syscall_blockon(sysc);
268                 return;
269         }
270         if (!sched_ops->thread_blockon_sysc || !in_multi_mode()) {
271                 /* There isn't a 2LS op for blocking, or we're _S.  Spin for now. */
272                 __ros_syscall_blockon(sysc);
273                 return;
274         }
275         /* At this point, we know we're a uthread.  If we're a DONT_MIGRATE uthread,
276          * then it's disabled notifs and is basically in vcore context, enough so
277          * that it can't call into the 2LS. */
278         assert(current_uthread);
279         if (current_uthread->flags & UTHREAD_DONT_MIGRATE) {
280                 assert(!notif_is_enabled(vcore_id()));  /* catch bugs */
281                 __ros_syscall_blockon(sysc);
282         }
283         /* double check before doing all this crap */
284         if (atomic_read(&sysc->flags) & (SC_DONE | SC_PROGRESS))
285                 return;
286         /* So yield knows we are blocking on something */
287         current_uthread->sysc = sysc;
288         uthread_yield(TRUE);
289 }
290
291 /* Helper for run_current and run_uthread.  Make sure the uthread you want to
292  * run is the current_uthread before calling this.  It will pop the TF of
293  * whatever you send in (run_cur and run_uth use different TFs).
294  *
295  * This will adjust the thread's state, do one last check on notif_pending, and
296  * pop the tf.  Note that the notif check is an optimization.  pop_ros_tf() will
297  * definitely handle it, but it will take a syscall to do so later. */
298 static void __run_cur_uthread(struct user_trapframe *utf)
299 {
300         uint32_t vcoreid = vcore_id();
301         struct preempt_data *vcpd = vcpd_of(vcoreid);
302         clear_notif_pending(vcoreid);
303         /* clear_notif might have handled a preemption event, and we might not have
304          * a current_uthread anymore.  Need to recheck */
305         cmb();
306         if (!current_uthread) {
307                 /* Start over, as if we just had a notif from the kernel.
308                  * Note that  we're resetting the stack here.  Don't do anything other
309                  * than call vcore_entry() */
310                 set_stack_pointer((void*)vcpd->transition_stack);
311                 uthread_vcore_entry();
312                 assert(0);
313         }
314         /* Go ahead and start the uthread */
315         /* utf no longer represents the current state of the uthread */
316         current_uthread->flags &= ~UTHREAD_SAVED;
317         set_tls_desc(current_uthread->tls_desc, vcoreid);
318         /* Pop the user trap frame */
319         pop_ros_tf(utf, vcoreid);
320 }
321
322 /* Runs whatever thread is vcore's current_uthread */
323 void run_current_uthread(void)
324 {
325         uint32_t vcoreid = vcore_id();
326         struct preempt_data *vcpd = vcpd_of(vcoreid);
327         assert(current_uthread);
328         assert(current_uthread->state == UT_RUNNING);
329         printd("[U] Vcore %d is restarting uthread %08p\n", vcoreid,
330                current_uthread);
331         /* Run, using the TF in the VCPD.  FP state should already be loaded */
332         __run_cur_uthread(&vcpd->notif_tf);
333         assert(0);
334 }
335
336 /* Launches the uthread on the vcore.  Don't call this on current_uthread. */
337 void run_uthread(struct uthread *uthread)
338 {
339         uint32_t vcoreid = vcore_id();
340         assert(uthread != current_uthread);
341         if (uthread->state != UT_RUNNABLE) {
342                 /* had vcore3 throw this, when the UT blocked on vcore1 and didn't come
343                  * back up yet (kernel didn't wake up, didn't send IPI) */
344                 printf("Uthread %08p not runnable (was %d) in run_uthread on vcore %d!\n",
345                        uthread, uthread->state, vcore_id());
346         }
347         assert(uthread->state == UT_RUNNABLE);
348         uthread->state = UT_RUNNING;
349         /* Save a ptr to the uthread we'll run in the transition context's TLS */
350         current_uthread = uthread;
351         /* Load silly state (Floating point) too.  For real */
352         /* TODO: (HSS) */
353         __run_cur_uthread(&uthread->utf);
354         assert(0);
355 }
356
357 /* Runs the uthread, but doesn't care about notif pending.  Only call this when
358  * there was a DONT_MIGRATE uthread, or a similar situation where the uthread
359  * will check messages soon (like calling enable_notifs()). */
360 static void __run_current_uthread_raw(void)
361 {
362         uint32_t vcoreid = vcore_id();
363         struct preempt_data *vcpd = vcpd_of(vcoreid);
364         /* We need to manually say we have a notif pending, so we eventually return
365          * to vcore context.  (note the kernel turned it off for us) */
366         vcpd->notif_pending = TRUE;
367         /* utf no longer represents the current state of the uthread */
368         current_uthread->flags &= ~UTHREAD_SAVED;
369         set_tls_desc(current_uthread->tls_desc, vcoreid);
370         /* Pop the user trap frame */
371         pop_ros_tf_raw(&vcpd->notif_tf, vcoreid);
372         assert(0);
373 }
374
375 /* Deals with a pending preemption (checks, responds).  If the 2LS registered a
376  * function, it will get run.  Returns true if you got preempted.  Called
377  * 'check' instead of 'handle', since this isn't an event handler.  It's the "Oh
378  * shit a preempt is on its way ASAP".  While it is isn't too involved with
379  * uthreads, it is tied in to sched_ops. */
380 bool check_preempt_pending(uint32_t vcoreid)
381 {
382         bool retval = FALSE;
383         if (__procinfo.vcoremap[vcoreid].preempt_pending) {
384                 retval = TRUE;
385                 if (sched_ops->preempt_pending)
386                         sched_ops->preempt_pending();
387                 /* this tries to yield, but will pop back up if this was a spurious
388                  * preempt_pending.  Note this will handle events internally, and then
389                  * recurse once per event in the queue.  This sucks, but keeps us from
390                  * missing messages for now. */
391                 vcore_yield(TRUE);
392         }
393         return retval;
394 }
395
396 /* Helper: This is a safe way for code to disable notifs if it *might* be called
397  * from uthread context (like from a notif_safe lock).  Pair this with
398  * uth_enable_notifs() unless you know what you're doing. */
399 void uth_disable_notifs(void)
400 {
401         if (!in_vcore_context() && in_multi_mode()) {
402                 if (current_uthread)
403                         current_uthread->flags |= UTHREAD_DONT_MIGRATE;
404                 cmb();  /* don't issue the flag write before the vcore_id() read */
405                 disable_notifs(vcore_id());
406         }
407 }
408
409 /* Helper: Pair this with uth_disable_notifs(). */
410 void uth_enable_notifs(void)
411 {
412         if (!in_vcore_context() && in_multi_mode()) {
413                 if (current_uthread)
414                         current_uthread->flags &= ~UTHREAD_DONT_MIGRATE;
415                 cmb();  /* don't enable before ~DONT_MIGRATE */
416                 enable_notifs(vcore_id());
417         }
418 }
419
420 static void handle_vc_preempt(struct event_msg *ev_msg, unsigned int ev_type)
421 {
422         printf("Vcore %d was preempted, we're fucked!!!\n", ev_msg->ev_arg2);
423 }
424
425 /* Attempts to register ev_q with sysc, so long as sysc is not done/progress.
426  * Returns true if it succeeded, and false otherwise.  False means that the
427  * syscall is done, and does not need an event set (and should be handled
428  * accordingly)*/
429 bool register_evq(struct syscall *sysc, struct event_queue *ev_q)
430 {
431         int old_flags;
432         sysc->ev_q = ev_q;
433         wrmb(); /* don't let that write pass any future reads (flags) */
434         /* Try and set the SC_UEVENT flag (so the kernel knows to look at ev_q) */
435         do {
436                 /* no cmb() needed, the atomic_read will reread flags */
437                 old_flags = atomic_read(&sysc->flags);
438                 /* Spin if the kernel is mucking with syscall flags */
439                 while (old_flags & SC_K_LOCK)
440                         old_flags = atomic_read(&sysc->flags);
441                 /* If the kernel finishes while we are trying to sign up for an event,
442                  * we need to bail out */
443                 if (old_flags & (SC_DONE | SC_PROGRESS)) {
444                         sysc->ev_q = 0;         /* not necessary, but might help with bugs */
445                         return FALSE;
446                 }
447         } while (!atomic_cas(&sysc->flags, old_flags, old_flags | SC_UEVENT));
448         return TRUE;
449 }
450
451 /* De-registers a syscall, so that the kernel will not send an event when it is
452  * done.  The call could already be SC_DONE, or could even finish while we try
453  * to unset SC_UEVENT.
454  *
455  * There is a chance the kernel sent an event if you didn't do this in time, but
456  * once this returns, the kernel won't send a message.
457  *
458  * If the kernel is trying to send a message right now, this will spin (on
459  * SC_K_LOCK).  We need to make sure we deregistered, and that if a message
460  * is coming, that it already was sent (and possibly overflowed), before
461  * returning. */
462 void deregister_evq(struct syscall *sysc)
463 {
464         int old_flags;
465         sysc->ev_q = 0;
466         wrmb(); /* don't let that write pass any future reads (flags) */
467         /* Try and unset the SC_UEVENT flag */
468         do {
469                 /* no cmb() needed, the atomic_read will reread flags */
470                 old_flags = atomic_read(&sysc->flags);
471                 /* Spin if the kernel is mucking with syscall flags */
472                 while (old_flags & SC_K_LOCK)
473                         old_flags = atomic_read(&sysc->flags);
474                 /* Note we don't care if the SC_DONE flag is getting set.  We just need
475                  * to avoid clobbering flags */
476         } while (!atomic_cas(&sysc->flags, old_flags, old_flags & ~SC_UEVENT));
477 }
478
479 /* TLS helpers */
480 static int __uthread_allocate_tls(struct uthread *uthread)
481 {
482         assert(!uthread->tls_desc);
483         uthread->tls_desc = allocate_tls();
484         if (!uthread->tls_desc) {
485                 errno = ENOMEM;
486                 return -1;
487         }
488         return 0;
489 }
490
491 static int __uthread_reinit_tls(struct uthread *uthread)
492 {
493         uthread->tls_desc = reinit_tls(uthread->tls_desc);
494         if (!uthread->tls_desc) {
495                 errno = ENOMEM;
496                 return -1;
497         }
498         return 0;
499 }
500
501 static void __uthread_free_tls(struct uthread *uthread)
502 {
503         free_tls(uthread->tls_desc);
504         uthread->tls_desc = NULL;
505 }