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