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