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