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