Fixes saving FP state when copying out uthreads
[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 #include <stdlib.h>
8
9 /* Which operations we'll call for the 2LS.  Will change a bit with Lithe.  For
10  * now, there are no defaults.  2LSs can override sched_ops. */
11 struct schedule_ops default_2ls_ops = {0};
12 struct schedule_ops *sched_ops __attribute__((weak)) = &default_2ls_ops;
13
14 __thread struct uthread *current_uthread = 0;
15 /* ev_q for all preempt messages (handled here to keep 2LSs from worrying
16  * extensively about the details.  Will call out when necessary. */
17 struct event_queue *preempt_ev_q;
18
19 /* static helpers: */
20 static int __uthread_allocate_tls(struct uthread *uthread);
21 static int __uthread_reinit_tls(struct uthread *uthread);
22 static void __uthread_free_tls(struct uthread *uthread);
23 static void __run_current_uthread_raw(void);
24 static void handle_vc_preempt(struct event_msg *ev_msg, unsigned int ev_type);
25 static void handle_vc_indir(struct event_msg *ev_msg, unsigned int ev_type);
26
27 /* Block the calling uthread on sysc until it makes progress or is done */
28 static void __ros_mcp_syscall_blockon(struct syscall *sysc);
29
30 /* Helper, make the uthread code manage thread0.  This sets up uthread such
31  * that the calling code and its TLS are tracked by the uthread struct, and
32  * vcore0 thinks the uthread is running there.  Called only by slim_init (early
33  * _S code) and lib_init. */
34 static void uthread_manage_thread0(struct uthread *uthread)
35 {
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         /* utf/as doesn't represent the state of the uthread (we are running) */
44         uthread->flags &= ~(UTHREAD_SAVED | UTHREAD_FPSAVED);
45         /* Change temporarily to vcore0s tls region so we can save the newly created
46          * tcb into its current_uthread variable and then restore it.  One minor
47          * issue is that vcore0's transition-TLS isn't TLS_INITed yet.  Until it is
48          * (right before vcore_entry(), don't try and take the address of any of
49          * its TLS vars. */
50         extern void** vcore_thread_control_blocks;
51         set_tls_desc(vcore_thread_control_blocks[0], 0);
52         /* We might have a basic uthread already installed (from slim_init), so
53          * free it before installing the new one. */
54         if (current_uthread)
55                 free(current_uthread);
56         current_uthread = uthread;
57         set_tls_desc(uthread->tls_desc, 0);
58         __vcoreid = 0;  /* setting the uthread's TLS var */
59         assert(!in_vcore_context());
60 }
61
62 /* The real 2LS calls this, passing in a uthread representing thread0.  When it
63  * returns, you're in _M mode, still running thread0, on vcore0 */
64 void uthread_lib_init(struct uthread *uthread)
65 {
66         init_once_racy(return);
67         vcore_init();
68         uthread_manage_thread0(uthread);
69         /* Receive preemption events.  Note that this merely tells the kernel how to
70          * send the messages, and does not necessarily provide storage space for the
71          * messages.  What we're doing is saying that all PREEMPT and CHECK_MSGS
72          * events should be spammed to vcores that are running, preferring whatever
73          * the kernel thinks is appropriate.  And IPI them. */
74         ev_handlers[EV_VCORE_PREEMPT] = handle_vc_preempt;
75         ev_handlers[EV_CHECK_MSGS] = handle_vc_indir;
76         preempt_ev_q = get_event_q();   /* small ev_q, mostly a vehicle for flags */
77         preempt_ev_q->ev_flags = EVENT_IPI | EVENT_SPAM_PUBLIC | EVENT_VCORE_APPRO |
78                                                          EVENT_VCORE_MUST_RUN;
79         /* Tell the kernel to use the ev_q (it's settings) for the two types.  Note
80          * that we still have two separate handlers.  We just want the events
81          * delivered in the same way.  If we ever want to have a big_event_q with
82          * INDIRs, we could consider using separate ones. */
83         register_kevent_q(preempt_ev_q, EV_VCORE_PREEMPT);
84         register_kevent_q(preempt_ev_q, EV_CHECK_MSGS);
85         printd("[user] registered %08p (flags %08p) for preempt messages\n",
86                preempt_ev_q, preempt_ev_q->ev_flags);
87         /* Get ourselves into _M mode.  Could consider doing this elsewhere... */
88         vcore_change_to_m();
89 }
90
91 /* Helper: tells the kernel our SCP is capable of going into vcore context on
92  * vcore 0.  Pairs with k/s/process.c scp_is_vcctx_ready(). */
93 static void scp_vcctx_ready(void)
94 {
95         struct preempt_data *vcpd = vcpd_of(0);
96         long old_flags;
97         /* the CAS is a bit overkill; keeping it around in case people use this
98          * code in other situations. */
99         do {
100                 old_flags = atomic_read(&vcpd->flags);
101                 /* Spin if the kernel is mucking with the flags */
102                 while (old_flags & VC_K_LOCK)
103                         old_flags = atomic_read(&vcpd->flags);
104         } while (!atomic_cas(&vcpd->flags, old_flags,
105                              old_flags & ~VC_SCP_NOVCCTX));
106 }
107
108 /* Slim-init - sets up basic uthreading for when we are in _S mode and before
109  * we set up the 2LS.  Some apps may not have a 2LS and thus never do the full
110  * vcore/2LS/uthread init. */
111 void uthread_slim_init(void)
112 {
113         struct uthread *uthread;
114         int ret = posix_memalign((void**)&uthread, __alignof__(struct uthread),
115                                  sizeof(struct uthread));
116         assert(!ret);
117         memset(uthread, 0, sizeof(struct uthread));     /* aggressively 0 for bugs */
118         /* TODO: consider a vcore_init_vc0 call. */
119         vcore_init();
120         uthread_manage_thread0(uthread);
121         scp_vcctx_ready();
122         init_posix_signals();
123         /* change our blockon from glibc's internal one to the mcp one (which can
124          * handle SCPs too).  we must do this before switching to _M, or at least
125          * before blocking while an _M.  it's harmless (and probably saner) to do it
126          * earlier, so we do it as early as possible. */
127         ros_syscall_blockon = __ros_mcp_syscall_blockon;
128 }
129
130 /* 2LSs shouldn't call uthread_vcore_entry directly */
131 void __attribute__((noreturn)) uthread_vcore_entry(void)
132 {
133         uint32_t vcoreid = vcore_id();
134         struct preempt_data *vcpd = vcpd_of(vcoreid);
135         /* Should always have notifications disabled when coming in here. */
136         assert(!notif_is_enabled(vcoreid));
137         assert(in_vcore_context());
138         /* If someone is stealing our uthread (from when we were preempted before),
139          * we can't touch our uthread.  But we might be the last vcore around, so
140          * we'll handle preemption events (spammed to our public mbox).
141          *
142          * It's important that we only check/handle one message per loop, otherwise
143          * we could get stuck in a ping-pong scenario with a recoverer (maybe). */
144         while (atomic_read(&vcpd->flags) & VC_UTHREAD_STEALING) {
145                 /* Note we're handling INDIRs and other public messages while someone
146                  * is stealing our uthread.  Remember that those event handlers cannot
147                  * touch cur_uth, as it is "vcore business". */
148                 handle_one_mbox_msg(&vcpd->ev_mbox_public);
149                 cpu_relax();
150         }
151         /* If we have a current uthread that is DONT_MIGRATE, pop it real quick and
152          * let it disable notifs (like it wants to).  Other than dealing with
153          * preemption events (or other INDIRs), we shouldn't do anything in vc_ctx
154          * when we have a DONT_MIGRATE uthread. */
155         if (current_uthread && (current_uthread->flags & UTHREAD_DONT_MIGRATE))
156                 __run_current_uthread_raw();
157         /* Check and see if we wanted ourselves to handle a remote VCPD mbox.  Want
158          * to do this after we've handled STEALING and DONT_MIGRATE. */
159         try_handle_remote_mbox();
160         /* Otherwise, go about our usual vcore business (messages, etc). */
161         handle_events(vcoreid);
162         __check_preempt_pending(vcoreid);
163         assert(in_vcore_context());     /* double check, in case an event changed it */
164         /* Consider using the default_2ls_op for this, though it's a bit weird. */
165         if (sched_ops->sched_entry) {
166                 sched_ops->sched_entry();
167         } else if (current_uthread) {
168                 run_current_uthread();
169         }
170         /* 2LS sched_entry should never return */
171         /* Either the 2LS sched_entry returned, run_cur_uth() returned, or we
172          * didn't have a current_uthread.  If we didn't have a 2LS op, we should be
173          * in _S mode and always have a current_uthread. */
174         assert(0);
175 }
176
177 /* Does the uthread initialization of a uthread that the caller created.  Call
178  * this whenever you are "starting over" with a thread. */
179 void uthread_init(struct uthread *new_thread)
180 {
181         int ret;
182         assert(new_thread);
183         new_thread->state = UT_NOT_RUNNING;
184         /* They should have zero'd the uthread.  Let's check critical things: */
185         assert(!new_thread->flags && !new_thread->sysc);
186         /* the utf holds the GP context of the uthread (set by the 2LS earlier).
187          * There is no FP context to be restored yet.  We only save the FPU when we
188          * were interrupted off a core. */
189         new_thread->flags |= UTHREAD_SAVED;
190         /* Get a TLS.  If we already have one, reallocate/refresh it */
191         if (new_thread->tls_desc)
192                 ret = __uthread_reinit_tls(new_thread);
193         else
194                 ret = __uthread_allocate_tls(new_thread);
195         assert(!ret);
196         uthread_set_tls_var(new_thread, current_uthread, new_thread);
197 }
198
199 /* This is a wrapper for the sched_ops thread_runnable, for use by functions
200  * outside the main 2LS.  Do not put anything important in this, since the 2LSs
201  * internally call their sched op.  This is to improve batch wakeups (barriers,
202  * etc) */
203 void uthread_runnable(struct uthread *uthread)
204 {
205         assert(sched_ops->thread_runnable);
206         sched_ops->thread_runnable(uthread);
207 }
208
209 /* Informs the 2LS that its thread blocked, and it is not under the control of
210  * the 2LS.  This is for informational purposes, and some semantic meaning
211  * should be passed by flags (from uthread.h's UTH_EXT_BLK_xxx options).
212  * Eventually, whoever calls this will call uthread_runnable(), giving the
213  * thread back to the 2LS.
214  *
215  * If code outside the 2LS has blocked a thread (via uthread_yield) and ran its
216  * own callback/yield_func instead of some 2LS code, that callback needs to
217  * call this.
218  *
219  * AKA: obviously_a_uthread_has_blocked_in_lincoln_park() */
220 void uthread_has_blocked(struct uthread *uthread, int flags)
221 {
222         if (sched_ops->thread_has_blocked)
223                 sched_ops->thread_has_blocked(uthread, flags);
224 }
225
226 /* Need to have this as a separate, non-inlined function since we clobber the
227  * stack pointer before calling it, and don't want the compiler to play games
228  * with my hart. */
229 static void __attribute__((noinline, noreturn))
230 __uthread_yield(void)
231 {
232         struct uthread *uthread = current_uthread;
233         assert(in_vcore_context());
234         assert(!notif_is_enabled(vcore_id()));
235         /* Note: we no longer care if the thread is exiting, the 2LS will call
236          * uthread_destroy() */
237         uthread->flags &= ~UTHREAD_DONT_MIGRATE;
238         uthread->state = UT_NOT_RUNNING;
239         /* Do whatever the yielder wanted us to do */
240         assert(uthread->yield_func);
241         uthread->yield_func(uthread, uthread->yield_arg);
242         /* Make sure you do not touch uthread after that func call */
243         /* Leave the current vcore completely */
244         /* TODO: if the yield func can return a failure, we can abort the yield */
245         current_uthread = NULL;
246         /* Go back to the entry point, where we can handle notifications or
247          * reschedule someone. */
248         uthread_vcore_entry();
249 }
250
251 /* Calling thread yields for some reason.  Set 'save_state' if you want to ever
252  * run the thread again.  Once in vcore context in __uthread_yield, yield_func
253  * will get called with the uthread and yield_arg passed to it.  This way, you
254  * can do whatever you want when you get into vcore context, which can be
255  * thread_blockon_sysc, unlocking mutexes, joining, whatever.
256  *
257  * If you do *not* pass a 2LS sched op or other 2LS function as yield_func,
258  * then you must also call uthread_has_blocked(flags), which will let the 2LS
259  * know a thread blocked beyond its control (and why). */
260 void uthread_yield(bool save_state, void (*yield_func)(struct uthread*, void*),
261                    void *yield_arg)
262 {
263         struct uthread *uthread = current_uthread;
264         volatile bool yielding = TRUE; /* signal to short circuit when restarting */
265         assert(!in_vcore_context());
266         assert(uthread->state == UT_RUNNING);
267         /* Pass info to ourselves across the uth_yield -> __uth_yield transition. */
268         uthread->yield_func = yield_func;
269         uthread->yield_arg = yield_arg;
270         /* Don't migrate this thread to another vcore, since it depends on being on
271          * the same vcore throughout (once it disables notifs).  The race is that we
272          * read vcoreid, then get interrupted / migrated before disabling notifs. */
273         uthread->flags |= UTHREAD_DONT_MIGRATE;
274         cmb();  /* don't let DONT_MIGRATE write pass the vcoreid read */
275         uint32_t vcoreid = vcore_id();
276         printd("[U] Uthread %08p is yielding on vcore %d\n", uthread, vcoreid);
277         struct preempt_data *vcpd = vcpd_of(vcoreid);
278         /* once we do this, we might miss a notif_pending, so we need to enter vcore
279          * entry later.  Need to disable notifs so we don't get in weird loops with
280          * save_user_ctx() and pop_user_ctx(). */
281         disable_notifs(vcoreid);
282         /* take the current state and save it into t->utf when this pthread
283          * restarts, it will continue from right after this, see yielding is false,
284          * and short ciruit the function.  Don't do this if we're dying. */
285         if (save_state) {
286                 /* Need to signal this before we actually save, since save_user_ctx
287                  * returns() twice (once now, once when woken up) */
288                 uthread->flags |= UTHREAD_SAVED;
289                 save_user_ctx(&uthread->u_ctx);
290         }
291         cmb();  /* Force reread of yielding. Technically save_user_ctx() suffices*/
292         /* Restart path doesn't matter if we're dying */
293         if (!yielding)
294                 goto yield_return_path;
295         /* From here on down is only executed on the save path (not the wake up) */
296         yielding = FALSE; /* for when it starts back up */
297         /* TODO: remove this when all arches support SW contexts */
298         if (save_state && (uthread->u_ctx.type != ROS_SW_CTX)) {
299                 save_fp_state(&uthread->as);
300                 uthread->flags |= UTHREAD_FPSAVED;
301         }
302         /* Change to the transition context (both TLS and stack). */
303         extern void** vcore_thread_control_blocks;
304         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
305         assert(current_uthread == uthread);
306         assert(in_vcore_context());     /* technically, we aren't fully in vcore ctx */
307         /* After this, make sure you don't use local variables.  Also, make sure the
308          * compiler doesn't use them without telling you (TODO).
309          *
310          * In each arch's set_stack_pointer, make sure you subtract off as much room
311          * as you need to any local vars that might be pushed before calling the
312          * next function, or for whatever other reason the compiler/hardware might
313          * walk up the stack a bit when calling a noreturn function. */
314         set_stack_pointer((void*)vcpd->transition_stack);
315         /* Finish exiting in another function. */
316         __uthread_yield();
317         /* Should never get here */
318         assert(0);
319         /* Will jump here when the uthread's trapframe is restarted/popped. */
320 yield_return_path:
321         printd("[U] Uthread %08p returning from a yield!\n", uthread);
322 }
323
324 /* Cleans up the uthread (the stuff we did in uthread_init()).  If you want to
325  * destroy a currently running uthread, you'll want something like
326  * pthread_exit(), which yields, and calls this from its sched_ops yield. */
327 void uthread_cleanup(struct uthread *uthread)
328 {
329         printd("[U] thread %08p on vcore %d is DYING!\n", uthread, vcore_id());
330         /* we alloc and manage the TLS, so lets get rid of it */
331         __uthread_free_tls(uthread);
332 }
333
334 static void __ros_syscall_spinon(struct syscall *sysc)
335 {
336         while (!(atomic_read(&sysc->flags) & (SC_DONE | SC_PROGRESS)))
337                 cpu_relax();
338 }
339
340 /* Attempts to block on sysc, returning when it is done or progress has been
341  * made. */
342 void __ros_mcp_syscall_blockon(struct syscall *sysc)
343 {
344         /* even if we are in 'vcore context', an _S can block */
345         if (!in_multi_mode()) {
346                 __ros_scp_syscall_blockon(sysc);
347                 return;
348         }
349         /* MCP vcore's don't know what to do yet, so we have to spin */
350         if (in_vcore_context()) {
351                 __ros_syscall_spinon(sysc);
352                 return;
353         }
354         /* At this point, we know we're a uthread in an MCP.  If we're a
355          * DONT_MIGRATE uthread, then it's disabled notifs and is basically in
356          * vcore context, enough so that it can't call into the 2LS. */
357         assert(current_uthread);
358         if (current_uthread->flags & UTHREAD_DONT_MIGRATE) {
359                 assert(!notif_is_enabled(vcore_id()));  /* catch bugs */
360                 __ros_syscall_spinon(sysc);
361         }
362         /* double check before doing all this crap */
363         if (atomic_read(&sysc->flags) & (SC_DONE | SC_PROGRESS))
364                 return;
365         /* Debugging: so we can match sysc when it tries to wake us up later */
366         current_uthread->sysc = sysc;
367         /* yield, calling 2ls-blockon(cur_uth, sysc) on the other side */
368         uthread_yield(TRUE, sched_ops->thread_blockon_sysc, sysc);
369 }
370
371 /* Helper for run_current and run_uthread.  Make sure the uthread you want to
372  * run is the current_uthread before calling this.  Both of those are just
373  * wrappers for this, and they manage current_uthread and its states.   This
374  * manages the TF, FP state, and related flags.
375  *
376  * This will adjust the thread's state, do one last check on notif_pending, and
377  * pop the ctx.  Note that the notif check is an optimization.  pop_user_ctx()
378  * will definitely handle it, but it will take a syscall to do so later. */
379 static void __run_cur_uthread(void)
380 {
381         uint32_t vcoreid = vcore_id();
382         struct preempt_data *vcpd = vcpd_of(vcoreid);
383         struct uthread *uthread;
384         /* Last check for messages.  Might not return, or cur_uth might be unset. */
385         handle_events(vcoreid);
386         /* clear_notif might have handled a preemption event, and we might not have
387          * a current_uthread anymore.  Need to recheck */
388         cmb();
389         if (!current_uthread) {
390                 /* Start over, as if we just had a notif from the kernel.
391                  * Note that  we're resetting the stack here.  Don't do anything other
392                  * than call vcore_entry() */
393                 set_stack_pointer((void*)vcpd->transition_stack);
394                 uthread_vcore_entry();
395                 assert(0);
396         }
397         uthread = current_uthread;      /* for TLS sanity */
398         if (uthread->flags & UTHREAD_FPSAVED) {
399                 uthread->flags &= ~UTHREAD_FPSAVED;
400                 /* should never have a SW context that needs its FP state loaded */
401                 if (uthread->flags & UTHREAD_SAVED) {
402                         assert(uthread->u_ctx.type != ROS_SW_CTX);
403                 } else  {
404                         assert(vcpd->uthread_ctx.type != ROS_SW_CTX);
405                 }
406                 restore_fp_state(&uthread->as);
407         }
408         /* Go ahead and start the uthread */
409         set_tls_desc(uthread->tls_desc, vcoreid);
410         __vcoreid = vcoreid;    /* setting the uthread's TLS var */
411         /* Depending on where it was saved, we pop differently.  This assumes that
412          * if a uthread was not saved, that it was running in the vcpd uthread_ctx.
413          * There should never be a time that the ctx is unsaved and not in the VCPD
414          * uthread ctx slot (or about to be in that ctx slot). */
415         if (uthread->flags & UTHREAD_SAVED) {
416                 uthread->flags &= ~UTHREAD_SAVED;
417                 pop_user_ctx(&uthread->u_ctx, vcoreid);
418         } else  {
419                 pop_user_ctx(&vcpd->uthread_ctx, vcoreid);
420         }
421 }
422
423 /* Simply sets current uthread to be whatever the value of uthread is.  This
424  * can be called from outside of sched_entry() to highjack the current context,
425  * and make sure that the new uthread struct is used to store this context upon
426  * yielding, etc. USE WITH EXTREME CAUTION! */
427 void highjack_current_uthread(struct uthread *uthread)
428 {
429         uint32_t vcoreid = vcore_id();
430         assert(uthread != current_uthread);
431         assert(uthread->tls_desc);
432         current_uthread->state = UT_NOT_RUNNING;
433         uthread->state = UT_RUNNING;
434         vcore_set_tls_var(current_uthread, uthread);
435         set_tls_desc(uthread->tls_desc, vcoreid);
436         __vcoreid = vcoreid;    /* setting the uthread's TLS var */
437 }
438
439 /* Runs whatever thread is vcore's current_uthread.  This is nothing but a
440  * couple checks, then the real run_cur_uth. */
441 void run_current_uthread(void)
442 {
443         uint32_t vcoreid = vcore_id();
444         struct preempt_data *vcpd = vcpd_of(vcoreid);
445         assert(current_uthread);
446         assert(current_uthread->state == UT_RUNNING);
447         printd("[U] Vcore %d is restarting uthread %08p\n", vcoreid,
448                current_uthread);
449         /* Run, using the TF in the VCPD.  FP state should already be loaded */
450         __run_cur_uthread();
451         assert(0);
452 }
453
454 /* Launches the uthread on the vcore.  Don't call this on current_uthread.  All
455  * this does is set up uthread as cur_uth, check for bugs, and then runs the
456  * real run_cur_uth. */
457 void run_uthread(struct uthread *uthread)
458 {
459         assert(uthread != current_uthread);
460         if (uthread->state != UT_NOT_RUNNING) {
461                 /* had vcore3 throw this, when the UT blocked on vcore1 and didn't come
462                  * back up yet (kernel didn't wake up, didn't send IPI) */
463                 printf("Uth %08p not runnable (was %d) in run_uthread on vcore %d!\n",
464                        uthread, uthread->state, vcore_id());
465         }
466         assert(uthread->state == UT_NOT_RUNNING);
467         uthread->state = UT_RUNNING;
468         /* Save a ptr to the uthread we'll run in the transition context's TLS */
469         current_uthread = uthread;
470         __run_cur_uthread();
471         assert(0);
472 }
473
474 /* Runs the uthread, but doesn't care about notif pending.  Only call this when
475  * there was a DONT_MIGRATE uthread, or a similar situation where the uthread
476  * will check messages soon (like calling enable_notifs()). */
477 static void __run_current_uthread_raw(void)
478 {
479         uint32_t vcoreid = vcore_id();
480         struct preempt_data *vcpd = vcpd_of(vcoreid);
481         /* We need to manually say we have a notif pending, so we eventually return
482          * to vcore context.  (note the kernel turned it off for us) */
483         vcpd->notif_pending = TRUE;
484         /* utf no longer represents the current state of the uthread */
485         current_uthread->flags &= ~UTHREAD_SAVED;
486         assert(!(current_uthread->flags & UTHREAD_FPSAVED));
487         set_tls_desc(current_uthread->tls_desc, vcoreid);
488         __vcoreid = vcoreid;    /* setting the uthread's TLS var */
489         pop_user_ctx_raw(&vcpd->uthread_ctx, vcoreid);
490         assert(0);
491 }
492
493 /* Copies the uthread trapframe and silly state from the vcpd to the uthread,
494  * subject to the uthread's flags and whatnot.
495  *
496  * For example: The uthread state might still be in the uthread struct.  Imagine
497  * the 2LS decides to run a new uthread and sets it up as current, but doesn't
498  * actually run it yet.  The 2LS happened to voluntarily give up the VC (due to
499  * some other event) and then wanted to copy out the thread.  This is pretty
500  * rare - the normal case is when an IRQ of some sort hit the core and the
501  * kernel copied the running state into VCPD.
502  *
503  * The FP state could also be in VCPD (e.g. preemption being handled remotely),
504  * it could be in the uthread struct (e.g. hasn't started running yet) or even
505  * in the FPU (e.g. took an IRQ/notif and we're handling the preemption of
506  * another vcore).
507  *
508  * There are some cases where we'll have a uthread SW ctx that needs to be
509  * copied out: uth syscalls, notif happens, and the core comes back from the
510  * kernel in VC ctx.  VC ctx calls copy_out (response to preempt_pending or done
511  * while handling a preemption). */
512 static void copyout_uthread(struct preempt_data *vcpd, struct uthread *uthread,
513                             bool vcore_local)
514 {
515         assert(uthread);
516         if (uthread->flags & UTHREAD_SAVED) {
517                 /* I don't know of scenarios where HW ctxs FP state differs from GP */
518                 if (uthread->u_ctx.type == ROS_HW_CTX)
519                         assert(uthread->flags & UTHREAD_FPSAVED);
520                 assert(vcore_local);
521                 return;
522         }
523         /* If we're copying GP state, it must be in VCPD */
524         uthread->u_ctx = vcpd->uthread_ctx;
525         uthread->flags |= UTHREAD_SAVED;
526         printd("VC %d copying out uthread %08p\n", vcore_id(), uthread);
527         /* Software contexts do not need FP state, nor should we think it has any */
528         if (uthread->u_ctx.type == ROS_SW_CTX) {
529                 assert(!(uthread->flags & UTHREAD_FPSAVED));
530                 return;
531         }
532         /* HW contexts also should not have it saved either.  Should be either in
533          * the VCPD or the FPU.  Yes, this is the same assert. */
534         assert(!(uthread->flags & UTHREAD_FPSAVED));
535         /* When we're dealing with the uthread running on our own vcore, the FP
536          * state is in the actual FPU, not VCPD.  It might also be in VCPD, but it
537          * will always be in the FPU (the kernel maintains this for us, in the event
538          * we were preempted since the uthread was last running). */
539         if (vcore_local)
540                 save_fp_state(&uthread->as);
541         else
542                 uthread->as = vcpd->preempt_anc;
543         uthread->flags |= UTHREAD_FPSAVED;
544 }
545
546 /* Helper, packages up and pauses a uthread that was running on vcoreid.  Used
547  * by preemption handling (and detection) so far.  Careful using this, esp if
548  * it is on another vcore (need to make sure it's not running!).  If you are
549  * using it on the local vcore, set vcore_local = TRUE. */
550 static void __uthread_pause(struct preempt_data *vcpd, struct uthread *uthread,
551                             bool vcore_local)
552 {
553         assert(!(uthread->flags & UTHREAD_DONT_MIGRATE));
554         copyout_uthread(vcpd, uthread, vcore_local);
555         uthread->state = UT_NOT_RUNNING;
556         /* Call out to the 2LS to package up its uthread */
557         assert(sched_ops->thread_paused);
558         sched_ops->thread_paused(uthread);
559 }
560
561 /* Deals with a pending preemption (checks, responds).  If the 2LS registered a
562  * function, it will get run.  Returns true if you got preempted.  Called
563  * 'check' instead of 'handle', since this isn't an event handler.  It's the "Oh
564  * shit a preempt is on its way ASAP".
565  *
566  * Be careful calling this: you might not return, so don't call it if you can't
567  * handle that.  If you are calling this from an event handler, you'll need to
568  * do things like ev_might_not_return().  If the event can via an INDIR ev_q,
569  * that ev_q must be a NOTHROTTLE.
570  *
571  * Finally, don't call this from a place that might have a DONT_MIGRATE
572  * cur_uth.  This should be safe for most 2LS code. */
573 bool __check_preempt_pending(uint32_t vcoreid)
574 {
575         bool retval = FALSE;
576         assert(in_vcore_context());
577         if (__preempt_is_pending(vcoreid)) {
578                 retval = TRUE;
579                 if (sched_ops->preempt_pending)
580                         sched_ops->preempt_pending();
581                 /* If we still have a cur_uth, copy it out and hand it back to the 2LS
582                  * before yielding. */
583                 if (current_uthread) {
584                         __uthread_pause(vcpd_of(vcoreid), current_uthread, TRUE);
585                         current_uthread = 0;
586                 }
587                 /* vcore_yield tries to yield, and will pop back up if this was a spurious
588                  * preempt_pending or if it handled an event.  For now, we'll just keep
589                  * trying to yield so long as a preempt is coming in.  Eventually, we'll
590                  * handle all of our events and yield, or else the preemption will hit
591                  * and someone will recover us (at which point we'll break out of the
592                  * loop) */
593                 while (__procinfo.vcoremap[vcoreid].preempt_pending) {
594                         vcore_yield(TRUE);
595                         cpu_relax();
596                 }
597         }
598         return retval;
599 }
600
601 /* Helper: This is a safe way for code to disable notifs if it *might* be called
602  * from uthread context (like from a notif_safe lock).  Pair this with
603  * uth_enable_notifs() unless you know what you're doing. */
604 void uth_disable_notifs(void)
605 {
606         if (!in_vcore_context() && in_multi_mode()) {
607                 if (current_uthread)
608                         current_uthread->flags |= UTHREAD_DONT_MIGRATE;
609                 cmb();  /* don't issue the flag write before the vcore_id() read */
610                 disable_notifs(vcore_id());
611         }
612 }
613
614 /* Helper: Pair this with uth_disable_notifs(). */
615 void uth_enable_notifs(void)
616 {
617         if (!in_vcore_context() && in_multi_mode()) {
618                 if (current_uthread)
619                         current_uthread->flags &= ~UTHREAD_DONT_MIGRATE;
620                 cmb();  /* don't enable before ~DONT_MIGRATE */
621                 enable_notifs(vcore_id());
622         }
623 }
624
625 /* Helper: returns TRUE if it succeeded in starting the uth stealing process. */
626 static bool start_uth_stealing(struct preempt_data *vcpd)
627 {
628         long old_flags;
629         do {
630                 old_flags = atomic_read(&vcpd->flags);
631                 /* Spin if the kernel is mucking with the flags */
632                 while (old_flags & VC_K_LOCK)
633                         old_flags = atomic_read(&vcpd->flags);
634                 /* Someone else is stealing, we failed */
635                 if (old_flags & VC_UTHREAD_STEALING)
636                         return FALSE;
637         } while (!atomic_cas(&vcpd->flags, old_flags,
638                              old_flags | VC_UTHREAD_STEALING));
639         return TRUE;
640 }
641
642 /* Helper: pairs with stop_uth_stealing */
643 static void stop_uth_stealing(struct preempt_data *vcpd)
644 {
645         long old_flags;
646         do {
647                 old_flags = atomic_read(&vcpd->flags);
648                 assert(old_flags & VC_UTHREAD_STEALING);        /* sanity */
649                 while (old_flags & VC_K_LOCK)
650                         old_flags = atomic_read(&vcpd->flags);
651         } while (!atomic_cas(&vcpd->flags, old_flags,
652                              old_flags & ~VC_UTHREAD_STEALING));
653 }
654
655 /* Handles INDIRS for another core (the public mbox).  We synchronize with the
656  * kernel (__set_curtf_to_vcoreid). */
657 static void handle_indirs(uint32_t rem_vcoreid)
658 {
659         long old_flags;
660         struct preempt_data *rem_vcpd = vcpd_of(rem_vcoreid);
661         /* Turn off their message reception if they are still preempted.  If they
662          * are no longer preempted, we do nothing - they will handle their own
663          * messages.  Turning on CAN_RCV will route this vcore's messages to
664          * fallback vcores (if applicable). */
665         do {
666                 old_flags = atomic_read(&rem_vcpd->flags);
667                 while (old_flags & VC_K_LOCK)
668                         old_flags = atomic_read(&rem_vcpd->flags);
669                 if (!(old_flags & VC_PREEMPTED))
670                         return;
671         } while (!atomic_cas(&rem_vcpd->flags, old_flags,
672                              old_flags & ~VC_CAN_RCV_MSG));
673         wrmb(); /* don't let the CAN_RCV write pass reads of the mbox status */
674         /* handle all INDIRs of the remote vcore */
675         handle_vcpd_mbox(rem_vcoreid);
676 }
677
678 /* Helper.  Will ensure a good attempt at changing vcores, meaning we try again
679  * if we failed for some reason other than the vcore was already running. */
680 static void __change_vcore(uint32_t rem_vcoreid, bool enable_my_notif)
681 {
682         /* okay to do a normal spin/relax here, even though we are in vcore
683          * context. */
684         while (-EAGAIN == sys_change_vcore(rem_vcoreid, enable_my_notif))
685                 cpu_relax();
686 }
687
688 /* Helper, used in preemption recovery.  When you can freely leave vcore
689  * context and need to change to another vcore, call this.  vcpd is the caller,
690  * rem_vcoreid is the remote vcore.  This will try to package up your uthread.
691  * It may return, either because the other core already started up (someone else
692  * got it), or in some very rare cases where we had to stay in our vcore
693  * context */
694 static void change_to_vcore(struct preempt_data *vcpd, uint32_t rem_vcoreid)
695 {
696         bool were_handling_remotes;
697         /* Unlikely, but if we have no uthread we can just change.  This is the
698          * check, sync, then really check pattern: we can only really be sure about
699          * current_uthread after we check STEALING. */
700         if (!current_uthread) {
701                 /* there might be an issue with doing this while someone is recovering.
702                  * once they 0'd it, we should be good to yield.  just a bit dangerous.
703                  * */
704                 were_handling_remotes = ev_might_not_return();
705                 __change_vcore(rem_vcoreid, TRUE);      /* noreturn on success */
706                 goto out_we_returned;
707         }
708         /* Note that the reason we need to check STEALING is because we can get into
709          * vcore context and slip past that check in vcore_entry when we are
710          * handling a preemption message.  Anytime preemption recovery cares about
711          * the calling vcore's cur_uth, it needs to be careful about STEALING.  But
712          * it is safe to do the check up above (if it's 0, it won't concurrently
713          * become non-zero).
714          *
715          * STEALING might be turned on at any time.  Whoever turns it on will do
716          * nothing if we are online or were in vc_ctx.  So if it is on, we can't
717          * touch current_uthread til it is turned off (not sure what state they saw
718          * us in).  We could spin here til they unset STEALING (since they will
719          * soon), but there is a chance they were preempted, so we need to make
720          * progress by doing a sys_change_vcore(). */
721         /* Crap, someone is stealing (unlikely).  All we can do is change. */
722         if (atomic_read(&vcpd->flags) & VC_UTHREAD_STEALING) {
723                 __change_vcore(rem_vcoreid, FALSE);     /* returns on success */
724                 return;
725         }
726         cmb();
727         /* Need to recheck, in case someone stole it and finished before we checked
728          * VC_UTHREAD_STEALING. */
729         if (!current_uthread) {
730                 were_handling_remotes = ev_might_not_return();
731                 __change_vcore(rem_vcoreid, TRUE);      /* noreturn on success */
732                 goto out_we_returned;
733         }
734         /* Need to make sure we don't have a DONT_MIGRATE (very rare, someone would
735          * have to steal from us to get us to handle a preempt message, and then had
736          * to finish stealing (and fail) fast enough for us to miss the previous
737          * check). */
738         if (current_uthread->flags & UTHREAD_DONT_MIGRATE) {
739                 __change_vcore(rem_vcoreid, FALSE);     /* returns on success */
740                 return;
741         }
742         /* Now save our uthread and restart them */
743         assert(current_uthread);
744         __uthread_pause(vcpd, current_uthread, TRUE);
745         current_uthread = 0;
746         were_handling_remotes = ev_might_not_return();
747         __change_vcore(rem_vcoreid, TRUE);              /* noreturn on success */
748         /* Fall-through to out_we_returned */
749 out_we_returned:
750         ev_we_returned(were_handling_remotes);
751 }
752
753 /* This handles a preemption message.  When this is done, either we recovered,
754  * or recovery *for our message* isn't needed. */
755 static void handle_vc_preempt(struct event_msg *ev_msg, unsigned int ev_type)
756 {
757         uint32_t vcoreid = vcore_id();
758         struct preempt_data *vcpd = vcpd_of(vcoreid);
759         uint32_t rem_vcoreid = ev_msg->ev_arg2;
760         struct preempt_data *rem_vcpd = vcpd_of(rem_vcoreid);
761         extern void **vcore_thread_control_blocks;
762         struct uthread *uthread_to_steal = 0;
763         bool cant_migrate = FALSE;
764
765         assert(in_vcore_context());
766         /* Just drop messages about ourselves.  They are old.  If we happen to be
767          * getting preempted right now, there's another message out there about
768          * that. */
769         if (rem_vcoreid == vcoreid)
770                 return;
771         printd("Vcore %d was preempted (i'm %d), it's flags %08p!\n",
772                ev_msg->ev_arg2, vcoreid, rem_vcpd->flags);
773         /* Spin til the kernel is done with flags.  This is how we avoid handling
774          * the preempt message before the preemption. */
775         while (atomic_read(&rem_vcpd->flags) & VC_K_LOCK)
776                 cpu_relax();
777         /* If they aren't preempted anymore, just return (optimization). */
778         if (!(atomic_read(&rem_vcpd->flags) & VC_PREEMPTED))
779                 return;
780         /* At this point, we need to try to recover */
781         /* This case handles when the remote core was in vcore context */
782         if (rem_vcpd->notif_disabled) {
783                 printd("VC %d recovering %d, notifs were disabled\n", vcoreid, rem_vcoreid);
784                 change_to_vcore(vcpd, rem_vcoreid);
785                 return; /* in case it returns.  we've done our job recovering */
786         }
787         /* So now it looks like they were not in vcore context.  We want to steal
788          * the uthread.  Set stealing, then doublecheck everything.  If stealing
789          * fails, someone else is stealing and we can just leave.  That other vcore
790          * who is stealing will check the VCPD/INDIRs when it is done. */
791         if (!start_uth_stealing(rem_vcpd))
792                 return;
793         /* Now we're stealing.  Double check everything.  A change in preempt status
794          * or notif_disable status means the vcore has since restarted.  The vcore
795          * may or may not have started after we set STEALING.  If it didn't, we'll
796          * need to bail out (but still check messages, since above we assumed the
797          * uthread stealer handles the VCPD/INDIRs).  Since the vcore is running, we
798          * don't need to worry about handling the message any further.  Future
799          * preemptions will generate another message, so we can ignore getting the
800          * uthread or anything like that. */
801         printd("VC %d recovering %d, trying to steal uthread\n", vcoreid, rem_vcoreid);
802         if (!(atomic_read(&rem_vcpd->flags) & VC_PREEMPTED))
803                 goto out_stealing;
804         /* Might be preempted twice quickly, and the second time had notifs
805          * disabled.
806          *
807          * Also note that the second preemption event had another
808          * message sent, which either we or someone else will deal with.  And also,
809          * we don't need to worry about how we are stealing still and plan to
810          * abort.  If another vcore handles that second preemption message, either
811          * the original vcore is in vc ctx or not.  If so, we bail out and the
812          * second preemption handling needs to change_to.  If not, we aren't
813          * bailing out, and we'll handle the preemption as normal, and the second
814          * handler will bail when it fails to steal. */
815         if (rem_vcpd->notif_disabled)
816                 goto out_stealing;
817         /* At this point, we're clear to try and steal the uthread.  Need to switch
818          * into their TLS to take their uthread */
819         vcoreid = vcore_id();   /* need to copy this out to our stack var */
820         /* We want to minimize the time we're in the remote vcore's TLS, so we peak
821          * and make the minimum changes we need, and deal with everything later. */
822         set_tls_desc(vcore_thread_control_blocks[rem_vcoreid], vcoreid);
823         if (current_uthread) {
824                 if (current_uthread->flags & UTHREAD_DONT_MIGRATE) {
825                         cant_migrate = TRUE;
826                 } else {
827                         uthread_to_steal = current_uthread;
828                         current_uthread = 0;
829                 }
830         }
831         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
832         /* Extremely rare: they have a uthread, but it can't migrate.  So we'll need
833          * to change to them. */
834         if (cant_migrate) {
835                 printd("VC %d recovering %d, can't migrate uthread!\n", vcoreid, rem_vcoreid);
836                 stop_uth_stealing(rem_vcpd);
837                 change_to_vcore(vcpd, rem_vcoreid);
838                 return; /* in case it returns.  we've done our job recovering */
839         }
840         if (!uthread_to_steal)
841                 goto out_stealing;
842         /* we're clear to steal it */
843         printd("VC %d recovering %d, uthread %08p stolen\n", vcoreid, rem_vcoreid,
844                current_uthread);
845         __uthread_pause(rem_vcpd, uthread_to_steal, FALSE);
846         /* can't let the cur_uth = 0 write and any writes from __uth_pause() to
847          * pass stop_uth_stealing.  it's harmless in the cant_migrate case. */
848         wmb();
849         /* Fallthrough */
850 out_stealing:
851         stop_uth_stealing(rem_vcpd);
852         handle_indirs(rem_vcoreid);
853 }
854
855 /* This handles a "check indirs" message.  When this is done, either we checked
856  * their indirs, or the vcore restarted enough so that checking them is
857  * unnecessary.  If that happens and they got preempted quickly, then another
858  * preempt/check_indirs was sent out. */
859 static void handle_vc_indir(struct event_msg *ev_msg, unsigned int ev_type)
860 {
861         uint32_t vcoreid = vcore_id();
862         uint32_t rem_vcoreid = ev_msg->ev_arg2;
863
864         if (rem_vcoreid == vcoreid)
865                 return;
866         handle_indirs(rem_vcoreid);
867 }
868
869 /* Attempts to register ev_q with sysc, so long as sysc is not done/progress.
870  * Returns true if it succeeded, and false otherwise.  False means that the
871  * syscall is done, and does not need an event set (and should be handled
872  * accordingly).
873  * 
874  * A copy of this is in glibc/sysdeps/ros/syscall.c.  Keep them in sync. */
875 bool register_evq(struct syscall *sysc, struct event_queue *ev_q)
876 {
877         int old_flags;
878         sysc->ev_q = ev_q;
879         wrmb(); /* don't let that write pass any future reads (flags) */
880         /* Try and set the SC_UEVENT flag (so the kernel knows to look at ev_q) */
881         do {
882                 /* no cmb() needed, the atomic_read will reread flags */
883                 old_flags = atomic_read(&sysc->flags);
884                 /* Spin if the kernel is mucking with syscall flags */
885                 while (old_flags & SC_K_LOCK)
886                         old_flags = atomic_read(&sysc->flags);
887                 /* If the kernel finishes while we are trying to sign up for an event,
888                  * we need to bail out */
889                 if (old_flags & (SC_DONE | SC_PROGRESS)) {
890                         sysc->ev_q = 0;         /* not necessary, but might help with bugs */
891                         return FALSE;
892                 }
893         } while (!atomic_cas(&sysc->flags, old_flags, old_flags | SC_UEVENT));
894         return TRUE;
895 }
896
897 /* De-registers a syscall, so that the kernel will not send an event when it is
898  * done.  The call could already be SC_DONE, or could even finish while we try
899  * to unset SC_UEVENT.
900  *
901  * There is a chance the kernel sent an event if you didn't do this in time, but
902  * once this returns, the kernel won't send a message.
903  *
904  * If the kernel is trying to send a message right now, this will spin (on
905  * SC_K_LOCK).  We need to make sure we deregistered, and that if a message
906  * is coming, that it already was sent (and possibly overflowed), before
907  * returning. */
908 void deregister_evq(struct syscall *sysc)
909 {
910         int old_flags;
911         sysc->ev_q = 0;
912         wrmb(); /* don't let that write pass any future reads (flags) */
913         /* Try and unset the SC_UEVENT flag */
914         do {
915                 /* no cmb() needed, the atomic_read will reread flags */
916                 old_flags = atomic_read(&sysc->flags);
917                 /* Spin if the kernel is mucking with syscall flags */
918                 while (old_flags & SC_K_LOCK)
919                         old_flags = atomic_read(&sysc->flags);
920                 /* Note we don't care if the SC_DONE flag is getting set.  We just need
921                  * to avoid clobbering flags */
922         } while (!atomic_cas(&sysc->flags, old_flags, old_flags & ~SC_UEVENT));
923 }
924
925 /* TLS helpers */
926 static int __uthread_allocate_tls(struct uthread *uthread)
927 {
928         assert(!uthread->tls_desc);
929         uthread->tls_desc = allocate_tls();
930         if (!uthread->tls_desc) {
931                 errno = ENOMEM;
932                 return -1;
933         }
934         return 0;
935 }
936
937 static int __uthread_reinit_tls(struct uthread *uthread)
938 {
939         uthread->tls_desc = reinit_tls(uthread->tls_desc);
940         if (!uthread->tls_desc) {
941                 errno = ENOMEM;
942                 return -1;
943         }
944         return 0;
945 }
946
947 static void __uthread_free_tls(struct uthread *uthread)
948 {
949         free_tls(uthread->tls_desc);
950         uthread->tls_desc = NULL;
951 }