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