Allows uthread_init() to be called repeatedly
[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
15 /* static helpers: */
16 static int __uthread_allocate_tls(struct uthread *uthread);
17 static int __uthread_reinit_tls(struct uthread *uthread);
18 static void __uthread_free_tls(struct uthread *uthread);
19
20 /* The real 2LS calls this, passing in a uthread representing thread0.  When it
21  * returns, you're in _M mode, still running thread0, on vcore0 */
22 int uthread_lib_init(struct uthread *uthread)
23 {
24         /* Make sure this only runs once */
25         static bool initialized = FALSE;
26         if (initialized)
27                 return -1;
28         initialized = TRUE;
29         /* Init the vcore system */
30         assert(!vcore_init());
31         assert(uthread);
32         /* Save a pointer to thread0's tls region (the glibc one) into its tcb */
33         uthread->tls_desc = get_tls_desc(0);
34         /* Save a pointer to the uthread in its own TLS */
35         current_uthread = uthread;
36         /* Thread is currently running (it is 'us') */
37         uthread->state = UT_RUNNING;
38         /* Change temporarily to vcore0s tls region so we can save the newly created
39          * tcb into its current_uthread variable and then restore it.  One minor
40          * issue is that vcore0's transition-TLS isn't TLS_INITed yet.  Until it is
41          * (right before vcore_entry(), don't try and take the address of any of
42          * its TLS vars. */
43         extern void** vcore_thread_control_blocks;
44         set_tls_desc(vcore_thread_control_blocks[0], 0);
45         current_uthread = uthread;
46         set_tls_desc(uthread->tls_desc, 0);
47         assert(!in_vcore_context());
48         /* don't forget to enable notifs on vcore0.  if you don't, the kernel will
49          * restart your _S with notifs disabled, which is a path to confusion. */
50         __enable_notifs(0);
51         /* Get ourselves into _M mode.  Could consider doing this elsewhere... */
52         while (!in_multi_mode()) {
53                 vcore_request(1);
54                 /* TODO: consider blocking */
55                 cpu_relax();
56         }
57         return 0;
58 }
59
60 /* 2LSs shouldn't call uthread_vcore_entry directly */
61 void __attribute__((noreturn)) uthread_vcore_entry(void)
62 {
63         uint32_t vcoreid = vcore_id();
64
65         /* Should always have notifications disabled when coming in here. */
66         assert(!notif_is_enabled(vcoreid));
67         assert(in_vcore_context());
68
69         check_preempt_pending(vcoreid);
70         handle_events(vcoreid);
71         assert(in_vcore_context());     /* double check, in case and event changed it */
72         assert(sched_ops->sched_entry);
73         sched_ops->sched_entry();
74         /* 2LS sched_entry should never return */
75         assert(0);
76 }
77
78 /* Does the uthread initialization of a uthread that the caller created.  Call
79  * this whenever you are "starting over" with a thread. */
80 void uthread_init(struct uthread *new_thread)
81 {
82         /* don't remove this assert without dealing with 'caller' below.  if we want
83          * to call this while in vcore context, we'll need to handle the TLS
84          * swapping a little differently */
85         assert(!in_vcore_context());
86         uint32_t vcoreid;
87         assert(new_thread);
88         new_thread->state = UT_CREATED;
89         /* They should have zero'd the uthread.  Let's check critical things: */
90         assert(!new_thread->flags && !new_thread->sysc);
91         /* Get a TLS.  If we already have one, reallocate/refresh it */
92         if (new_thread->tls_desc)
93                 assert(!__uthread_reinit_tls(new_thread));
94         else
95                 assert(!__uthread_allocate_tls(new_thread));
96         /* Switch into the new guys TLS and let it know who it is */
97         struct uthread *caller = current_uthread;
98         assert(caller);
99         /* We need to disable notifs here (in addition to not migrating), since we
100          * could get interrupted when we're in the other guy's TLS, and when the
101          * vcore restarts us, it will put us in our old TLS, not the one we were in
102          * when we were interrupted.  We need to not migrate, since once we know the
103          * vcoreid, we depend on being on the same vcore throughout. */
104         caller->flags |= UTHREAD_DONT_MIGRATE;
105         wmb();
106         /* Note the first time we call this, we technically aren't on a vcore */
107         vcoreid = vcore_id();
108         disable_notifs(vcoreid);
109         /* Save the new_thread to the new uthread in that uthread's TLS */
110         set_tls_desc(new_thread->tls_desc, vcoreid);
111         current_uthread = new_thread;
112         /* Switch back to the caller */
113         set_tls_desc(caller->tls_desc, vcoreid);
114         /* Okay to migrate now, and enable interrupts/notifs.  This could be called
115          * from vcore context, so only enable if we're in _M and in vcore context. */
116         if (!in_vcore_context() && in_multi_mode())
117                 enable_notifs(vcoreid);
118         wmb();
119         caller->flags &= ~UTHREAD_DONT_MIGRATE;
120 }
121
122 void uthread_runnable(struct uthread *uthread)
123 {
124         /* Allow the 2LS to make the thread runnable, and do whatever. */
125         assert(sched_ops->thread_runnable);
126         uthread->state = UT_RUNNABLE;
127         sched_ops->thread_runnable(uthread);
128 }
129
130 /* Need to have this as a separate, non-inlined function since we clobber the
131  * stack pointer before calling it, and don't want the compiler to play games
132  * with my hart. */
133 static void __attribute__((noinline, noreturn)) 
134 __uthread_yield(void)
135 {
136         struct uthread *uthread = current_uthread;
137         assert(in_vcore_context());
138         assert(!notif_is_enabled(vcore_id()));
139         /* Note: we no longer care if the thread is exiting, the 2LS will call
140          * uthread_destroy() */
141         uthread->flags &= ~UTHREAD_DONT_MIGRATE;
142         /* Determine if we're blocking on a syscall or just yielding.  Might end
143          * up doing this differently when/if we have more ways to yield. */
144         if (uthread->sysc) {
145                 uthread->state = UT_BLOCKED;
146                 assert(sched_ops->thread_blockon_sysc);
147                 sched_ops->thread_blockon_sysc(uthread->sysc);
148         } else { /* generic yield */
149                 uthread->state = UT_RUNNABLE;
150                 assert(sched_ops->thread_yield);
151                 /* 2LS will save the thread somewhere for restarting.  Later on,
152                  * we'll probably have a generic function for all sorts of waiting.
153                  */
154                 sched_ops->thread_yield(uthread);
155         }
156         /* Leave the current vcore completely */
157         current_uthread = NULL;
158         /* Go back to the entry point, where we can handle notifications or
159          * reschedule someone. */
160         uthread_vcore_entry();
161 }
162
163 /* Calling thread yields.  Both exiting and yielding calls this, the difference
164  * is the thread's state (in the flags). */
165 void uthread_yield(bool save_state)
166 {
167         struct uthread *uthread = current_uthread;
168         volatile bool yielding = TRUE; /* signal to short circuit when restarting */
169         /* TODO: (HSS) Save silly state */
170         // if (save_state)
171         //      save_fp_state(&t->as);
172         assert(!in_vcore_context());
173         assert(uthread->state == UT_RUNNING);
174         /* Don't migrate this thread to another vcore, since it depends on being on
175          * the same vcore throughout (once it disables notifs).  The race is that we
176          * read vcoreid, then get interrupted / migrated before disabling notifs. */
177         uthread->flags |= UTHREAD_DONT_MIGRATE;
178         wmb();
179         uint32_t vcoreid = vcore_id();
180         printd("[U] Uthread %08p is yielding on vcore %d\n", uthread, vcoreid);
181         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
182         /* once we do this, we might miss a notif_pending, so we need to enter vcore
183          * entry later.  Need to disable notifs so we don't get in weird loops with
184          * save_ros_tf() and pop_ros_tf(). */
185         disable_notifs(vcoreid);
186         /* take the current state and save it into t->utf when this pthread
187          * restarts, it will continue from right after this, see yielding is false,
188          * and short ciruit the function.  Don't do this if we're dying. */
189         if (save_state)
190                 save_ros_tf(&uthread->utf);
191         /* Restart path doesn't matter if we're dying */
192         if (!yielding)
193                 goto yield_return_path;
194         yielding = FALSE; /* for when it starts back up */
195         /* Change to the transition context (both TLS and stack). */
196         extern void** vcore_thread_control_blocks;
197         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
198         assert(current_uthread == uthread);     
199         assert(in_vcore_context());     /* technically, we aren't fully in vcore context */
200         /* After this, make sure you don't use local variables.  Also, make sure the
201          * compiler doesn't use them without telling you (TODO).
202          *
203          * In each arch's set_stack_pointer, make sure you subtract off as much room
204          * as you need to any local vars that might be pushed before calling the
205          * next function, or for whatever other reason the compiler/hardware might
206          * walk up the stack a bit when calling a noreturn function. */
207         set_stack_pointer((void*)vcpd->transition_stack);
208         /* Finish exiting in another function. */
209         __uthread_yield();
210         /* Should never get here */
211         assert(0);
212         /* Will jump here when the uthread's trapframe is restarted/popped. */
213 yield_return_path:
214         printd("[U] Uthread %08p returning from a yield!\n", uthread);
215 }
216
217 /* Cleans up the uthread (the stuff we did in uthread_init()).  If you want to
218  * destroy a currently running uthread, you'll want something like
219  * pthread_exit(), which yields, and calls this from its sched_ops yield. */
220 void uthread_cleanup(struct uthread *uthread)
221 {
222         printd("[U] thread %08p on vcore %d is DYING!\n", uthread, vcore_id());
223         uthread->state = UT_DYING;
224         /* we alloc and manage the TLS, so lets get rid of it */
225         __uthread_free_tls(uthread);
226 }
227
228 /* Attempts to block on sysc, returning when it is done or progress has been
229  * made. */
230 void ros_syscall_blockon(struct syscall *sysc)
231 {
232         if (in_vcore_context()) {
233                 /* vcore's don't know what to do yet, so do the default (spin) */
234                 __ros_syscall_blockon(sysc);
235                 return;
236         }
237         if (!sched_ops->thread_blockon_sysc || !in_multi_mode()) {
238                 /* There isn't a 2LS op for blocking, or we're _S.  Spin for now. */
239                 __ros_syscall_blockon(sysc);
240                 return;
241         }
242         /* double check before doing all this crap */
243         if (atomic_read(&sysc->flags) & (SC_DONE | SC_PROGRESS))
244                 return;
245         /* So yield knows we are blocking on something */
246         assert(current_uthread);
247         current_uthread->sysc = sysc;
248         uthread_yield(TRUE);
249 }
250
251 /* Runs whatever thread is vcore's current_uthread */
252 void run_current_uthread(void)
253 {
254         uint32_t vcoreid = vcore_id();
255         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
256         assert(current_uthread);
257         assert(current_uthread->state == UT_RUNNING);
258         printd("[U] Vcore %d is restarting uthread %08p\n", vcoreid,
259                current_uthread);
260         clear_notif_pending(vcoreid);
261         set_tls_desc(current_uthread->tls_desc, vcoreid);
262         /* Pop the user trap frame */
263         pop_ros_tf(&vcpd->notif_tf, vcoreid);
264         assert(0);
265 }
266
267 /* Launches the uthread on the vcore.  Don't call this on current_uthread. */
268 void run_uthread(struct uthread *uthread)
269 {
270         assert(uthread != current_uthread);
271         if (uthread->state != UT_RUNNABLE) {
272                 /* had vcore3 throw this, when the UT blocked on vcore1 and didn't come
273                  * back up yet (kernel didn't wake up, didn't send IPI) */
274                 printf("Uthread %08p not runnable (was %d) in run_uthread on vcore %d!\n",
275                        uthread, uthread->state, vcore_id());
276         }
277         assert(uthread->state == UT_RUNNABLE);
278         uthread->state = UT_RUNNING;
279         /* Save a ptr to the pthread running in the transition context's TLS */
280         uint32_t vcoreid = vcore_id();
281         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
282         current_uthread = uthread;
283         clear_notif_pending(vcoreid);
284         set_tls_desc(uthread->tls_desc, vcoreid);
285         /* Load silly state (Floating point) too.  For real */
286         /* TODO: (HSS) */
287         /* Pop the user trap frame */
288         pop_ros_tf(&uthread->utf, vcoreid);
289         assert(0);
290 }
291
292 /* Deals with a pending preemption (checks, responds).  If the 2LS registered a
293  * function, it will get run.  Returns true if you got preempted.  Called
294  * 'check' instead of 'handle', since this isn't an event handler.  It's the "Oh
295  * shit a preempt is on its way ASAP".  While it is isn't too involved with
296  * uthreads, it is tied in to sched_ops. */
297 bool check_preempt_pending(uint32_t vcoreid)
298 {
299         bool retval = FALSE;
300         if (__procinfo.vcoremap[vcoreid].preempt_pending) {
301                 retval = TRUE;
302                 if (sched_ops->preempt_pending)
303                         sched_ops->preempt_pending();
304                 /* this tries to yield, but will pop back up if this was a spurious
305                  * preempt_pending. */
306                 sys_yield(TRUE);
307         }
308         return retval;
309 }
310
311 /* Attempts to register ev_q with sysc, so long as sysc is not done/progress.
312  * Returns true if it succeeded, and false otherwise.  False means that the
313  * syscall is done, and does not need an event set (and should be handled
314  * accordingly)*/
315 bool register_evq(struct syscall *sysc, struct event_queue *ev_q)
316 {
317         int old_flags;
318         sysc->ev_q = ev_q;
319         wmb();
320         /* Try and set the SC_UEVENT flag (so the kernel knows to look at ev_q) */
321         do {
322                 cmb();
323                 old_flags = atomic_read(&sysc->flags);
324                 /* Spin if the kernel is mucking with syscall flags */
325                 while (old_flags & SC_K_LOCK)
326                         old_flags = atomic_read(&sysc->flags);
327                 /* If the kernel finishes while we are trying to sign up for an event,
328                  * we need to bail out */
329                 if (old_flags & (SC_DONE | SC_PROGRESS)) {
330                         sysc->ev_q = 0;         /* not necessary, but might help with bugs */
331                         return FALSE;
332                 }
333         } while (!atomic_cas(&sysc->flags, old_flags, old_flags | SC_UEVENT));
334         return TRUE;
335 }
336
337 /* De-registers a syscall, so that the kernel will not send an event when it is
338  * done.  The call could already be SC_DONE, or could even finish while we try
339  * to unset SC_UEVENT.
340  *
341  * There is a chance the kernel sent an event if you didn't do this in time, but
342  * once this returns, the kernel won't send a message.
343  *
344  * If the kernel is trying to send a message right now, this will spin (on
345  * SC_K_LOCK).  We need to make sure we deregistered, and that if a message
346  * is coming, that it already was sent (and possibly overflowed), before
347  * returning. */
348 void deregister_evq(struct syscall *sysc)
349 {
350         int old_flags;
351         sysc->ev_q = 0;
352         /* Try and unset the SC_UEVENT flag */
353         do {
354                 cmb();
355                 old_flags = atomic_read(&sysc->flags);
356                 /* Spin if the kernel is mucking with syscall flags */
357                 while (old_flags & SC_K_LOCK)
358                         old_flags = atomic_read(&sysc->flags);
359                 /* Note we don't care if the SC_DONE flag is getting set.  We just need
360                  * to avoid clobbering flags */
361         } while (!atomic_cas(&sysc->flags, old_flags, old_flags & ~SC_UEVENT));
362 }
363
364 /* TLS helpers */
365 static int __uthread_allocate_tls(struct uthread *uthread)
366 {
367         assert(!uthread->tls_desc);
368         uthread->tls_desc = allocate_tls();
369         if (!uthread->tls_desc) {
370                 errno = ENOMEM;
371                 return -1;
372         }
373         return 0;
374 }
375
376 static int __uthread_reinit_tls(struct uthread *uthread)
377 {
378         uthread->tls_desc = reinit_tls(uthread->tls_desc);
379         if (!uthread->tls_desc) {
380                 errno = ENOMEM;
381                 return -1;
382         }
383         return 0;
384 }
385
386 static void __uthread_free_tls(struct uthread *uthread)
387 {
388         free_tls(uthread->tls_desc);
389         uthread->tls_desc = NULL;
390 }