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