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