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