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