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