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