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