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