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