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