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