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