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