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