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