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