6d93793f91a21914da54a188eb08ed476aca28b6
[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 an 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         /* not concerned about cross-core memory ordering, so no CPU mbs needed */
106         cmb();  /* don't let the compiler issue the vcore read before the write */
107         /* Note the first time we call this, we technically aren't on a vcore */
108         vcoreid = vcore_id();
109         disable_notifs(vcoreid);
110         /* Save the new_thread to the new uthread in that uthread's TLS */
111         set_tls_desc(new_thread->tls_desc, vcoreid);
112         current_uthread = new_thread;
113         /* Switch back to the caller */
114         set_tls_desc(caller->tls_desc, vcoreid);
115         /* Okay to migrate now, and enable interrupts/notifs.  This could be called
116          * from vcore context, so only enable if we're in _M and in vcore context. */
117         if (!in_vcore_context() && in_multi_mode())
118                 enable_notifs(vcoreid);
119         cmb();  /* issue this write after we're done with vcoreid */
120         caller->flags &= ~UTHREAD_DONT_MIGRATE;
121 }
122
123 void uthread_runnable(struct uthread *uthread)
124 {
125         /* Allow the 2LS to make the thread runnable, and do whatever. */
126         assert(sched_ops->thread_runnable);
127         uthread->state = UT_RUNNABLE;
128         sched_ops->thread_runnable(uthread);
129 }
130
131 /* Need to have this as a separate, non-inlined function since we clobber the
132  * stack pointer before calling it, and don't want the compiler to play games
133  * with my hart. */
134 static void __attribute__((noinline, noreturn)) 
135 __uthread_yield(void)
136 {
137         struct uthread *uthread = current_uthread;
138         assert(in_vcore_context());
139         assert(!notif_is_enabled(vcore_id()));
140         /* Note: we no longer care if the thread is exiting, the 2LS will call
141          * uthread_destroy() */
142         uthread->flags &= ~UTHREAD_DONT_MIGRATE;
143         /* Determine if we're blocking on a syscall or just yielding.  Might end
144          * up doing this differently when/if we have more ways to yield. */
145         if (uthread->sysc) {
146                 uthread->state = UT_BLOCKED;
147                 assert(sched_ops->thread_blockon_sysc);
148                 sched_ops->thread_blockon_sysc(uthread->sysc);
149         } else { /* generic yield */
150                 uthread->state = UT_RUNNABLE;
151                 assert(sched_ops->thread_yield);
152                 /* 2LS will save the thread somewhere for restarting.  Later on,
153                  * we'll probably have a generic function for all sorts of waiting.
154                  */
155                 sched_ops->thread_yield(uthread);
156         }
157         /* Leave the current vcore completely */
158         current_uthread = NULL;
159         /* Go back to the entry point, where we can handle notifications or
160          * reschedule someone. */
161         uthread_vcore_entry();
162 }
163
164 /* Calling thread yields.  Both exiting and yielding calls this, the difference
165  * is the thread's state (in the flags). */
166 void uthread_yield(bool save_state)
167 {
168         struct uthread *uthread = current_uthread;
169         volatile bool yielding = TRUE; /* signal to short circuit when restarting */
170         /* TODO: (HSS) Save silly state */
171         // if (save_state)
172         //      save_fp_state(&t->as);
173         assert(!in_vcore_context());
174         assert(uthread->state == UT_RUNNING);
175         /* Don't migrate this thread to another vcore, since it depends on being on
176          * the same vcore throughout (once it disables notifs).  The race is that we
177          * read vcoreid, then get interrupted / migrated before disabling notifs. */
178         uthread->flags |= UTHREAD_DONT_MIGRATE;
179         cmb();  /* don't let DONT_MIGRATE write pass the vcoreid read */
180         uint32_t vcoreid = vcore_id();
181         printd("[U] Uthread %08p is yielding on vcore %d\n", uthread, vcoreid);
182         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
183         /* once we do this, we might miss a notif_pending, so we need to enter vcore
184          * entry later.  Need to disable notifs so we don't get in weird loops with
185          * save_ros_tf() and pop_ros_tf(). */
186         disable_notifs(vcoreid);
187         /* take the current state and save it into t->utf when this pthread
188          * restarts, it will continue from right after this, see yielding is false,
189          * and short ciruit the function.  Don't do this if we're dying. */
190         if (save_state)
191                 save_ros_tf(&uthread->utf);
192         cmb();  /* Force a reread of yielding. Technically save_ros_tf() is enough*/
193         /* Restart path doesn't matter if we're dying */
194         if (!yielding)
195                 goto yield_return_path;
196         yielding = FALSE; /* for when it starts back up */
197         /* Change to the transition context (both TLS and stack). */
198         extern void** vcore_thread_control_blocks;
199         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
200         assert(current_uthread == uthread);     
201         assert(in_vcore_context());     /* technically, we aren't fully in vcore context */
202         /* After this, make sure you don't use local variables.  Also, make sure the
203          * compiler doesn't use them without telling you (TODO).
204          *
205          * In each arch's set_stack_pointer, make sure you subtract off as much room
206          * as you need to any local vars that might be pushed before calling the
207          * next function, or for whatever other reason the compiler/hardware might
208          * walk up the stack a bit when calling a noreturn function. */
209         set_stack_pointer((void*)vcpd->transition_stack);
210         /* Finish exiting in another function. */
211         __uthread_yield();
212         /* Should never get here */
213         assert(0);
214         /* Will jump here when the uthread's trapframe is restarted/popped. */
215 yield_return_path:
216         printd("[U] Uthread %08p returning from a yield!\n", uthread);
217 }
218
219 /* Cleans up the uthread (the stuff we did in uthread_init()).  If you want to
220  * destroy a currently running uthread, you'll want something like
221  * pthread_exit(), which yields, and calls this from its sched_ops yield. */
222 void uthread_cleanup(struct uthread *uthread)
223 {
224         printd("[U] thread %08p on vcore %d is DYING!\n", uthread, vcore_id());
225         uthread->state = UT_DYING;
226         /* we alloc and manage the TLS, so lets get rid of it */
227         __uthread_free_tls(uthread);
228 }
229
230 /* Attempts to block on sysc, returning when it is done or progress has been
231  * made. */
232 void ros_syscall_blockon(struct syscall *sysc)
233 {
234         if (in_vcore_context()) {
235                 /* vcore's don't know what to do yet, so do the default (spin) */
236                 __ros_syscall_blockon(sysc);
237                 return;
238         }
239         if (!sched_ops->thread_blockon_sysc || !in_multi_mode()) {
240                 /* There isn't a 2LS op for blocking, or we're _S.  Spin for now. */
241                 __ros_syscall_blockon(sysc);
242                 return;
243         }
244         /* double check before doing all this crap */
245         if (atomic_read(&sysc->flags) & (SC_DONE | SC_PROGRESS))
246                 return;
247         /* So yield knows we are blocking on something */
248         assert(current_uthread);
249         current_uthread->sysc = sysc;
250         uthread_yield(TRUE);
251 }
252
253 /* Runs whatever thread is vcore's current_uthread */
254 void run_current_uthread(void)
255 {
256         uint32_t vcoreid = vcore_id();
257         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
258         assert(current_uthread);
259         assert(current_uthread->state == UT_RUNNING);
260         printd("[U] Vcore %d is restarting uthread %08p\n", vcoreid,
261                current_uthread);
262         clear_notif_pending(vcoreid);
263         set_tls_desc(current_uthread->tls_desc, vcoreid);
264         /* Pop the user trap frame */
265         pop_ros_tf(&vcpd->notif_tf, vcoreid);
266         assert(0);
267 }
268
269 /* Launches the uthread on the vcore.  Don't call this on current_uthread. */
270 void run_uthread(struct uthread *uthread)
271 {
272         uint32_t vcoreid;
273         assert(uthread != current_uthread);
274         if (uthread->state != UT_RUNNABLE) {
275                 /* had vcore3 throw this, when the UT blocked on vcore1 and didn't come
276                  * back up yet (kernel didn't wake up, didn't send IPI) */
277                 printf("Uthread %08p not runnable (was %d) in run_uthread on vcore %d!\n",
278                        uthread, uthread->state, vcore_id());
279         }
280         assert(uthread->state == UT_RUNNABLE);
281         uthread->state = UT_RUNNING;
282         /* Save a ptr to the uthread we'll run in the transition context's TLS */
283         current_uthread = uthread;
284         vcoreid = vcore_id();
285         clear_notif_pending(vcoreid);
286         set_tls_desc(uthread->tls_desc, vcoreid);
287         /* Load silly state (Floating point) too.  For real */
288         /* TODO: (HSS) */
289         /* Pop the user trap frame */
290         pop_ros_tf(&uthread->utf, vcoreid);
291         assert(0);
292 }
293
294 /* Deals with a pending preemption (checks, responds).  If the 2LS registered a
295  * function, it will get run.  Returns true if you got preempted.  Called
296  * 'check' instead of 'handle', since this isn't an event handler.  It's the "Oh
297  * shit a preempt is on its way ASAP".  While it is isn't too involved with
298  * uthreads, it is tied in to sched_ops. */
299 bool check_preempt_pending(uint32_t vcoreid)
300 {
301         bool retval = FALSE;
302         if (__procinfo.vcoremap[vcoreid].preempt_pending) {
303                 retval = TRUE;
304                 if (sched_ops->preempt_pending)
305                         sched_ops->preempt_pending();
306                 /* this tries to yield, but will pop back up if this was a spurious
307                  * preempt_pending.  Note this will handle events internally, and then
308                  * recurse once per event in the queue.  This sucks, but keeps us from
309                  * missing messages for now. */
310                 vcore_yield(TRUE);
311         }
312         return retval;
313 }
314
315 /* Attempts to register ev_q with sysc, so long as sysc is not done/progress.
316  * Returns true if it succeeded, and false otherwise.  False means that the
317  * syscall is done, and does not need an event set (and should be handled
318  * accordingly)*/
319 bool register_evq(struct syscall *sysc, struct event_queue *ev_q)
320 {
321         int old_flags;
322         sysc->ev_q = ev_q;
323         wrmb(); /* don't let that write pass any future reads (flags) */
324         /* Try and set the SC_UEVENT flag (so the kernel knows to look at ev_q) */
325         do {
326                 /* no cmb() needed, the atomic_read will reread flags */
327                 old_flags = atomic_read(&sysc->flags);
328                 /* Spin if the kernel is mucking with syscall flags */
329                 while (old_flags & SC_K_LOCK)
330                         old_flags = atomic_read(&sysc->flags);
331                 /* If the kernel finishes while we are trying to sign up for an event,
332                  * we need to bail out */
333                 if (old_flags & (SC_DONE | SC_PROGRESS)) {
334                         sysc->ev_q = 0;         /* not necessary, but might help with bugs */
335                         return FALSE;
336                 }
337         } while (!atomic_cas(&sysc->flags, old_flags, old_flags | SC_UEVENT));
338         return TRUE;
339 }
340
341 /* De-registers a syscall, so that the kernel will not send an event when it is
342  * done.  The call could already be SC_DONE, or could even finish while we try
343  * to unset SC_UEVENT.
344  *
345  * There is a chance the kernel sent an event if you didn't do this in time, but
346  * once this returns, the kernel won't send a message.
347  *
348  * If the kernel is trying to send a message right now, this will spin (on
349  * SC_K_LOCK).  We need to make sure we deregistered, and that if a message
350  * is coming, that it already was sent (and possibly overflowed), before
351  * returning. */
352 void deregister_evq(struct syscall *sysc)
353 {
354         int old_flags;
355         sysc->ev_q = 0;
356         wrmb(); /* don't let that write pass any future reads (flags) */
357         /* Try and unset the SC_UEVENT flag */
358         do {
359                 /* no cmb() needed, the atomic_read will reread flags */
360                 old_flags = atomic_read(&sysc->flags);
361                 /* Spin if the kernel is mucking with syscall flags */
362                 while (old_flags & SC_K_LOCK)
363                         old_flags = atomic_read(&sysc->flags);
364                 /* Note we don't care if the SC_DONE flag is getting set.  We just need
365                  * to avoid clobbering flags */
366         } while (!atomic_cas(&sysc->flags, old_flags, old_flags & ~SC_UEVENT));
367 }
368
369 /* TLS helpers */
370 static int __uthread_allocate_tls(struct uthread *uthread)
371 {
372         assert(!uthread->tls_desc);
373         uthread->tls_desc = allocate_tls();
374         if (!uthread->tls_desc) {
375                 errno = ENOMEM;
376                 return -1;
377         }
378         return 0;
379 }
380
381 static int __uthread_reinit_tls(struct uthread *uthread)
382 {
383         uthread->tls_desc = reinit_tls(uthread->tls_desc);
384         if (!uthread->tls_desc) {
385                 errno = ENOMEM;
386                 return -1;
387         }
388         return 0;
389 }
390
391 static void __uthread_free_tls(struct uthread *uthread)
392 {
393         free_tls(uthread->tls_desc);
394         uthread->tls_desc = NULL;
395 }