Uthread vc_entry will spin on STEALING
[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         /* 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         current_uthread = uthread;
51         set_tls_desc(uthread->tls_desc, 0);
52         assert(!in_vcore_context());
53         /* Receive preemption events */
54         ev_handlers[EV_VCORE_PREEMPT] = handle_vc_preempt;
55         preempt_ev_q = get_big_event_q();
56         preempt_ev_q->ev_flags = EVENT_IPI | EVENT_INDIR | EVENT_FALLBACK |
57                                  EVENT_NOTHROTTLE | EVENT_VCORE_MUST_RUN;
58         register_kevent_q(preempt_ev_q, EV_VCORE_PREEMPT);
59         printd("[user] registered %08p (flags %08p) for preempt messages\n",
60                preempt_ev_q, preempt_ev_q->ev_flags);
61         /* Get ourselves into _M mode.  Could consider doing this elsewhere... */
62         while (!in_multi_mode()) {
63                 vcore_request(1);
64                 /* TODO: consider blocking */
65                 cpu_relax();
66         }
67         return 0;
68 }
69
70 /* 2LSs shouldn't call uthread_vcore_entry directly */
71 void __attribute__((noreturn)) uthread_vcore_entry(void)
72 {
73         uint32_t vcoreid = vcore_id();
74         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
75         /* Should always have notifications disabled when coming in here. */
76         assert(!notif_is_enabled(vcoreid));
77         assert(in_vcore_context());
78         /* If someone is stealing our uthread (from when we were preempted before),
79          * we can't touch our uthread.  But we might be the last vcore around, so
80          * we'll handle preemption events. */
81         while (atomic_read(&vcpd->flags) & VC_UTHREAD_STEALING) {
82                 handle_event_q(preempt_ev_q);
83                 cpu_relax();
84         }
85         /* If we have a current uthread that is DONT_MIGRATE, pop it real quick and
86          * let it disable notifs (like it wants to).  Other than dealing with
87          * preemption events, we shouldn't do anything in vc_ctx when we have a
88          * DONT_MIGRATE uthread. */
89         if (current_uthread && (current_uthread->flags & UTHREAD_DONT_MIGRATE))
90                 __run_current_uthread_raw();
91         /* Otherwise, go about our usual vcore business (messages, etc). */
92         check_preempt_pending(vcoreid);
93         handle_events(vcoreid);
94         assert(in_vcore_context());     /* double check, in case an event changed it */
95         assert(sched_ops->sched_entry);
96         sched_ops->sched_entry();
97         /* 2LS sched_entry should never return */
98         assert(0);
99 }
100
101 /* Does the uthread initialization of a uthread that the caller created.  Call
102  * this whenever you are "starting over" with a thread. */
103 void uthread_init(struct uthread *new_thread)
104 {
105         /* don't remove this assert without dealing with 'caller' below.  if we want
106          * to call this while in vcore context, we'll need to handle the TLS
107          * swapping a little differently */
108         assert(!in_vcore_context());
109         uint32_t vcoreid;
110         assert(new_thread);
111         new_thread->state = UT_CREATED;
112         /* They should have zero'd the uthread.  Let's check critical things: */
113         assert(!new_thread->flags && !new_thread->sysc);
114         /* Get a TLS.  If we already have one, reallocate/refresh it */
115         if (new_thread->tls_desc)
116                 assert(!__uthread_reinit_tls(new_thread));
117         else
118                 assert(!__uthread_allocate_tls(new_thread));
119         /* Switch into the new guys TLS and let it know who it is */
120         struct uthread *caller = current_uthread;
121         assert(caller);
122         /* We need to disable notifs here (in addition to not migrating), since we
123          * could get interrupted when we're in the other guy's TLS, and when the
124          * vcore restarts us, it will put us in our old TLS, not the one we were in
125          * when we were interrupted.  We need to not migrate, since once we know the
126          * vcoreid, we depend on being on the same vcore throughout. */
127         caller->flags |= UTHREAD_DONT_MIGRATE;
128         /* not concerned about cross-core memory ordering, so no CPU mbs needed */
129         cmb();  /* don't let the compiler issue the vcore read before the write */
130         /* Note the first time we call this, we technically aren't on a vcore */
131         vcoreid = vcore_id();
132         disable_notifs(vcoreid);
133         /* Save the new_thread to the new uthread in that uthread's TLS */
134         set_tls_desc(new_thread->tls_desc, vcoreid);
135         current_uthread = new_thread;
136         /* Switch back to the caller */
137         set_tls_desc(caller->tls_desc, vcoreid);
138         /* Okay to migrate now, and enable interrupts/notifs.  This could be called
139          * from vcore context, so only enable if we're in _M and in vcore context. */
140         caller->flags &= ~UTHREAD_DONT_MIGRATE;         /* turn this on first */
141         if (!in_vcore_context() && in_multi_mode())
142                 enable_notifs(vcoreid);
143         cmb();  /* issue this write after we're done with vcoreid */
144 }
145
146 void uthread_runnable(struct uthread *uthread)
147 {
148         /* Allow the 2LS to make the thread runnable, and do whatever. */
149         assert(sched_ops->thread_runnable);
150         uthread->state = UT_RUNNABLE;
151         sched_ops->thread_runnable(uthread);
152 }
153
154 /* Need to have this as a separate, non-inlined function since we clobber the
155  * stack pointer before calling it, and don't want the compiler to play games
156  * with my hart. */
157 static void __attribute__((noinline, noreturn)) 
158 __uthread_yield(void)
159 {
160         struct uthread *uthread = current_uthread;
161         assert(in_vcore_context());
162         assert(!notif_is_enabled(vcore_id()));
163         /* Note: we no longer care if the thread is exiting, the 2LS will call
164          * uthread_destroy() */
165         uthread->flags &= ~UTHREAD_DONT_MIGRATE;
166         /* Determine if we're blocking on a syscall or just yielding.  Might end
167          * up doing this differently when/if we have more ways to yield. */
168         if (uthread->sysc) {
169                 uthread->state = UT_BLOCKED;
170                 assert(sched_ops->thread_blockon_sysc);
171                 sched_ops->thread_blockon_sysc(uthread->sysc);
172         } else { /* generic yield */
173                 uthread->state = UT_RUNNABLE;
174                 assert(sched_ops->thread_yield);
175                 /* 2LS will save the thread somewhere for restarting.  Later on,
176                  * we'll probably have a generic function for all sorts of waiting.
177                  */
178                 sched_ops->thread_yield(uthread);
179         }
180         /* Leave the current vcore completely */
181         current_uthread = NULL;
182         /* Go back to the entry point, where we can handle notifications or
183          * reschedule someone. */
184         uthread_vcore_entry();
185 }
186
187 /* Calling thread yields.  Both exiting and yielding calls this, the difference
188  * is the thread's state (in the flags). */
189 void uthread_yield(bool save_state)
190 {
191         struct uthread *uthread = current_uthread;
192         volatile bool yielding = TRUE; /* signal to short circuit when restarting */
193         /* TODO: (HSS) Save silly state */
194         // if (save_state)
195         //      save_fp_state(&t->as);
196         assert(!in_vcore_context());
197         assert(uthread->state == UT_RUNNING);
198         /* Don't migrate this thread to another vcore, since it depends on being on
199          * the same vcore throughout (once it disables notifs).  The race is that we
200          * read vcoreid, then get interrupted / migrated before disabling notifs. */
201         uthread->flags |= UTHREAD_DONT_MIGRATE;
202         cmb();  /* don't let DONT_MIGRATE write pass the vcoreid read */
203         uint32_t vcoreid = vcore_id();
204         printd("[U] Uthread %08p is yielding on vcore %d\n", uthread, vcoreid);
205         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
206         /* once we do this, we might miss a notif_pending, so we need to enter vcore
207          * entry later.  Need to disable notifs so we don't get in weird loops with
208          * save_ros_tf() and pop_ros_tf(). */
209         disable_notifs(vcoreid);
210         /* take the current state and save it into t->utf when this pthread
211          * restarts, it will continue from right after this, see yielding is false,
212          * and short ciruit the function.  Don't do this if we're dying. */
213         if (save_state)
214                 save_ros_tf(&uthread->utf);
215         cmb();  /* Force a reread of yielding. Technically save_ros_tf() is enough*/
216         /* Restart path doesn't matter if we're dying */
217         if (!yielding)
218                 goto yield_return_path;
219         yielding = FALSE; /* for when it starts back up */
220         /* Signal the current state is in utf.  Need to do this only the first time
221          * through (not on the yield return path that comes after save_ros_tf) */
222         uthread->flags |= UTHREAD_SAVED;
223         /* Change to the transition context (both TLS and stack). */
224         extern void** vcore_thread_control_blocks;
225         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
226         assert(current_uthread == uthread);     
227         assert(in_vcore_context());     /* technically, we aren't fully in vcore context */
228         /* After this, make sure you don't use local variables.  Also, make sure the
229          * compiler doesn't use them without telling you (TODO).
230          *
231          * In each arch's set_stack_pointer, make sure you subtract off as much room
232          * as you need to any local vars that might be pushed before calling the
233          * next function, or for whatever other reason the compiler/hardware might
234          * walk up the stack a bit when calling a noreturn function. */
235         set_stack_pointer((void*)vcpd->transition_stack);
236         /* Finish exiting in another function. */
237         __uthread_yield();
238         /* Should never get here */
239         assert(0);
240         /* Will jump here when the uthread's trapframe is restarted/popped. */
241 yield_return_path:
242         printd("[U] Uthread %08p returning from a yield!\n", uthread);
243 }
244
245 /* Cleans up the uthread (the stuff we did in uthread_init()).  If you want to
246  * destroy a currently running uthread, you'll want something like
247  * pthread_exit(), which yields, and calls this from its sched_ops yield. */
248 void uthread_cleanup(struct uthread *uthread)
249 {
250         printd("[U] thread %08p on vcore %d is DYING!\n", uthread, vcore_id());
251         uthread->state = UT_DYING;
252         /* we alloc and manage the TLS, so lets get rid of it */
253         __uthread_free_tls(uthread);
254 }
255
256 /* Attempts to block on sysc, returning when it is done or progress has been
257  * made. */
258 void ros_syscall_blockon(struct syscall *sysc)
259 {
260         if (in_vcore_context()) {
261                 /* vcore's don't know what to do yet, so do the default (spin) */
262                 __ros_syscall_blockon(sysc);
263                 return;
264         }
265         if (!sched_ops->thread_blockon_sysc || !in_multi_mode()) {
266                 /* There isn't a 2LS op for blocking, or we're _S.  Spin for now. */
267                 __ros_syscall_blockon(sysc);
268                 return;
269         }
270         /* At this point, we know we're a uthread.  If we're a DONT_MIGRATE uthread,
271          * then it's disabled notifs and is basically in vcore context, enough so
272          * that it can't call into the 2LS. */
273         assert(current_uthread);
274         if (current_uthread->flags & UTHREAD_DONT_MIGRATE) {
275                 assert(!notif_is_enabled(vcore_id()));  /* catch bugs */
276                 __ros_syscall_blockon(sysc);
277         }
278         /* double check before doing all this crap */
279         if (atomic_read(&sysc->flags) & (SC_DONE | SC_PROGRESS))
280                 return;
281         /* So yield knows we are blocking on something */
282         current_uthread->sysc = sysc;
283         uthread_yield(TRUE);
284 }
285
286 /* Helper for run_current and run_uthread.  Make sure the uthread you want to
287  * run is the current_uthread before calling this.  It will pop the TF of
288  * whatever you send in (run_cur and run_uth use different TFs).
289  *
290  * This will adjust the thread's state, do one last check on notif_pending, and
291  * pop the tf.  Note that the notif check is an optimization.  pop_ros_tf() will
292  * definitely handle it, but it will take a syscall to do so later. */
293 static void __run_cur_uthread(struct user_trapframe *utf)
294 {
295         uint32_t vcoreid = vcore_id();
296         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
297         clear_notif_pending(vcoreid);
298         /* clear_notif might have handled a preemption event, and we might not have
299          * a current_uthread anymore.  Need to recheck */
300         cmb();
301         if (!current_uthread) {
302                 /* Start over, as if we just had a notif from the kernel.
303                  * Note that  we're resetting the stack here.  Don't do anything other
304                  * than call vcore_entry() */
305                 set_stack_pointer((void*)vcpd->transition_stack);
306                 uthread_vcore_entry();
307                 assert(0);
308         }
309         /* Go ahead and start the uthread */
310         /* utf no longer represents the current state of the uthread */
311         current_uthread->flags &= ~UTHREAD_SAVED;
312         set_tls_desc(current_uthread->tls_desc, vcoreid);
313         /* Pop the user trap frame */
314         pop_ros_tf(utf, vcoreid);
315 }
316
317 /* Runs whatever thread is vcore's current_uthread */
318 void run_current_uthread(void)
319 {
320         uint32_t vcoreid = vcore_id();
321         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
322         assert(current_uthread);
323         assert(current_uthread->state == UT_RUNNING);
324         printd("[U] Vcore %d is restarting uthread %08p\n", vcoreid,
325                current_uthread);
326         /* Run, using the TF in the VCPD.  FP state should already be loaded */
327         __run_cur_uthread(&vcpd->notif_tf);
328         assert(0);
329 }
330
331 /* Launches the uthread on the vcore.  Don't call this on current_uthread. */
332 void run_uthread(struct uthread *uthread)
333 {
334         uint32_t vcoreid = vcore_id();
335         assert(uthread != current_uthread);
336         if (uthread->state != UT_RUNNABLE) {
337                 /* had vcore3 throw this, when the UT blocked on vcore1 and didn't come
338                  * back up yet (kernel didn't wake up, didn't send IPI) */
339                 printf("Uthread %08p not runnable (was %d) in run_uthread on vcore %d!\n",
340                        uthread, uthread->state, vcore_id());
341         }
342         assert(uthread->state == UT_RUNNABLE);
343         uthread->state = UT_RUNNING;
344         /* Save a ptr to the uthread we'll run in the transition context's TLS */
345         current_uthread = uthread;
346         /* Load silly state (Floating point) too.  For real */
347         /* TODO: (HSS) */
348         __run_cur_uthread(&uthread->utf);
349         assert(0);
350 }
351
352 /* Runs the uthread, but doesn't care about notif pending.  Only call this when
353  * there was a DONT_MIGRATE uthread, or a similar situation where the uthread
354  * will check messages soon (like calling enable_notifs()). */
355 static void __run_current_uthread_raw(void)
356 {
357         uint32_t vcoreid = vcore_id();
358         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
359         /* We need to manually say we have a notif pending, so we eventually return
360          * to vcore context.  (note the kernel turned it off for us) */
361         vcpd->notif_pending = TRUE;
362         /* utf no longer represents the current state of the uthread */
363         current_uthread->flags &= ~UTHREAD_SAVED;
364         set_tls_desc(current_uthread->tls_desc, vcoreid);
365         /* Pop the user trap frame */
366         pop_ros_tf_raw(&vcpd->notif_tf, vcoreid);
367         assert(0);
368 }
369
370 /* Deals with a pending preemption (checks, responds).  If the 2LS registered a
371  * function, it will get run.  Returns true if you got preempted.  Called
372  * 'check' instead of 'handle', since this isn't an event handler.  It's the "Oh
373  * shit a preempt is on its way ASAP".  While it is isn't too involved with
374  * uthreads, it is tied in to sched_ops. */
375 bool check_preempt_pending(uint32_t vcoreid)
376 {
377         bool retval = FALSE;
378         if (__procinfo.vcoremap[vcoreid].preempt_pending) {
379                 retval = TRUE;
380                 if (sched_ops->preempt_pending)
381                         sched_ops->preempt_pending();
382                 /* this tries to yield, but will pop back up if this was a spurious
383                  * preempt_pending.  Note this will handle events internally, and then
384                  * recurse once per event in the queue.  This sucks, but keeps us from
385                  * missing messages for now. */
386                 vcore_yield(TRUE);
387         }
388         return retval;
389 }
390
391 /* Helper: This is a safe way for code to disable notifs if it *might* be called
392  * from uthread context (like from a notif_safe lock).  Pair this with
393  * uth_enable_notifs() unless you know what you're doing. */
394 void uth_disable_notifs(void)
395 {
396         if (!in_vcore_context() && in_multi_mode()) {
397                 if (current_uthread)
398                         current_uthread->flags |= UTHREAD_DONT_MIGRATE;
399                 cmb();  /* don't issue the flag write before the vcore_id() read */
400                 disable_notifs(vcore_id());
401         }
402 }
403
404 /* Helper: Pair this with uth_disable_notifs(). */
405 void uth_enable_notifs(void)
406 {
407         if (!in_vcore_context() && in_multi_mode()) {
408                 if (current_uthread)
409                         current_uthread->flags &= ~UTHREAD_DONT_MIGRATE;
410                 cmb();  /* don't enable before ~DONT_MIGRATE */
411                 enable_notifs(vcore_id());
412         }
413 }
414
415 static void handle_vc_preempt(struct event_msg *ev_msg, unsigned int ev_type)
416 {
417         printf("Vcore %d was preempted, we're fucked!!!\n", ev_msg->ev_arg2);
418 }
419
420 /* Attempts to register ev_q with sysc, so long as sysc is not done/progress.
421  * Returns true if it succeeded, and false otherwise.  False means that the
422  * syscall is done, and does not need an event set (and should be handled
423  * accordingly)*/
424 bool register_evq(struct syscall *sysc, struct event_queue *ev_q)
425 {
426         int old_flags;
427         sysc->ev_q = ev_q;
428         wrmb(); /* don't let that write pass any future reads (flags) */
429         /* Try and set the SC_UEVENT flag (so the kernel knows to look at ev_q) */
430         do {
431                 /* no cmb() needed, the atomic_read will reread flags */
432                 old_flags = atomic_read(&sysc->flags);
433                 /* Spin if the kernel is mucking with syscall flags */
434                 while (old_flags & SC_K_LOCK)
435                         old_flags = atomic_read(&sysc->flags);
436                 /* If the kernel finishes while we are trying to sign up for an event,
437                  * we need to bail out */
438                 if (old_flags & (SC_DONE | SC_PROGRESS)) {
439                         sysc->ev_q = 0;         /* not necessary, but might help with bugs */
440                         return FALSE;
441                 }
442         } while (!atomic_cas(&sysc->flags, old_flags, old_flags | SC_UEVENT));
443         return TRUE;
444 }
445
446 /* De-registers a syscall, so that the kernel will not send an event when it is
447  * done.  The call could already be SC_DONE, or could even finish while we try
448  * to unset SC_UEVENT.
449  *
450  * There is a chance the kernel sent an event if you didn't do this in time, but
451  * once this returns, the kernel won't send a message.
452  *
453  * If the kernel is trying to send a message right now, this will spin (on
454  * SC_K_LOCK).  We need to make sure we deregistered, and that if a message
455  * is coming, that it already was sent (and possibly overflowed), before
456  * returning. */
457 void deregister_evq(struct syscall *sysc)
458 {
459         int old_flags;
460         sysc->ev_q = 0;
461         wrmb(); /* don't let that write pass any future reads (flags) */
462         /* Try and unset the SC_UEVENT flag */
463         do {
464                 /* no cmb() needed, the atomic_read will reread flags */
465                 old_flags = atomic_read(&sysc->flags);
466                 /* Spin if the kernel is mucking with syscall flags */
467                 while (old_flags & SC_K_LOCK)
468                         old_flags = atomic_read(&sysc->flags);
469                 /* Note we don't care if the SC_DONE flag is getting set.  We just need
470                  * to avoid clobbering flags */
471         } while (!atomic_cas(&sysc->flags, old_flags, old_flags & ~SC_UEVENT));
472 }
473
474 /* TLS helpers */
475 static int __uthread_allocate_tls(struct uthread *uthread)
476 {
477         assert(!uthread->tls_desc);
478         uthread->tls_desc = allocate_tls();
479         if (!uthread->tls_desc) {
480                 errno = ENOMEM;
481                 return -1;
482         }
483         return 0;
484 }
485
486 static int __uthread_reinit_tls(struct uthread *uthread)
487 {
488         uthread->tls_desc = reinit_tls(uthread->tls_desc);
489         if (!uthread->tls_desc) {
490                 errno = ENOMEM;
491                 return -1;
492         }
493         return 0;
494 }
495
496 static void __uthread_free_tls(struct uthread *uthread)
497 {
498         free_tls(uthread->tls_desc);
499         uthread->tls_desc = NULL;
500 }