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