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