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