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