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