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