pthread_test() and supporting changes
[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 initializes once */
66         static bool initialized = FALSE;
67         if (initialized)
68                 return 0;
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 /* TODO: dumb helper, put it in glibc or something */
114 static void handle_posix_signal(struct event_msg *ev_msg, unsigned int ev_type)
115 {
116         int sig_nr;
117         assert(ev_msg);
118         sig_nr = ev_msg->ev_arg1;
119         printf("Received POSIX signal number %d\n", sig_nr);
120 }
121
122 /* Slim-init - sets up basic uthreading for when we are in _S mode and before
123  * we set up the 2LS.  Some apps may not have a 2LS and thus never do the full
124  * vcore/2LS/uthread init. */
125 void uthread_slim_init(void)
126 {
127         struct uthread *uthread = malloc(sizeof(*uthread));
128         struct event_queue *posix_sig_ev_q;
129         /* TODO: consider a vcore_init_vc0 call.  Init the vcore system */
130         assert(!vcore_init());
131         uthread_manage_thread0(uthread);
132         scp_vcctx_ready();
133         /* Register an ev_q for posix signals */
134         /* TODO: probably put this handler in glibc */
135         ev_handlers[EV_POSIX_SIGNAL] = handle_posix_signal;
136         posix_sig_ev_q = get_big_event_q();
137         assert(posix_sig_ev_q);
138         posix_sig_ev_q->ev_flags = EVENT_IPI | EVENT_INDIR | EVENT_FALLBACK;
139         register_kevent_q(posix_sig_ev_q, EV_POSIX_SIGNAL);
140         /* change our blockon from glibc's internal one to the mcp one (which can
141          * handle SCPs too).  we must do this before switching to _M, or at least
142          * before blocking while an _M.  it's harmless (and probably saner) to do it
143          * earlier, so we do it as early as possible. */
144         ros_syscall_blockon = __ros_mcp_syscall_blockon;
145 }
146
147 /* 2LSs shouldn't call uthread_vcore_entry directly */
148 void __attribute__((noreturn)) uthread_vcore_entry(void)
149 {
150         uint32_t vcoreid = vcore_id();
151         struct preempt_data *vcpd = vcpd_of(vcoreid);
152         /* Should always have notifications disabled when coming in here. */
153         assert(!notif_is_enabled(vcoreid));
154         assert(in_vcore_context());
155         /* If someone is stealing our uthread (from when we were preempted before),
156          * we can't touch our uthread.  But we might be the last vcore around, so
157          * we'll handle preemption events (spammed to our public mbox).
158          *
159          * It's important that we only check/handle one message per loop, otherwise
160          * we could get stuck in a ping-pong scenario with a recoverer (maybe). */
161         while (atomic_read(&vcpd->flags) & VC_UTHREAD_STEALING) {
162                 /* Note we're handling INDIRs and other public messages while someone
163                  * is stealing our uthread.  Remember that those event handlers cannot
164                  * touch cur_uth, as it is "vcore business". */
165                 handle_one_mbox_msg(&vcpd->ev_mbox_public);
166                 cpu_relax();
167         }
168         /* If we have a current uthread that is DONT_MIGRATE, pop it real quick and
169          * let it disable notifs (like it wants to).  Other than dealing with
170          * preemption events (or other INDIRs), we shouldn't do anything in vc_ctx
171          * when we have a DONT_MIGRATE uthread. */
172         if (current_uthread && (current_uthread->flags & UTHREAD_DONT_MIGRATE))
173                 __run_current_uthread_raw();
174         /* Check and see if we wanted ourselves to handle a remote VCPD mbox.  Want
175          * to do this after we've handled STEALING and DONT_MIGRATE. */
176         try_handle_remote_mbox();
177         /* Otherwise, go about our usual vcore business (messages, etc). */
178         handle_events(vcoreid);
179         __check_preempt_pending(vcoreid);
180         assert(in_vcore_context());     /* double check, in case an event changed it */
181         /* Consider using the default_2ls_op for this, though it's a bit weird. */
182         if (sched_ops->sched_entry) {
183                 sched_ops->sched_entry();
184         } else if (current_uthread) {
185                 run_current_uthread();
186         }
187         /* 2LS sched_entry should never return */
188         /* Either the 2LS sched_entry returned, run_cur_uth() returned, or we
189          * didn't have a current_uthread.  If we didn't have a 2LS op, we should be
190          * in _S mode and always have a current_uthread. */
191         assert(0);
192 }
193
194 /* Does the uthread initialization of a uthread that the caller created.  Call
195  * this whenever you are "starting over" with a thread. */
196 void uthread_init(struct uthread *new_thread)
197 {
198         assert(new_thread);
199         new_thread->state = UT_NOT_RUNNING;
200         /* They should have zero'd the uthread.  Let's check critical things: */
201         assert(!new_thread->flags && !new_thread->sysc);
202         /* the utf/as holds the context of the uthread (set by the 2LS earlier) */
203         new_thread->flags |= UTHREAD_SAVED | UTHREAD_FPSAVED;
204         /* Get a TLS.  If we already have one, reallocate/refresh it */
205         if (new_thread->tls_desc)
206                 assert(!__uthread_reinit_tls(new_thread));
207         else
208                 assert(!__uthread_allocate_tls(new_thread));
209         uthread_set_tls_var(new_thread, current_uthread, new_thread);
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         __vcoreid = vcoreid;    /* setting the uthread's TLS var */
412         /* Depending on where it was saved, we pop differently.  This assumes that
413          * if a uthread was not saved, that it was running in the vcpd notif tf.
414          * There should never be a time that the TF is unsaved and not in the notif
415          * TF (or about to be in that TF). */
416         if (uthread->flags & UTHREAD_SAVED) {
417                 uthread->flags &= ~UTHREAD_SAVED;
418                 pop_ros_tf(&uthread->utf, vcoreid);
419         } else  {
420                 pop_ros_tf(&vcpd->notif_tf, vcoreid);
421         }
422 }
423
424 /* Simply sets current uthread to be whatever the value of uthread is.  This
425  * can be called from outside of sched_entry() to highjack the current context,
426  * and make sure that the new uthread struct is used to store this context upon
427  * yielding, etc. USE WITH EXTREME CAUTION! */
428 void highjack_current_uthread(struct uthread *uthread)
429 {
430         uint32_t vcoreid = vcore_id();
431         assert(uthread != current_uthread);
432         assert(uthread->tls_desc);
433         current_uthread->state = UT_NOT_RUNNING;
434         uthread->state = UT_RUNNING;
435         vcore_set_tls_var(current_uthread, uthread);
436         set_tls_desc(uthread->tls_desc, vcoreid);
437         __vcoreid = vcoreid;    /* setting the uthread's TLS var */
438 }
439
440 /* Runs whatever thread is vcore's current_uthread.  This is nothing but a
441  * couple checks, then the real run_cur_uth. */
442 void run_current_uthread(void)
443 {
444         uint32_t vcoreid = vcore_id();
445         struct preempt_data *vcpd = vcpd_of(vcoreid);
446         assert(current_uthread);
447         assert(current_uthread->state == UT_RUNNING);
448         printd("[U] Vcore %d is restarting uthread %08p\n", vcoreid,
449                current_uthread);
450         /* Run, using the TF in the VCPD.  FP state should already be loaded */
451         __run_cur_uthread();
452         assert(0);
453 }
454
455 /* Launches the uthread on the vcore.  Don't call this on current_uthread.  All
456  * this does is set up uthread as cur_uth, check for bugs, and then runs the
457  * real run_cur_uth. */
458 void run_uthread(struct uthread *uthread)
459 {
460         assert(uthread != current_uthread);
461         if (uthread->state != UT_NOT_RUNNING) {
462                 /* had vcore3 throw this, when the UT blocked on vcore1 and didn't come
463                  * back up yet (kernel didn't wake up, didn't send IPI) */
464                 printf("Uth %08p not runnable (was %d) in run_uthread on vcore %d!\n",
465                        uthread, uthread->state, vcore_id());
466         }
467         assert(uthread->state == UT_NOT_RUNNING);
468         uthread->state = UT_RUNNING;
469         /* Save a ptr to the uthread we'll run in the transition context's TLS */
470         current_uthread = uthread;
471         __run_cur_uthread();
472         assert(0);
473 }
474
475 /* Runs the uthread, but doesn't care about notif pending.  Only call this when
476  * there was a DONT_MIGRATE uthread, or a similar situation where the uthread
477  * will check messages soon (like calling enable_notifs()). */
478 static void __run_current_uthread_raw(void)
479 {
480         uint32_t vcoreid = vcore_id();
481         struct preempt_data *vcpd = vcpd_of(vcoreid);
482         /* We need to manually say we have a notif pending, so we eventually return
483          * to vcore context.  (note the kernel turned it off for us) */
484         vcpd->notif_pending = TRUE;
485         /* utf no longer represents the current state of the uthread */
486         current_uthread->flags &= ~UTHREAD_SAVED;
487         set_tls_desc(current_uthread->tls_desc, vcoreid);
488         __vcoreid = vcoreid;    /* setting the uthread's TLS var */
489         /* Pop the user trap frame */
490         pop_ros_tf_raw(&vcpd->notif_tf, vcoreid);
491         assert(0);
492 }
493
494 /* Copies the uthread trapframe and silly state from the vcpd to the uthread,
495  * subject to the uthread's flags.  Might have other uses in the future, but
496  * for now our only user is the helper __uthread_pause. */
497 static void copyout_uthread(struct preempt_data *vcpd, struct uthread *uthread)
498 {
499         assert(uthread);
500         /* Copy out the main tf if we need to */
501         if (!(uthread->flags & UTHREAD_SAVED)) {
502                 uthread->utf = vcpd->notif_tf;
503                 uthread->flags |= UTHREAD_SAVED;
504                 printd("VC %d copying out uthread %08p\n", vcore_id(), uthread);
505         }
506         /* could optimize here in case the FP/silly state wasn't being used.
507          * Depends how we use the FPSAVED flag.  It means that the uthread's FP
508          * state is not currently saved, for whatever reason, so we'll do it. */
509         if (!(uthread->flags & UTHREAD_FPSAVED)) {
510                 /* TODO: (HSS) handle FP state: review this when fixing the other HSS */
511                 uthread->as = vcpd->preempt_anc;
512                 uthread->flags |= UTHREAD_FPSAVED;
513         }
514 }
515
516 /* Helper, packages up and pauses a uthread that was running on vcoreid.  Used
517  * by preemption handling (and detection) so far.  Careful using this, esp if
518  * it is on another vcore (need to make sure it's not running!). */
519 static void __uthread_pause(struct preempt_data *vcpd, struct uthread *uthread)
520 {
521         assert(!(uthread->flags & UTHREAD_DONT_MIGRATE));
522         copyout_uthread(vcpd, uthread);
523         uthread->state = UT_NOT_RUNNING;
524         /* Call out to the 2LS to package up its uthread */
525         assert(sched_ops->thread_paused);
526         sched_ops->thread_paused(uthread);
527 }
528
529 /* Deals with a pending preemption (checks, responds).  If the 2LS registered a
530  * function, it will get run.  Returns true if you got preempted.  Called
531  * 'check' instead of 'handle', since this isn't an event handler.  It's the "Oh
532  * shit a preempt is on its way ASAP".
533  *
534  * Be careful calling this: you might not return, so don't call it if you can't
535  * handle that.  If you are calling this from an event handler, you'll need to
536  * do things like ev_might_not_return().  If the event can via an INDIR ev_q,
537  * that ev_q must be a NOTHROTTLE.
538  *
539  * Finally, don't call this from a place that might have a DONT_MIGRATE
540  * cur_uth.  This should be safe for most 2LS code. */
541 bool __check_preempt_pending(uint32_t vcoreid)
542 {
543         bool retval = FALSE;
544         assert(in_vcore_context());
545         if (__preempt_is_pending(vcoreid)) {
546                 retval = TRUE;
547                 if (sched_ops->preempt_pending)
548                         sched_ops->preempt_pending();
549                 /* If we still have a cur_uth, copy it out and hand it back to the 2LS
550                  * before yielding. */
551                 if (current_uthread) {
552                         __uthread_pause(vcpd_of(vcoreid), current_uthread);
553                         current_uthread = 0;
554                 }
555                 /* vcore_yield tries to yield, and will pop back up if this was a spurious
556                  * preempt_pending or if it handled an event.  For now, we'll just keep
557                  * trying to yield so long as a preempt is coming in.  Eventually, we'll
558                  * handle all of our events and yield, or else the preemption will hit
559                  * and someone will recover us (at which point we'll break out of the
560                  * loop) */
561                 while (__procinfo.vcoremap[vcoreid].preempt_pending) {
562                         vcore_yield(TRUE);
563                         cpu_relax();
564                 }
565         }
566         return retval;
567 }
568
569 /* Helper: This is a safe way for code to disable notifs if it *might* be called
570  * from uthread context (like from a notif_safe lock).  Pair this with
571  * uth_enable_notifs() unless you know what you're doing. */
572 void uth_disable_notifs(void)
573 {
574         if (!in_vcore_context() && in_multi_mode()) {
575                 if (current_uthread)
576                         current_uthread->flags |= UTHREAD_DONT_MIGRATE;
577                 cmb();  /* don't issue the flag write before the vcore_id() read */
578                 disable_notifs(vcore_id());
579         }
580 }
581
582 /* Helper: Pair this with uth_disable_notifs(). */
583 void uth_enable_notifs(void)
584 {
585         if (!in_vcore_context() && in_multi_mode()) {
586                 if (current_uthread)
587                         current_uthread->flags &= ~UTHREAD_DONT_MIGRATE;
588                 cmb();  /* don't enable before ~DONT_MIGRATE */
589                 enable_notifs(vcore_id());
590         }
591 }
592
593 /* Helper: returns TRUE if it succeeded in starting the uth stealing process. */
594 static bool start_uth_stealing(struct preempt_data *vcpd)
595 {
596         long old_flags;
597         /* Might not need to bother with the K_LOCK, we aren't talking to the kernel
598          * in these two helpers. */
599         do {
600                 old_flags = atomic_read(&vcpd->flags);
601                 /* Spin if the kernel is mucking with the flags */
602                 while (old_flags & VC_K_LOCK)
603                         old_flags = atomic_read(&vcpd->flags);
604                 /* Someone else is stealing, we failed */
605                 if (old_flags & VC_UTHREAD_STEALING)
606                         return FALSE;
607         } while (!atomic_cas(&vcpd->flags, old_flags,
608                              old_flags | VC_UTHREAD_STEALING));
609         return TRUE;
610 }
611
612 /* Helper: pairs with stop_uth_stealing */
613 static void stop_uth_stealing(struct preempt_data *vcpd)
614 {
615         long old_flags;
616         do {
617                 old_flags = atomic_read(&vcpd->flags);
618                 assert(old_flags & VC_UTHREAD_STEALING);        /* sanity */
619                 while (old_flags & VC_K_LOCK)
620                         old_flags = atomic_read(&vcpd->flags);
621         } while (!atomic_cas(&vcpd->flags, old_flags,
622                              old_flags & ~VC_UTHREAD_STEALING));
623 }
624
625 /* Handles INDIRS for another core (the public mbox).  We synchronize with the
626  * kernel (__set_curtf_to_vcoreid). */
627 static void handle_indirs(uint32_t rem_vcoreid)
628 {
629         long old_flags;
630         struct preempt_data *rem_vcpd = vcpd_of(rem_vcoreid);
631         /* Turn off their message reception if they are still preempted.  If they
632          * are no longer preempted, we do nothing - they will handle their own
633          * messages.  Turning on CAN_RCV will route this vcore's messages to
634          * fallback vcores (if applicable). */
635         do {
636                 old_flags = atomic_read(&rem_vcpd->flags);
637                 while (old_flags & VC_K_LOCK)
638                         old_flags = atomic_read(&rem_vcpd->flags);
639                 if (!(old_flags & VC_PREEMPTED))
640                         return;
641         } while (!atomic_cas(&rem_vcpd->flags, old_flags,
642                              old_flags & ~VC_CAN_RCV_MSG));
643         wrmb(); /* don't let the CAN_RCV write pass reads of the mbox status */
644         /* handle all INDIRs of the remote vcore */
645         handle_vcpd_mbox(rem_vcoreid);
646 }
647
648 /* Helper.  Will ensure a good attempt at changing vcores, meaning we try again
649  * if we failed for some reason other than the vcore was already running. */
650 static void __change_vcore(uint32_t rem_vcoreid, bool enable_my_notif)
651 {
652         /* okay to do a normal spin/relax here, even though we are in vcore
653          * context. */
654         while (-EAGAIN == sys_change_vcore(rem_vcoreid, enable_my_notif))
655                 cpu_relax();
656 }
657
658 /* Helper, used in preemption recovery.  When you can freely leave vcore
659  * context and need to change to another vcore, call this.  vcpd is the caller,
660  * rem_vcoreid is the remote vcore.  This will try to package up your uthread.
661  * It may return, either because the other core already started up (someone else
662  * got it), or in some very rare cases where we had to stay in our vcore
663  * context */
664 static void change_to_vcore(struct preempt_data *vcpd, uint32_t rem_vcoreid)
665 {
666         bool were_handling_remotes;
667         /* Unlikely, but if we have no uthread we can just change.  This is the
668          * check, sync, then really check pattern: we can only really be sure about
669          * current_uthread after we check STEALING. */
670         if (!current_uthread) {
671                 /* there might be an issue with doing this while someone is recovering.
672                  * once they 0'd it, we should be good to yield.  just a bit dangerous.
673                  * */
674                 were_handling_remotes = ev_might_not_return();
675                 __change_vcore(rem_vcoreid, TRUE);      /* noreturn on success */
676                 goto out_we_returned;
677         }
678         /* Note that the reason we need to check STEALING is because we can get into
679          * vcore context and slip past that check in vcore_entry when we are
680          * handling a preemption message.  Anytime preemption recovery cares about
681          * the calling vcore's cur_uth, it needs to be careful about STEALING.  But
682          * it is safe to do the check up above (if it's 0, it won't concurrently
683          * become non-zero).
684          *
685          * STEALING might be turned on at any time.  Whoever turns it on will do
686          * nothing if we are online or were in vc_ctx.  So if it is on, we can't
687          * touch current_uthread til it is turned off (not sure what state they saw
688          * us in).  We could spin here til they unset STEALING (since they will
689          * soon), but there is a chance they were preempted, so we need to make
690          * progress by doing a sys_change_vcore(). */
691         /* Crap, someone is stealing (unlikely).  All we can do is change. */
692         if (atomic_read(&vcpd->flags) & VC_UTHREAD_STEALING) {
693                 __change_vcore(rem_vcoreid, FALSE);     /* returns on success */
694                 return;
695         }
696         cmb();
697         /* Need to recheck, in case someone stole it and finished before we checked
698          * VC_UTHREAD_STEALING. */
699         if (!current_uthread) {
700                 were_handling_remotes = ev_might_not_return();
701                 __change_vcore(rem_vcoreid, TRUE);      /* noreturn on success */
702                 goto out_we_returned;
703         }
704         /* Need to make sure we don't have a DONT_MIGRATE (very rare, someone would
705          * have to steal from us to get us to handle a preempt message, and then had
706          * to finish stealing (and fail) fast enough for us to miss the previous
707          * check). */
708         if (current_uthread->flags & UTHREAD_DONT_MIGRATE) {
709                 __change_vcore(rem_vcoreid, FALSE);     /* returns on success */
710                 return;
711         }
712         /* Now save our uthread and restart them */
713         assert(current_uthread);
714         __uthread_pause(vcpd, current_uthread);
715         current_uthread = 0;
716         were_handling_remotes = ev_might_not_return();
717         __change_vcore(rem_vcoreid, TRUE);              /* noreturn on success */
718         /* Fall-through to out_we_returned */
719 out_we_returned:
720         ev_we_returned(were_handling_remotes);
721 }
722
723 /* This handles a preemption message.  When this is done, either we recovered,
724  * or recovery *for our message* isn't needed. */
725 static void handle_vc_preempt(struct event_msg *ev_msg, unsigned int ev_type)
726 {
727         uint32_t vcoreid = vcore_id();
728         struct preempt_data *vcpd = vcpd_of(vcoreid);
729         uint32_t rem_vcoreid = ev_msg->ev_arg2;
730         struct preempt_data *rem_vcpd = vcpd_of(rem_vcoreid);
731         extern void **vcore_thread_control_blocks;
732         struct uthread *uthread_to_steal = 0;
733         bool cant_migrate = FALSE;
734
735         assert(in_vcore_context());
736         /* Just drop messages about ourselves.  They are old.  If we happen to be
737          * getting preempted right now, there's another message out there about
738          * that. */
739         if (rem_vcoreid == vcoreid)
740                 return;
741         printd("Vcore %d was preempted (i'm %d), it's flags %08p!\n",
742                ev_msg->ev_arg2, vcoreid, rem_vcpd->flags);
743         /* Spin til the kernel is done with flags.  This is how we avoid handling
744          * the preempt message before the preemption. */
745         while (atomic_read(&rem_vcpd->flags) & VC_K_LOCK)
746                 cpu_relax();
747         /* If they aren't preempted anymore, just return (optimization). */
748         if (!(atomic_read(&rem_vcpd->flags) & VC_PREEMPTED))
749                 return;
750         /* At this point, we need to try to recover */
751         /* This case handles when the remote core was in vcore context */
752         if (rem_vcpd->notif_disabled) {
753                 printd("VC %d recovering %d, notifs were disabled\n", vcoreid, rem_vcoreid);
754                 change_to_vcore(vcpd, rem_vcoreid);
755                 return; /* in case it returns.  we've done our job recovering */
756         }
757         /* So now it looks like they were not in vcore context.  We want to steal
758          * the uthread.  Set stealing, then doublecheck everything.  If stealing
759          * fails, someone else is stealing and we can just leave.  That other vcore
760          * who is stealing will check the VCPD/INDIRs when it is done. */
761         if (!start_uth_stealing(rem_vcpd))
762                 return;
763         /* Now we're stealing.  Double check everything.  A change in preempt status
764          * or notif_disable status means the vcore has since restarted.  The vcore
765          * may or may not have started after we set STEALING.  If it didn't, we'll
766          * need to bail out (but still check messages, since above we assumed the
767          * uthread stealer handles the VCPD/INDIRs).  Since the vcore is running, we
768          * don't need to worry about handling the message any further.  Future
769          * preemptions will generate another message, so we can ignore getting the
770          * uthread or anything like that. */
771         printd("VC %d recovering %d, trying to steal uthread\n", vcoreid, rem_vcoreid);
772         if (!(atomic_read(&rem_vcpd->flags) & VC_PREEMPTED))
773                 goto out_stealing;
774         /* Might be preempted twice quickly, and the second time had notifs
775          * disabled.
776          *
777          * Also note that the second preemption event had another
778          * message sent, which either we or someone else will deal with.  And also,
779          * we don't need to worry about how we are stealing still and plan to
780          * abort.  If another vcore handles that second preemption message, either
781          * the original vcore is in vc ctx or not.  If so, we bail out and the
782          * second preemption handling needs to change_to.  If not, we aren't
783          * bailing out, and we'll handle the preemption as normal, and the second
784          * handler will bail when it fails to steal. */
785         if (rem_vcpd->notif_disabled)
786                 goto out_stealing;
787         /* At this point, we're clear to try and steal the uthread.  Need to switch
788          * into their TLS to take their uthread */
789         vcoreid = vcore_id();   /* need to copy this out to our stack var */
790         /* We want to minimize the time we're in the remote vcore's TLS, so we peak
791          * and make the minimum changes we need, and deal with everything later. */
792         set_tls_desc(vcore_thread_control_blocks[rem_vcoreid], vcoreid);
793         if (current_uthread) {
794                 if (current_uthread->flags & UTHREAD_DONT_MIGRATE) {
795                         cant_migrate = TRUE;
796                 } else {
797                         uthread_to_steal = current_uthread;
798                         current_uthread = 0;
799                 }
800         }
801         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
802         /* Extremely rare: they have a uthread, but it can't migrate.  So we'll need
803          * to change to them. */
804         if (cant_migrate) {
805                 printd("VC %d recovering %d, can't migrate uthread!\n", vcoreid, rem_vcoreid);
806                 stop_uth_stealing(rem_vcpd);
807                 change_to_vcore(vcpd, rem_vcoreid);
808                 return; /* in case it returns.  we've done our job recovering */
809         }
810         if (!uthread_to_steal)
811                 goto out_stealing;
812         /* we're clear to steal it */
813         printd("VC %d recovering %d, uthread %08p stolen\n", vcoreid, rem_vcoreid,
814                current_uthread);
815         __uthread_pause(rem_vcpd, uthread_to_steal);
816         /* can't let the cur_uth = 0 write and any writes from __uth_pause() to
817          * pass stop_uth_stealing.  it's harmless in the cant_migrate case. */
818         wmb();
819         /* Fallthrough */
820 out_stealing:
821         stop_uth_stealing(rem_vcpd);
822         handle_indirs(rem_vcoreid);
823 }
824
825 /* This handles a "check indirs" message.  When this is done, either we checked
826  * their indirs, or the vcore restarted enough so that checking them is
827  * unnecessary.  If that happens and they got preempted quickly, then another
828  * preempt/check_indirs was sent out. */
829 static void handle_vc_indir(struct event_msg *ev_msg, unsigned int ev_type)
830 {
831         uint32_t vcoreid = vcore_id();
832         uint32_t rem_vcoreid = ev_msg->ev_arg2;
833
834         if (rem_vcoreid == vcoreid)
835                 return;
836         handle_indirs(rem_vcoreid);
837 }
838
839 /* Attempts to register ev_q with sysc, so long as sysc is not done/progress.
840  * Returns true if it succeeded, and false otherwise.  False means that the
841  * syscall is done, and does not need an event set (and should be handled
842  * accordingly).
843  * 
844  * A copy of this is in glibc/sysdeps/ros/syscall.c.  Keep them in sync. */
845 bool register_evq(struct syscall *sysc, struct event_queue *ev_q)
846 {
847         int old_flags;
848         sysc->ev_q = ev_q;
849         wrmb(); /* don't let that write pass any future reads (flags) */
850         /* Try and set the SC_UEVENT flag (so the kernel knows to look at ev_q) */
851         do {
852                 /* no cmb() needed, the atomic_read will reread flags */
853                 old_flags = atomic_read(&sysc->flags);
854                 /* Spin if the kernel is mucking with syscall flags */
855                 while (old_flags & SC_K_LOCK)
856                         old_flags = atomic_read(&sysc->flags);
857                 /* If the kernel finishes while we are trying to sign up for an event,
858                  * we need to bail out */
859                 if (old_flags & (SC_DONE | SC_PROGRESS)) {
860                         sysc->ev_q = 0;         /* not necessary, but might help with bugs */
861                         return FALSE;
862                 }
863         } while (!atomic_cas(&sysc->flags, old_flags, old_flags | SC_UEVENT));
864         return TRUE;
865 }
866
867 /* De-registers a syscall, so that the kernel will not send an event when it is
868  * done.  The call could already be SC_DONE, or could even finish while we try
869  * to unset SC_UEVENT.
870  *
871  * There is a chance the kernel sent an event if you didn't do this in time, but
872  * once this returns, the kernel won't send a message.
873  *
874  * If the kernel is trying to send a message right now, this will spin (on
875  * SC_K_LOCK).  We need to make sure we deregistered, and that if a message
876  * is coming, that it already was sent (and possibly overflowed), before
877  * returning. */
878 void deregister_evq(struct syscall *sysc)
879 {
880         int old_flags;
881         sysc->ev_q = 0;
882         wrmb(); /* don't let that write pass any future reads (flags) */
883         /* Try and unset the SC_UEVENT flag */
884         do {
885                 /* no cmb() needed, the atomic_read will reread flags */
886                 old_flags = atomic_read(&sysc->flags);
887                 /* Spin if the kernel is mucking with syscall flags */
888                 while (old_flags & SC_K_LOCK)
889                         old_flags = atomic_read(&sysc->flags);
890                 /* Note we don't care if the SC_DONE flag is getting set.  We just need
891                  * to avoid clobbering flags */
892         } while (!atomic_cas(&sysc->flags, old_flags, old_flags & ~SC_UEVENT));
893 }
894
895 /* TLS helpers */
896 static int __uthread_allocate_tls(struct uthread *uthread)
897 {
898         assert(!uthread->tls_desc);
899         uthread->tls_desc = allocate_tls();
900         if (!uthread->tls_desc) {
901                 errno = ENOMEM;
902                 return -1;
903         }
904         return 0;
905 }
906
907 static int __uthread_reinit_tls(struct uthread *uthread)
908 {
909         uthread->tls_desc = reinit_tls(uthread->tls_desc);
910         if (!uthread->tls_desc) {
911                 errno = ENOMEM;
912                 return -1;
913         }
914         return 0;
915 }
916
917 static void __uthread_free_tls(struct uthread *uthread)
918 {
919         free_tls(uthread->tls_desc);
920         uthread->tls_desc = NULL;
921 }