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