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