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