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