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