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