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