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