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