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