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