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