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