perf: Treat the kernel like [kernel.kallsyms]
[akaros.git] / user / parlib / uthread.c
1 /* Copyright (c) 2011-2014 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details. */
4
5 #include <ros/arch/membar.h>
6 #include <parlib/arch/atomic.h>
7 #include <parlib/parlib.h>
8 #include <parlib/vcore.h>
9 #include <parlib/uthread.h>
10 #include <parlib/event.h>
11 #include <stdlib.h>
12 #include <parlib/assert.h>
13 #include <parlib/arch/trap.h>
14
15 /* SCPs have a default 2LS that only manages thread 0.  Any other 2LS, such as
16  * pthreads, should override sched_ops in its init code. */
17 extern struct schedule_ops thread0_2ls_ops;
18 struct schedule_ops *sched_ops = &thread0_2ls_ops;
19
20 __thread struct uthread *current_uthread = 0;
21 /* ev_q for all preempt messages (handled here to keep 2LSs from worrying
22  * extensively about the details.  Will call out when necessary. */
23 static struct event_queue *preempt_ev_q;
24
25 /* Helpers: */
26 #define UTH_TLSDESC_NOTLS (void*)(-1)
27 static inline bool __uthread_has_tls(struct uthread *uthread);
28 static int __uthread_allocate_tls(struct uthread *uthread);
29 static int __uthread_reinit_tls(struct uthread *uthread);
30 static void __uthread_free_tls(struct uthread *uthread);
31 static void __run_current_uthread_raw(void);
32
33 static void handle_vc_preempt(struct event_msg *ev_msg, unsigned int ev_type,
34                               void *data);
35 static void handle_vc_indir(struct event_msg *ev_msg, unsigned int ev_type,
36                             void *data);
37 static void __ros_uth_syscall_blockon(struct syscall *sysc);
38
39 /* Helper, initializes a fresh uthread to be thread0. */
40 static void uthread_init_thread0(struct uthread *uthread)
41 {
42         assert(uthread);
43         /* Save a pointer to thread0's tls region (the glibc one) into its tcb */
44         uthread->tls_desc = get_tls_desc();
45         /* Save a pointer to the uthread in its own TLS */
46         current_uthread = uthread;
47         /* Thread is currently running (it is 'us') */
48         uthread->state = UT_RUNNING;
49         /* Reset the signal state */
50         uthread->sigstate.mask = 0;
51         __sigemptyset(&uthread->sigstate.pending);
52         uthread->sigstate.data = NULL;
53         /* utf/as doesn't represent the state of the uthread (we are running) */
54         uthread->flags &= ~(UTHREAD_SAVED | UTHREAD_FPSAVED);
55         /* need to track thread0 for TLS deallocation */
56         uthread->flags |= UTHREAD_IS_THREAD0;
57         uthread->notif_disabled_depth = 0;
58         /* setting the uthread's TLS var.  this is idempotent for SCPs (us) */
59         __vcoreid = 0;
60 }
61
62 /* Helper, makes VC ctx tracks uthread as its current_uthread in its TLS.
63  *
64  * Whether or not uthreads have TLS, thread0 has TLS, given to it by glibc.
65  * This TLS will get set whenever we use thread0, regardless of whether or not
66  * we use TLS for uthreads in general.  glibc cares about this TLS and will use
67  * it at exit.  We can't simply use that TLS for VC0 either, since we don't know
68  * where thread0 will be running when the program ends. */
69 static void uthread_track_thread0(struct uthread *uthread)
70 {
71         set_tls_desc(get_vcpd_tls_desc(0));
72         begin_safe_access_tls_vars();
73         /* We might have a basic uthread already installed (from a prior call), so
74          * free it before installing the new one. */
75         if (current_uthread)
76                 free(current_uthread);
77         current_uthread = uthread;
78         /* We may not be an MCP at this point (and thus not really working with
79          * vcores), but there is still the notion of something vcore_context-like
80          * even when running as an SCP (i.e. its more of a scheduler_context than a
81          * vcore_context).  Threfore we need to set __vcore_context to TRUE here to
82          * represent this (otherwise we will hit some asserts of not being in
83          * vcore_context when running in scheduler_context for the SCP. */
84         __vcore_context = TRUE;
85         end_safe_access_tls_vars();
86         set_tls_desc(uthread->tls_desc);
87 }
88
89 /* The real 2LS calls this to transition us into mcp mode.  When it
90  * returns, you're in _M mode, still running thread0, on vcore0 */
91 void uthread_mcp_init()
92 {
93         /* Prevent this from happening more than once. */
94         init_once_racy(return);
95
96         /* Doing this after the init_once check, since we don't want to let the
97          * process/2LS change their mind about being an MCP or not once they have
98          * multiple threads.
99          *
100          * The reason is that once you set "MCP please" on, you could get
101          * interrupted into VC ctx, say for a syscall completion, and then make
102          * decisions based on the fact that you're an MCP (e.g., unblocking a
103          * uthread, asking for vcores, etc), even though you are not an MCP.
104          * Arguably, these things could happen for signals too, but all of this is
105          * less likely than if we have multiple threads.
106          *
107          * Also, we could just abort here, since they shouldn't be calling
108          * mcp_init() if they don't want to be an MCP. */
109         if (!parlib_wants_to_be_mcp)
110                 return;
111
112         /* Receive preemption events.  Note that this merely tells the kernel how to
113          * send the messages, and does not necessarily provide storage space for the
114          * messages.  What we're doing is saying that all PREEMPT and CHECK_MSGS
115          * events should be spammed to vcores that are running, preferring whatever
116          * the kernel thinks is appropriate.  And IPI them.
117          *
118          * It is critical that these are either SPAM_PUB or INDIR|SPAM_INDIR, so
119          * that yielding vcores do not miss the preemption messages. */
120         register_ev_handler(EV_VCORE_PREEMPT, handle_vc_preempt, 0);
121         register_ev_handler(EV_CHECK_MSGS, handle_vc_indir, 0);
122         preempt_ev_q = get_eventq_slim();       /* small ev_q, mostly a vehicle for flags */
123         preempt_ev_q->ev_flags = EVENT_IPI | EVENT_SPAM_PUBLIC | EVENT_VCORE_APPRO |
124                                                          EVENT_VCORE_MUST_RUN | EVENT_WAKEUP;
125         /* Tell the kernel to use the ev_q (it's settings) for the two types.  Note
126          * that we still have two separate handlers.  We just want the events
127          * delivered in the same way.  If we ever want to have a big_event_q with
128          * INDIRs, we could consider using separate ones. */
129         register_kevent_q(preempt_ev_q, EV_VCORE_PREEMPT);
130         register_kevent_q(preempt_ev_q, EV_CHECK_MSGS);
131         printd("[user] registered %08p (flags %08p) for preempt messages\n",
132                preempt_ev_q, preempt_ev_q->ev_flags);
133         /* Get ourselves into _M mode.  Could consider doing this elsewhere... */
134         vcore_change_to_m();
135 }
136
137 /* The real 2LS calls this, passing in a uthread representing thread0. */
138 void uthread_2ls_init(struct uthread *uthread, struct schedule_ops *ops)
139 {
140         uthread_init_thread0(uthread);
141         /* We need to *atomically* change the current_uthread and the schedule_ops
142          * to the new 2LSs thread0 and ops, such that there is no moment when only
143          * one is changed and that we call a sched_ops.  There are sources of
144          * implicit calls to sched_ops.  Two big ones are sched_entry, called
145          * whenever we receive a notif (so we need to disable notifs), and
146          * syscall_blockon, called whenver we had a syscall that blocked (so we say
147          * tell the *uthread* that *it* is in vc ctx (TLS var).
148          *
149          * When disabling notifs, don't use a helper.  We're changing
150          * current_uthread under the hood, which messes with the helpers.  When
151          * setting __vcore_context, we're in thread0's TLS.  Even when we change
152          * current_uthread, we're still in the *same* TLS. */
153         __disable_notifs(0);
154         __vcore_context = TRUE;
155         cmb();
156         /* Under the hood, this function will free any previously allocated uthread
157          * structs representing thread0 (e.g. the one set up by uthread_lib_init()
158          * previously). */
159         uthread_track_thread0(uthread);
160         sched_ops = ops;
161         cmb();
162         __vcore_context = FALSE;
163         enable_notifs(0);       /* will trigger a self_notif if we missed a notif */
164 }
165
166 /* Helper: tells the kernel our SCP is capable of going into vcore context on
167  * vcore 0.  Pairs with k/s/process.c scp_is_vcctx_ready(). */
168 static void scp_vcctx_ready(void)
169 {
170         struct preempt_data *vcpd = vcpd_of(0);
171         long old_flags;
172         /* the CAS is a bit overkill; keeping it around in case people use this
173          * code in other situations. */
174         do {
175                 old_flags = atomic_read(&vcpd->flags);
176                 /* Spin if the kernel is mucking with the flags */
177                 while (old_flags & VC_K_LOCK)
178                         old_flags = atomic_read(&vcpd->flags);
179         } while (!atomic_cas(&vcpd->flags, old_flags,
180                              old_flags & ~VC_SCP_NOVCCTX));
181 }
182
183 /* For both of these, VC ctx uses the usual TLS errno/errstr.  Uthreads use
184  * their own storage.  Since we're called after manage_thread0, we should always
185  * have current_uthread if we are not in vc ctx. */
186 static int *__ros_errno_loc(void)
187 {
188         if (in_vcore_context())
189                 return __errno_location_tls();
190         else
191                 return &current_uthread->err_no;
192 }
193
194 static char *__ros_errstr_loc(void)
195 {
196         if (in_vcore_context())
197                 return __errstr_location_tls();
198         else
199                 return current_uthread->err_str;
200 }
201
202 /* Sets up basic uthreading for when we are in _S mode and before we set up the
203  * 2LS.  Some apps may not have a 2LS and thus never do the full
204  * vcore/2LS/uthread init. */
205 void __attribute__((constructor)) uthread_lib_init(void)
206 {
207         /* Use the thread0 sched's uth */
208         extern struct uthread *thread0_uth;
209         extern void thread0_lib_init(void);
210         int ret;
211
212         /* Only run once, but make sure that vcore_lib_init() has run already. */
213         init_once_racy(return);
214         vcore_lib_init();
215
216         ret = posix_memalign((void**)&thread0_uth, __alignof__(struct uthread),
217                              sizeof(struct uthread));
218         assert(!ret);
219         memset(thread0_uth, 0, sizeof(struct uthread)); /* aggressively 0 for bugs*/
220         /* Init the 2LS, which sets up current_uthread, before thread0 lib */
221         uthread_2ls_init(thread0_uth, &thread0_2ls_ops);
222         thread0_lib_init();
223         scp_vcctx_ready();
224         /* Change our blockon from glibc's internal one to the regular one, which
225          * uses vcore context and works for SCPs (with or without 2LS) and MCPs.
226          * Once we tell the kernel we are ready to utilize vcore context, we need
227          * our blocking syscalls to utilize it as well. */
228         ros_syscall_blockon = __ros_uth_syscall_blockon;
229         cmb();
230         init_posix_signals();
231         /* Switch our errno/errstr functions to be uthread-aware.  See glibc's
232          * errno.c for more info. */
233         ros_errno_loc = __ros_errno_loc;
234         ros_errstr_loc = __ros_errstr_loc;
235         register_ev_handler(EV_EVENT, handle_ev_ev, 0);
236 }
237
238 /* 2LSs shouldn't call uthread_vcore_entry directly */
239 void __attribute__((noreturn)) uthread_vcore_entry(void)
240 {
241         uint32_t vcoreid = vcore_id();
242         struct preempt_data *vcpd = vcpd_of(vcoreid);
243         /* Should always have notifications disabled when coming in here. */
244         assert(!notif_is_enabled(vcoreid));
245         assert(in_vcore_context());
246         /* If someone is stealing our uthread (from when we were preempted before),
247          * we can't touch our uthread.  But we might be the last vcore around, so
248          * we'll handle preemption events (spammed to our public mbox).
249          *
250          * It's important that we only check/handle one message per loop, otherwise
251          * we could get stuck in a ping-pong scenario with a recoverer (maybe). */
252         while (atomic_read(&vcpd->flags) & VC_UTHREAD_STEALING) {
253                 /* Note we're handling INDIRs and other public messages while someone
254                  * is stealing our uthread.  Remember that those event handlers cannot
255                  * touch cur_uth, as it is "vcore business". */
256                 handle_one_mbox_msg(&vcpd->ev_mbox_public);
257                 cpu_relax();
258         }
259         /* If we have a current uthread that is DONT_MIGRATE, pop it real quick and
260          * let it disable notifs (like it wants to).  Other than dealing with
261          * preemption events (or other INDIRs), we shouldn't do anything in vc_ctx
262          * when we have a DONT_MIGRATE uthread. */
263         if (current_uthread && (current_uthread->flags & UTHREAD_DONT_MIGRATE))
264                 __run_current_uthread_raw();
265         /* Check and see if we wanted ourselves to handle a remote VCPD mbox.  Want
266          * to do this after we've handled STEALING and DONT_MIGRATE. */
267         try_handle_remote_mbox();
268         /* Otherwise, go about our usual vcore business (messages, etc). */
269         handle_events(vcoreid);
270         __check_preempt_pending(vcoreid);
271         assert(in_vcore_context());     /* double check, in case an event changed it */
272         sched_ops->sched_entry();
273         assert(0); /* 2LS sched_entry should never return */
274 }
275
276 /* Does the uthread initialization of a uthread that the caller created.  Call
277  * this whenever you are "starting over" with a thread. */
278 void uthread_init(struct uthread *new_thread, struct uth_thread_attr *attr)
279 {
280         int ret;
281         assert(new_thread);
282         new_thread->state = UT_NOT_RUNNING;
283         /* Set the signal state. */
284         new_thread->sigstate.mask = current_uthread->sigstate.mask;
285         __sigemptyset(&new_thread->sigstate.pending);
286         new_thread->sigstate.data = NULL;
287         /* They should have zero'd the uthread.  Let's check critical things: */
288         assert(!new_thread->flags && !new_thread->sysc);
289         /* the utf holds the GP context of the uthread (set by the 2LS earlier).
290          * There is no FP context to be restored yet.  We only save the FPU when we
291          * were interrupted off a core. */
292         new_thread->flags |= UTHREAD_SAVED;
293         new_thread->notif_disabled_depth = 0;
294         if (attr && attr->want_tls) {
295                 /* Get a TLS.  If we already have one, reallocate/refresh it */
296                 if (new_thread->tls_desc)
297                         ret = __uthread_reinit_tls(new_thread);
298                 else
299                         ret = __uthread_allocate_tls(new_thread);
300                 assert(!ret);
301                 begin_access_tls_vars(new_thread->tls_desc);
302                 current_uthread = new_thread;
303                 /* ctypes stores locale info in TLS.  we need this only once per TLS, so
304                  * we don't have to do it here, but it is convenient since we already
305                  * loaded the uthread's TLS. */
306                 extern void __ctype_init(void);
307                 __ctype_init();
308                 end_access_tls_vars();
309         } else {
310                 new_thread->tls_desc = UTH_TLSDESC_NOTLS;
311         }
312 }
313
314 /* This is a wrapper for the sched_ops thread_runnable, for use by functions
315  * outside the main 2LS.  Do not put anything important in this, since the 2LSs
316  * internally call their sched op.  This is to improve batch wakeups (barriers,
317  * etc) */
318 void uthread_runnable(struct uthread *uthread)
319 {
320         assert(sched_ops->thread_runnable);
321         sched_ops->thread_runnable(uthread);
322 }
323
324 /* Informs the 2LS that its thread blocked, and it is not under the control of
325  * the 2LS.  This is for informational purposes, and some semantic meaning
326  * should be passed by flags (from uthread.h's UTH_EXT_BLK_xxx options).
327  * Eventually, whoever calls this will call uthread_runnable(), giving the
328  * thread back to the 2LS.
329  *
330  * If code outside the 2LS has blocked a thread (via uthread_yield) and ran its
331  * own callback/yield_func instead of some 2LS code, that callback needs to
332  * call this.
333  *
334  * AKA: obviously_a_uthread_has_blocked_in_lincoln_park() */
335 void uthread_has_blocked(struct uthread *uthread, int flags)
336 {
337         assert(sched_ops->thread_has_blocked);
338         sched_ops->thread_has_blocked(uthread, flags);
339 }
340
341 /* Function indicating an external event has temporarily paused a uthread, but
342  * it is ok to resume it if possible. */
343 void uthread_paused(struct uthread *uthread)
344 {
345         /* Call out to the 2LS to let it know the uthread was paused for some
346          * reason, but it is ok to resume it now. */
347     assert(uthread->state == UT_NOT_RUNNING);
348     assert(sched_ops->thread_paused);
349     sched_ops->thread_paused(uthread);
350 }
351
352 /* Need to have this as a separate, non-inlined function since we clobber the
353  * stack pointer before calling it, and don't want the compiler to play games
354  * with my hart. */
355 static void __attribute__((noinline, noreturn))
356 __uthread_yield(void)
357 {
358         struct uthread *uthread = current_uthread;
359         assert(in_vcore_context());
360         assert(!notif_is_enabled(vcore_id()));
361         /* Note: we no longer care if the thread is exiting, the 2LS will call
362          * uthread_destroy() */
363         uthread->flags &= ~UTHREAD_DONT_MIGRATE;
364         uthread->state = UT_NOT_RUNNING;
365         /* Any locks that were held before the yield must be unlocked in the
366          * callback.  That callback won't get a chance to update our disabled depth.
367          * This sets us up for the next time the uthread runs. */
368         uthread->notif_disabled_depth = 0;
369         /* Do whatever the yielder wanted us to do */
370         assert(uthread->yield_func);
371         uthread->yield_func(uthread, uthread->yield_arg);
372         /* Make sure you do not touch uthread after that func call */
373         /* Leave the current vcore completely */
374         /* TODO: if the yield func can return a failure, we can abort the yield */
375         current_uthread = NULL;
376         /* Go back to the entry point, where we can handle notifications or
377          * reschedule someone. */
378         uthread_vcore_entry();
379 }
380
381 /* Calling thread yields for some reason.  Set 'save_state' if you want to ever
382  * run the thread again.  Once in vcore context in __uthread_yield, yield_func
383  * will get called with the uthread and yield_arg passed to it.  This way, you
384  * can do whatever you want when you get into vcore context, which can be
385  * thread_blockon_sysc, unlocking mutexes, joining, whatever.
386  *
387  * If you do *not* pass a 2LS sched op or other 2LS function as yield_func,
388  * then you must also call uthread_has_blocked(flags), which will let the 2LS
389  * know a thread blocked beyond its control (and why). */
390 void uthread_yield(bool save_state, void (*yield_func)(struct uthread*, void*),
391                    void *yield_arg)
392 {
393         struct uthread *uthread = current_uthread;
394         volatile bool yielding = TRUE; /* signal to short circuit when restarting */
395         assert(!in_vcore_context());
396         assert(uthread->state == UT_RUNNING);
397         /* Pass info to ourselves across the uth_yield -> __uth_yield transition. */
398         uthread->yield_func = yield_func;
399         uthread->yield_arg = yield_arg;
400         /* Don't migrate this thread to another vcore, since it depends on being on
401          * the same vcore throughout (once it disables notifs).  The race is that we
402          * read vcoreid, then get interrupted / migrated before disabling notifs. */
403         uthread->flags |= UTHREAD_DONT_MIGRATE;
404         cmb();  /* don't let DONT_MIGRATE write pass the vcoreid read */
405         uint32_t vcoreid = vcore_id();
406         printd("[U] Uthread %08p is yielding on vcore %d\n", uthread, vcoreid);
407         struct preempt_data *vcpd = vcpd_of(vcoreid);
408         /* once we do this, we might miss a notif_pending, so we need to enter vcore
409          * entry later.  Need to disable notifs so we don't get in weird loops with
410          * save_user_ctx() and pop_user_ctx(). */
411         disable_notifs(vcoreid);
412         /* take the current state and save it into t->utf when this pthread
413          * restarts, it will continue from right after this, see yielding is false,
414          * and short ciruit the function.  Don't do this if we're dying. */
415         if (save_state) {
416                 /* Need to signal this before we actually save, since save_user_ctx
417                  * returns() twice (once now, once when woken up) */
418                 uthread->flags |= UTHREAD_SAVED;
419                 save_user_ctx(&uthread->u_ctx);
420         }
421         cmb();  /* Force reread of yielding. Technically save_user_ctx() suffices*/
422         /* Restart path doesn't matter if we're dying */
423         if (!yielding)
424                 goto yield_return_path;
425         /* From here on down is only executed on the save path (not the wake up) */
426         yielding = FALSE; /* for when it starts back up */
427         /* TODO: remove this when all arches support SW contexts */
428         if (save_state && (uthread->u_ctx.type != ROS_SW_CTX)) {
429                 save_fp_state(&uthread->as);
430                 uthread->flags |= UTHREAD_FPSAVED;
431         }
432         /* Change to the transition context (both TLS (if applicable) and stack). */
433         if (__uthread_has_tls(uthread)) {
434                 set_tls_desc(get_vcpd_tls_desc(vcoreid));
435                 begin_safe_access_tls_vars();
436                 assert(current_uthread == uthread);
437                 /* If this assert fails, see the note in uthread_track_thread0 */
438                 assert(in_vcore_context());
439                 end_safe_access_tls_vars();
440         } else {
441                 /* Since uthreads and vcores share TLS (it's always the vcore's TLS, the
442                  * uthread one just bootstraps from it), we need to change our state at
443                  * boundaries between the two 'contexts' */
444                 __vcore_context = TRUE;
445         }
446         /* After this, make sure you don't use local variables.  Also, make sure the
447          * compiler doesn't use them without telling you (TODO).
448          *
449          * In each arch's set_stack_pointer, make sure you subtract off as much room
450          * as you need to any local vars that might be pushed before calling the
451          * next function, or for whatever other reason the compiler/hardware might
452          * walk up the stack a bit when calling a noreturn function. */
453         set_stack_pointer((void*)vcpd->vcore_stack);
454         /* Finish exiting in another function. */
455         __uthread_yield();
456         /* Should never get here */
457         assert(0);
458         /* Will jump here when the uthread's trapframe is restarted/popped. */
459 yield_return_path:
460         printd("[U] Uthread %08p returning from a yield!\n", uthread);
461 }
462
463 /* We explicitly don't support sleep(), since old callers of it have
464  * expectations of being woken up by signal handlers.  If we need that, we can
465  * build it in to sleep() later.  If you just want to sleep for a while, call
466  * this helper. */
467 void uthread_sleep(unsigned int seconds)
468 {
469         sys_block(seconds * 1000000);   /* usec sleep */
470 }
471 /* If we are providing a dummy sleep function, might as well provide the more
472  * accurate/useful one. */
473 void uthread_usleep(unsigned int usecs)
474 {
475         sys_block(usecs);       /* usec sleep */
476 }
477
478 void uthread_sleep_forever(void)
479 {
480         uth_mutex_t mtx = uth_mutex_alloc();
481
482         uth_mutex_lock(mtx);
483         uth_mutex_lock(mtx);
484 }
485
486 /* Cleans up the uthread (the stuff we did in uthread_init()).  If you want to
487  * destroy a currently running uthread, you'll want something like
488  * pthread_exit(), which yields, and calls this from its sched_ops yield. */
489 void uthread_cleanup(struct uthread *uthread)
490 {
491         printd("[U] thread %08p on vcore %d is DYING!\n", uthread, vcore_id());
492         /* we alloc and manage the TLS, so lets get rid of it, except for thread0.
493          * glibc owns it.  might need to keep it around for a full exit() */
494         if (__uthread_has_tls(uthread) && !(uthread->flags & UTHREAD_IS_THREAD0))
495                 __uthread_free_tls(uthread);
496 }
497
498 static void __ros_syscall_spinon(struct syscall *sysc)
499 {
500         while (!(atomic_read(&sysc->flags) & (SC_DONE | SC_PROGRESS)))
501                 cpu_relax();
502 }
503
504 static void __ros_vcore_ctx_syscall_blockon(struct syscall *sysc)
505 {
506         if (in_multi_mode()) {
507                 /* MCP vcore's don't know what to do yet, so we have to spin */
508                 __ros_syscall_spinon(sysc);
509         } else {
510                 /* SCPs can use the early blockon, which acts like VC ctx. */
511                 __ros_early_syscall_blockon(sysc);
512         }
513 }
514
515 /* Attempts to block on sysc, returning when it is done or progress has been
516  * made.  Made for initialized processes using uthreads. */
517 static void __ros_uth_syscall_blockon(struct syscall *sysc)
518 {
519         if (in_vcore_context()) {
520                 __ros_vcore_ctx_syscall_blockon(sysc);
521                 return;
522         }
523         /* At this point, we know we're a uthread.  If we're a DONT_MIGRATE uthread,
524          * then it's disabled notifs and is basically in vcore context, enough so
525          * that it can't call into the 2LS. */
526         assert(current_uthread);
527         if (current_uthread->flags & UTHREAD_DONT_MIGRATE) {
528                 assert(!notif_is_enabled(vcore_id()));  /* catch bugs */
529                 /* if we had a notif_disabled_depth, then we should also have
530                  * DONT_MIGRATE set */
531                 __ros_vcore_ctx_syscall_blockon(sysc);
532                 return;
533         }
534         assert(!current_uthread->notif_disabled_depth);
535         /* double check before doing all this crap */
536         if (atomic_read(&sysc->flags) & (SC_DONE | SC_PROGRESS))
537                 return;
538         /* for both debugging and syscall cancelling */
539         current_uthread->sysc = sysc;
540         /* yield, calling 2ls-blockon(cur_uth, sysc) on the other side */
541         uthread_yield(TRUE, sched_ops->thread_blockon_sysc, sysc);
542 }
543
544 /* 2LS helper.  Run this from vcore context.  It will block a uthread on it's
545  * internal syscall struct, which should be an async call.  You'd use this in
546  * e.g. thread_refl_fault when the 2LS initiates a syscall on behalf of the
547  * uthread. */
548 void __block_uthread_on_async_sysc(struct uthread *uth)
549 {
550         assert(in_vcore_context());
551         uth->sysc = &uth->local_sysc;
552         /* If a DONT_MIGRATE issued a syscall that blocks, we gotta spin, same as
553          * with the usual blockon. */
554         if (uth->flags & UTHREAD_DONT_MIGRATE) {
555                 __ros_vcore_ctx_syscall_blockon(uth->sysc);
556                 uth->sysc = 0;
557                 return;
558         }
559         sched_ops->thread_blockon_sysc(uth, uth->sysc);
560 }
561
562 /* Simply sets current uthread to be whatever the value of uthread is.  This
563  * can be called from outside of sched_entry() to highjack the current context,
564  * and make sure that the new uthread struct is used to store this context upon
565  * yielding, etc. USE WITH EXTREME CAUTION! */
566 void highjack_current_uthread(struct uthread *uthread)
567 {
568         uint32_t vcoreid = vcore_id();
569         assert(uthread != current_uthread);
570         current_uthread->state = UT_NOT_RUNNING;
571         uthread->state = UT_RUNNING;
572         /* Make sure the vcore is tracking the new uthread struct */
573         if (__uthread_has_tls(current_uthread))
574                 vcore_set_tls_var(current_uthread, uthread);
575         else
576                 current_uthread = uthread;
577         /* and make sure we are using the correct TLS for the new uthread */
578         if (__uthread_has_tls(uthread)) {
579                 assert(uthread->tls_desc);
580                 set_tls_desc(uthread->tls_desc);
581                 begin_safe_access_tls_vars();
582                 __vcoreid = vcoreid;    /* setting the uthread's TLS var */
583                 end_safe_access_tls_vars();
584         }
585 }
586
587 /* Helper: loads a uthread's TLS on this vcore, if applicable.  If our uthreads
588  * do not have their own TLS, we simply switch the __vc_ctx, signalling that the
589  * context running here is (soon to be) a uthread. */
590 static void set_uthread_tls(struct uthread *uthread, uint32_t vcoreid)
591 {
592         if (__uthread_has_tls(uthread)) {
593                 set_tls_desc(uthread->tls_desc);
594                 begin_safe_access_tls_vars();
595                 __vcoreid = vcoreid;    /* setting the uthread's TLS var */
596                 end_safe_access_tls_vars();
597         } else {
598                 __vcore_context = FALSE;
599         }
600 }
601
602 /* Attempts to handle a fault for uth, etc */
603 static void handle_refl_fault(struct uthread *uth, struct user_context *ctx)
604 {
605         sched_ops->thread_refl_fault(uth, ctx);
606 }
607
608 /* 2LS helper: stops the current uthread, saves its state, and returns a pointer
609  * to it.  Unlike __uthread_pause, which is called by non-specific 2LS code,
610  * this function is called by a specific 2LS to stop it's current uthread. */
611 struct uthread *stop_current_uthread(void)
612 {
613         struct uthread *uth;
614         struct preempt_data *vcpd = vcpd_of(vcore_id());
615
616         uth = current_uthread;
617         current_uthread = 0;
618         if (!(uth->flags & UTHREAD_SAVED)) {
619                 uth->u_ctx = vcpd->uthread_ctx;
620                 uth->flags |= UTHREAD_SAVED;
621         }
622         if ((uth->u_ctx.type != ROS_SW_CTX) && !(uth->flags & UTHREAD_FPSAVED)) {
623                 save_fp_state(&uth->as);
624                 uth->flags |= UTHREAD_FPSAVED;
625         }
626         uth->state = UT_NOT_RUNNING;
627         return uth;
628 }
629
630 /* Run the thread that was current_uthread, from a previous run.  Should be
631  * called only when the uthread already was running, and we were interrupted by
632  * the kernel (event, etc).  Do not call this to run a fresh uthread, even if
633  * you've set it to be current. */
634 void __attribute__((noreturn)) run_current_uthread(void)
635 {
636         struct uthread *uth;
637         uint32_t vcoreid = vcore_id();
638         struct preempt_data *vcpd = vcpd_of(vcoreid);
639         assert(current_uthread);
640         assert(current_uthread->state == UT_RUNNING);
641         /* Uth was already running, should not have been saved */
642         assert(!(current_uthread->flags & UTHREAD_SAVED));
643         assert(!(current_uthread->flags & UTHREAD_FPSAVED));
644         printd("[U] Vcore %d is restarting uthread %08p\n", vcoreid,
645                current_uthread);
646         if (has_refl_fault(&vcpd->uthread_ctx)) {
647                 clear_refl_fault(&vcpd->uthread_ctx);
648                 /* we preemptively copy out and make non-running, so that there is a
649                  * consistent state for the handler.  it can then block the uth or
650                  * whatever. */
651                 uth = stop_current_uthread();
652                 handle_refl_fault(uth, &vcpd->uthread_ctx);
653                 /* we abort no matter what.  up to the 2LS to reschedule the thread */
654                 set_stack_pointer((void*)vcpd->vcore_stack);
655                 vcore_entry();
656         }
657         /* Go ahead and start the uthread */
658         set_uthread_tls(current_uthread, vcoreid);
659         /* Run, using the TF in the VCPD.  FP state should already be loaded */
660         pop_user_ctx(&vcpd->uthread_ctx, vcoreid);
661         assert(0);
662 }
663
664 /* Launches the uthread on the vcore.  Don't call this on current_uthread. 
665  *
666  * In previous versions of this, we used to check for events after setting
667  * current_uthread.  That is super-dangerous.  handle_events() doesn't always
668  * return (which we used to handle), and it may also clear current_uthread.  We
669  * needed to save uthread in current_uthread, in case we didn't return.  If we
670  * didn't return, the vcore started over at vcore_entry, with current set.  When
671  * this happens, we never actually had loaded cur_uth's FP and GP onto the core,
672  * so cur_uth fails.  Check out 4602599be for more info.
673  *
674  * Ultimately, handling events again in these 'popping helpers' isn't even
675  * necessary (we only must do it once for an entire time in VC ctx, and in
676  * loops), and might have been optimizing a rare event at a cost in both
677  * instructions and complexity. */
678 void __attribute__((noreturn)) run_uthread(struct uthread *uthread)
679 {
680         uint32_t vcoreid = vcore_id();
681         struct preempt_data *vcpd = vcpd_of(vcoreid);
682         assert(!current_uthread);
683         assert(uthread->state == UT_NOT_RUNNING);
684         assert(uthread->flags & UTHREAD_SAVED);
685         /* For HW/VM CTX, FPSAVED must match UTH SAVE (and both be on here).  For
686          * SW, FP should never be saved. */
687         switch (uthread->u_ctx.type) {
688         case ROS_HW_CTX:
689         case ROS_VM_CTX:
690                 assert(uthread->flags & UTHREAD_FPSAVED);
691                 break;
692         case ROS_SW_CTX:
693                 assert(!(uthread->flags & UTHREAD_FPSAVED));
694                 break;
695         }
696         if (has_refl_fault(&uthread->u_ctx)) {
697                 clear_refl_fault(&uthread->u_ctx);
698                 handle_refl_fault(uthread, &uthread->u_ctx);
699                 /* we abort no matter what.  up to the 2LS to reschedule the thread */
700                 set_stack_pointer((void*)vcpd->vcore_stack);
701                 vcore_entry();
702         }
703         uthread->state = UT_RUNNING;
704         /* Save a ptr to the uthread we'll run in the transition context's TLS */
705         current_uthread = uthread;
706         if (uthread->flags & UTHREAD_FPSAVED) {
707                 uthread->flags &= ~UTHREAD_FPSAVED;
708                 restore_fp_state(&uthread->as);
709         }
710         set_uthread_tls(uthread, vcoreid);
711         /* the uth's context will soon be in the cpu (or VCPD), no longer saved */
712         uthread->flags &= ~UTHREAD_SAVED;
713         pop_user_ctx(&uthread->u_ctx, vcoreid);
714         assert(0);
715 }
716
717 /* Runs the uthread, but doesn't care about notif pending.  Only call this when
718  * there was a DONT_MIGRATE uthread, or a similar situation where the uthread
719  * will check messages soon (like calling enable_notifs()). */
720 static void __run_current_uthread_raw(void)
721 {
722         uint32_t vcoreid = vcore_id();
723         struct preempt_data *vcpd = vcpd_of(vcoreid);
724         if (has_refl_fault(&vcpd->uthread_ctx)) {
725                 printf("Raw / DONT_MIGRATE uthread took a fault, exiting.\n");
726                 exit(-1);
727         }
728         /* We need to manually say we have a notif pending, so we eventually return
729          * to vcore context.  (note the kernel turned it off for us) */
730         vcpd->notif_pending = TRUE;
731         assert(!(current_uthread->flags & UTHREAD_SAVED));
732         assert(!(current_uthread->flags & UTHREAD_FPSAVED));
733         set_uthread_tls(current_uthread, vcoreid);
734         pop_user_ctx_raw(&vcpd->uthread_ctx, vcoreid);
735         assert(0);
736 }
737
738 /* Copies the uthread trapframe and silly state from the vcpd to the uthread,
739  * subject to the uthread's flags and whatnot.
740  *
741  * For example: The uthread state might still be in the uthread struct.  Imagine
742  * the 2LS decides to run a new uthread and sets it up as current, but doesn't
743  * actually run it yet.  The 2LS happened to voluntarily give up the VC (due to
744  * some other event) and then wanted to copy out the thread.  This is pretty
745  * rare - the normal case is when an IRQ of some sort hit the core and the
746  * kernel copied the running state into VCPD.
747  *
748  * The FP state could also be in VCPD (e.g. preemption being handled remotely),
749  * it could be in the uthread struct (e.g. hasn't started running yet) or even
750  * in the FPU (e.g. took an IRQ/notif and we're handling the preemption of
751  * another vcore).
752  *
753  * There are some cases where we'll have a uthread SW ctx that needs to be
754  * copied out: uth syscalls, notif happens, and the core comes back from the
755  * kernel in VC ctx.  VC ctx calls copy_out (response to preempt_pending or done
756  * while handling a preemption). */
757 static void copyout_uthread(struct preempt_data *vcpd, struct uthread *uthread,
758                             bool vcore_local)
759 {
760         assert(uthread);
761         if (uthread->flags & UTHREAD_SAVED) {
762                 /* I don't know of scenarios where HW/VM ctxs FP state differs from GP*/
763                 switch (uthread->u_ctx.type) {
764                 case ROS_HW_CTX:
765                 case ROS_VM_CTX:
766                         assert(uthread->flags & UTHREAD_FPSAVED);
767                 }
768                 assert(vcore_local);
769                 return;
770         }
771         /* If we're copying GP state, it must be in VCPD */
772         uthread->u_ctx = vcpd->uthread_ctx;
773         uthread->flags |= UTHREAD_SAVED;
774         printd("VC %d copying out uthread %08p\n", vcore_id(), uthread);
775         /* Software contexts do not need FP state, nor should we think it has any */
776         if (uthread->u_ctx.type == ROS_SW_CTX) {
777                 assert(!(uthread->flags & UTHREAD_FPSAVED));
778                 return;
779         }
780         /* HW contexts also should not have it saved either.  Should be either in
781          * the VCPD or the FPU.  Yes, this is the same assert. */
782         assert(!(uthread->flags & UTHREAD_FPSAVED));
783         /* When we're dealing with the uthread running on our own vcore, the FP
784          * state is in the actual FPU, not VCPD.  It might also be in VCPD, but it
785          * will always be in the FPU (the kernel maintains this for us, in the event
786          * we were preempted since the uthread was last running). */
787         if (vcore_local)
788                 save_fp_state(&uthread->as);
789         else
790                 uthread->as = vcpd->preempt_anc;
791         uthread->flags |= UTHREAD_FPSAVED;
792 }
793
794 /* Helper, packages up and pauses a uthread that was running on vcoreid.  Used
795  * by preemption handling (and detection) so far.  Careful using this, esp if
796  * it is on another vcore (need to make sure it's not running!).  If you are
797  * using it on the local vcore, set vcore_local = TRUE. */
798 static void __uthread_pause(struct preempt_data *vcpd, struct uthread *uthread,
799                             bool vcore_local)
800 {
801         assert(!(uthread->flags & UTHREAD_DONT_MIGRATE));
802         copyout_uthread(vcpd, uthread, vcore_local);
803         uthread->state = UT_NOT_RUNNING;
804         /* Call out to the 2LS to package up its uthread */
805         assert(sched_ops->thread_paused);
806         sched_ops->thread_paused(uthread);
807 }
808
809 /* Deals with a pending preemption (checks, responds).  If the 2LS registered a
810  * function, it will get run.  Returns true if you got preempted.  Called
811  * 'check' instead of 'handle', since this isn't an event handler.  It's the "Oh
812  * shit a preempt is on its way ASAP".
813  *
814  * Be careful calling this: you might not return, so don't call it if you can't
815  * handle that.  If you are calling this from an event handler, you'll need to
816  * do things like ev_might_not_return().  If the event can via an INDIR ev_q,
817  * that ev_q must be a NOTHROTTLE.
818  *
819  * Finally, don't call this from a place that might have a DONT_MIGRATE
820  * cur_uth.  This should be safe for most 2LS code. */
821 bool __check_preempt_pending(uint32_t vcoreid)
822 {
823         bool retval = FALSE;
824         assert(in_vcore_context());
825         if (__preempt_is_pending(vcoreid)) {
826                 retval = TRUE;
827                 if (sched_ops->preempt_pending)
828                         sched_ops->preempt_pending();
829                 /* If we still have a cur_uth, copy it out and hand it back to the 2LS
830                  * before yielding. */
831                 if (current_uthread) {
832                         __uthread_pause(vcpd_of(vcoreid), current_uthread, TRUE);
833                         current_uthread = 0;
834                 }
835                 /* vcore_yield tries to yield, and will pop back up if this was a spurious
836                  * preempt_pending or if it handled an event.  For now, we'll just keep
837                  * trying to yield so long as a preempt is coming in.  Eventually, we'll
838                  * handle all of our events and yield, or else the preemption will hit
839                  * and someone will recover us (at which point we'll break out of the
840                  * loop) */
841                 while (__procinfo.vcoremap[vcoreid].preempt_pending) {
842                         vcore_yield(TRUE);
843                         cpu_relax();
844                 }
845         }
846         return retval;
847 }
848
849 /* Helper: This is a safe way for code to disable notifs if it *might* be called
850  * from uthread context (like from a notif_safe lock).  Pair this with
851  * uth_enable_notifs() unless you know what you're doing. */
852 void uth_disable_notifs(void)
853 {
854         if (!in_vcore_context()) {
855                 assert(current_uthread);
856                 if (current_uthread->notif_disabled_depth++)
857                         goto out;
858                 current_uthread->flags |= UTHREAD_DONT_MIGRATE;
859                 cmb();  /* don't issue the flag write before the vcore_id() read */
860                 disable_notifs(vcore_id());
861         }
862 out:
863         assert(!notif_is_enabled(vcore_id()));
864 }
865
866 /* Helper: Pair this with uth_disable_notifs(). */
867 void uth_enable_notifs(void)
868 {
869         if (!in_vcore_context()) {
870                 assert(current_uthread);
871                 if (--current_uthread->notif_disabled_depth)
872                         return;
873                 current_uthread->flags &= ~UTHREAD_DONT_MIGRATE;
874                 cmb();  /* don't enable before ~DONT_MIGRATE */
875                 enable_notifs(vcore_id());
876         }
877 }
878
879 /* Helper: returns TRUE if it succeeded in starting the uth stealing process. */
880 static bool start_uth_stealing(struct preempt_data *vcpd)
881 {
882         long old_flags;
883         do {
884                 old_flags = atomic_read(&vcpd->flags);
885                 /* Spin if the kernel is mucking with the flags */
886                 while (old_flags & VC_K_LOCK)
887                         old_flags = atomic_read(&vcpd->flags);
888                 /* Someone else is stealing, we failed */
889                 if (old_flags & VC_UTHREAD_STEALING)
890                         return FALSE;
891         } while (!atomic_cas(&vcpd->flags, old_flags,
892                              old_flags | VC_UTHREAD_STEALING));
893         return TRUE;
894 }
895
896 /* Helper: pairs with stop_uth_stealing */
897 static void stop_uth_stealing(struct preempt_data *vcpd)
898 {
899         long old_flags;
900         do {
901                 old_flags = atomic_read(&vcpd->flags);
902                 assert(old_flags & VC_UTHREAD_STEALING);        /* sanity */
903                 while (old_flags & VC_K_LOCK)
904                         old_flags = atomic_read(&vcpd->flags);
905         } while (!atomic_cas(&vcpd->flags, old_flags,
906                              old_flags & ~VC_UTHREAD_STEALING));
907 }
908
909 /* Handles INDIRS for another core (the public mbox).  We synchronize with the
910  * kernel (__set_curtf_to_vcoreid). */
911 static void handle_indirs(uint32_t rem_vcoreid)
912 {
913         long old_flags;
914         struct preempt_data *rem_vcpd = vcpd_of(rem_vcoreid);
915         /* Turn off their message reception if they are still preempted.  If they
916          * are no longer preempted, we do nothing - they will handle their own
917          * messages.  Turning off CAN_RCV will route this vcore's messages to
918          * fallback vcores (if those messages were 'spammed'). */
919         do {
920                 old_flags = atomic_read(&rem_vcpd->flags);
921                 while (old_flags & VC_K_LOCK)
922                         old_flags = atomic_read(&rem_vcpd->flags);
923                 if (!(old_flags & VC_PREEMPTED))
924                         return;
925         } while (!atomic_cas(&rem_vcpd->flags, old_flags,
926                              old_flags & ~VC_CAN_RCV_MSG));
927         wrmb(); /* don't let the CAN_RCV write pass reads of the mbox status */
928         /* handle all INDIRs of the remote vcore */
929         handle_vcpd_mbox(rem_vcoreid);
930 }
931
932 /* Helper.  Will ensure a good attempt at changing vcores, meaning we try again
933  * if we failed for some reason other than the vcore was already running. */
934 static void __change_vcore(uint32_t rem_vcoreid, bool enable_my_notif)
935 {
936         /* okay to do a normal spin/relax here, even though we are in vcore
937          * context. */
938         while (-EAGAIN == sys_change_vcore(rem_vcoreid, enable_my_notif))
939                 cpu_relax();
940 }
941
942 /* Helper, used in preemption recovery.  When you can freely leave vcore
943  * context and need to change to another vcore, call this.  vcpd is the caller,
944  * rem_vcoreid is the remote vcore.  This will try to package up your uthread.
945  * It may return, either because the other core already started up (someone else
946  * got it), or in some very rare cases where we had to stay in our vcore
947  * context */
948 static void change_to_vcore(struct preempt_data *vcpd, uint32_t rem_vcoreid)
949 {
950         bool were_handling_remotes;
951         /* Unlikely, but if we have no uthread we can just change.  This is the
952          * check, sync, then really check pattern: we can only really be sure about
953          * current_uthread after we check STEALING. */
954         if (!current_uthread) {
955                 /* there might be an issue with doing this while someone is recovering.
956                  * once they 0'd it, we should be good to yield.  just a bit dangerous.
957                  * */
958                 were_handling_remotes = ev_might_not_return();
959                 __change_vcore(rem_vcoreid, TRUE);      /* noreturn on success */
960                 goto out_we_returned;
961         }
962         /* Note that the reason we need to check STEALING is because we can get into
963          * vcore context and slip past that check in vcore_entry when we are
964          * handling a preemption message.  Anytime preemption recovery cares about
965          * the calling vcore's cur_uth, it needs to be careful about STEALING.  But
966          * it is safe to do the check up above (if it's 0, it won't concurrently
967          * become non-zero).
968          *
969          * STEALING might be turned on at any time.  Whoever turns it on will do
970          * nothing if we are online or were in vc_ctx.  So if it is on, we can't
971          * touch current_uthread til it is turned off (not sure what state they saw
972          * us in).  We could spin here til they unset STEALING (since they will
973          * soon), but there is a chance they were preempted, so we need to make
974          * progress by doing a sys_change_vcore(). */
975         /* Crap, someone is stealing (unlikely).  All we can do is change. */
976         if (atomic_read(&vcpd->flags) & VC_UTHREAD_STEALING) {
977                 __change_vcore(rem_vcoreid, FALSE);     /* returns on success */
978                 return;
979         }
980         cmb();
981         /* Need to recheck, in case someone stole it and finished before we checked
982          * VC_UTHREAD_STEALING. */
983         if (!current_uthread) {
984                 were_handling_remotes = ev_might_not_return();
985                 __change_vcore(rem_vcoreid, TRUE);      /* noreturn on success */
986                 goto out_we_returned;
987         }
988         /* Need to make sure we don't have a DONT_MIGRATE (very rare, someone would
989          * have to steal from us to get us to handle a preempt message, and then had
990          * to finish stealing (and fail) fast enough for us to miss the previous
991          * check). */
992         if (current_uthread->flags & UTHREAD_DONT_MIGRATE) {
993                 __change_vcore(rem_vcoreid, FALSE);     /* returns on success */
994                 return;
995         }
996         /* Now save our uthread and restart them */
997         assert(current_uthread);
998         __uthread_pause(vcpd, current_uthread, TRUE);
999         current_uthread = 0;
1000         were_handling_remotes = ev_might_not_return();
1001         __change_vcore(rem_vcoreid, TRUE);              /* noreturn on success */
1002         /* Fall-through to out_we_returned */
1003 out_we_returned:
1004         ev_we_returned(were_handling_remotes);
1005 }
1006
1007 /* This handles a preemption message.  When this is done, either we recovered,
1008  * or recovery *for our message* isn't needed. */
1009 static void handle_vc_preempt(struct event_msg *ev_msg, unsigned int ev_type,
1010                               void *data)
1011 {
1012         uint32_t vcoreid = vcore_id();
1013         struct preempt_data *vcpd = vcpd_of(vcoreid);
1014         uint32_t rem_vcoreid = ev_msg->ev_arg2;
1015         struct preempt_data *rem_vcpd = vcpd_of(rem_vcoreid);
1016         struct uthread *uthread_to_steal = 0;
1017         struct uthread **rem_cur_uth;
1018         bool cant_migrate = FALSE;
1019
1020         assert(in_vcore_context());
1021         /* Just drop messages about ourselves.  They are old.  If we happen to be
1022          * getting preempted right now, there's another message out there about
1023          * that. */
1024         if (rem_vcoreid == vcoreid)
1025                 return;
1026         printd("Vcore %d was preempted (i'm %d), it's flags %08p!\n",
1027                ev_msg->ev_arg2, vcoreid, rem_vcpd->flags);
1028         /* Spin til the kernel is done with flags.  This is how we avoid handling
1029          * the preempt message before the preemption. */
1030         while (atomic_read(&rem_vcpd->flags) & VC_K_LOCK)
1031                 cpu_relax();
1032         /* If they aren't preempted anymore, just return (optimization). */
1033         if (!(atomic_read(&rem_vcpd->flags) & VC_PREEMPTED))
1034                 return;
1035         /* At this point, we need to try to recover */
1036         /* This case handles when the remote core was in vcore context */
1037         if (rem_vcpd->notif_disabled) {
1038                 printd("VC %d recovering %d, notifs were disabled\n", vcoreid,
1039                        rem_vcoreid);
1040                 change_to_vcore(vcpd, rem_vcoreid);
1041                 return; /* in case it returns.  we've done our job recovering */
1042         }
1043         /* So now it looks like they were not in vcore context.  We want to steal
1044          * the uthread.  Set stealing, then doublecheck everything.  If stealing
1045          * fails, someone else is stealing and we can just leave.  That other vcore
1046          * who is stealing will check the VCPD/INDIRs when it is done. */
1047         if (!start_uth_stealing(rem_vcpd))
1048                 return;
1049         /* Now we're stealing.  Double check everything.  A change in preempt status
1050          * or notif_disable status means the vcore has since restarted.  The vcore
1051          * may or may not have started after we set STEALING.  If it didn't, we'll
1052          * need to bail out (but still check messages, since above we assumed the
1053          * uthread stealer handles the VCPD/INDIRs).  Since the vcore is running, we
1054          * don't need to worry about handling the message any further.  Future
1055          * preemptions will generate another message, so we can ignore getting the
1056          * uthread or anything like that. */
1057         printd("VC %d recovering %d, trying to steal uthread\n", vcoreid,
1058                rem_vcoreid);
1059         if (!(atomic_read(&rem_vcpd->flags) & VC_PREEMPTED))
1060                 goto out_stealing;
1061         /* Might be preempted twice quickly, and the second time had notifs
1062          * disabled.
1063          *
1064          * Also note that the second preemption event had another
1065          * message sent, which either we or someone else will deal with.  And also,
1066          * we don't need to worry about how we are stealing still and plan to
1067          * abort.  If another vcore handles that second preemption message, either
1068          * the original vcore is in vc ctx or not.  If so, we bail out and the
1069          * second preemption handling needs to change_to.  If not, we aren't
1070          * bailing out, and we'll handle the preemption as normal, and the second
1071          * handler will bail when it fails to steal. */
1072         if (rem_vcpd->notif_disabled)
1073                 goto out_stealing;
1074         /* At this point, we're clear to try and steal the uthread.  We used to
1075          * switch to their TLS to steal the uthread, but we can access their
1076          * current_uthread directly. */
1077         rem_cur_uth = get_tlsvar_linaddr(rem_vcoreid, current_uthread);
1078         uthread_to_steal = *rem_cur_uth;
1079         if (uthread_to_steal) {
1080                 /* Extremely rare: they have a uthread, but it can't migrate.  So we'll
1081                  * need to change to them. */
1082                 if (uthread_to_steal->flags & UTHREAD_DONT_MIGRATE) {
1083                         printd("VC %d recovering %d, can't migrate uthread!\n", vcoreid,
1084                                rem_vcoreid);
1085                         stop_uth_stealing(rem_vcpd);
1086                         change_to_vcore(vcpd, rem_vcoreid);
1087                         return; /* in case it returns.  we've done our job recovering */
1088                 } else {
1089                         *rem_cur_uth = 0;
1090                         /* we're clear to steal it */
1091                         printd("VC %d recovering %d, uthread %08p stolen\n", vcoreid,
1092                                rem_vcoreid, uthread_to_steal);
1093                         __uthread_pause(rem_vcpd, uthread_to_steal, FALSE);
1094                         /* can't let the cur_uth = 0 write and any writes from __uth_pause()
1095                          * to pass stop_uth_stealing. */
1096                         wmb();
1097                 }
1098         }
1099         /* Fallthrough */
1100 out_stealing:
1101         stop_uth_stealing(rem_vcpd);
1102         handle_indirs(rem_vcoreid);
1103 }
1104
1105 /* This handles a "check indirs" message.  When this is done, either we checked
1106  * their indirs, or the vcore restarted enough so that checking them is
1107  * unnecessary.  If that happens and they got preempted quickly, then another
1108  * preempt/check_indirs was sent out. */
1109 static void handle_vc_indir(struct event_msg *ev_msg, unsigned int ev_type,
1110                             void *data)
1111 {
1112         uint32_t vcoreid = vcore_id();
1113         uint32_t rem_vcoreid = ev_msg->ev_arg2;
1114
1115         if (rem_vcoreid == vcoreid)
1116                 return;
1117         handle_indirs(rem_vcoreid);
1118 }
1119
1120 static inline bool __uthread_has_tls(struct uthread *uthread)
1121 {
1122         return uthread->tls_desc != UTH_TLSDESC_NOTLS;
1123 }
1124
1125 /* TLS helpers */
1126 static int __uthread_allocate_tls(struct uthread *uthread)
1127 {
1128         assert(!uthread->tls_desc);
1129         uthread->tls_desc = allocate_tls();
1130         if (!uthread->tls_desc) {
1131                 errno = ENOMEM;
1132                 return -1;
1133         }
1134         return 0;
1135 }
1136
1137 static int __uthread_reinit_tls(struct uthread *uthread)
1138 {
1139         uthread->tls_desc = reinit_tls(uthread->tls_desc);
1140         if (!uthread->tls_desc) {
1141                 errno = ENOMEM;
1142                 return -1;
1143         }
1144         return 0;
1145 }
1146
1147 static void __uthread_free_tls(struct uthread *uthread)
1148 {
1149         free_tls(uthread->tls_desc);
1150         uthread->tls_desc = NULL;
1151 }