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