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