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