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