Fixes bug in pop_ros_tf
[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 /* Gets called once out of uthread_create().  Can also do this in a ctor. */
20 static int uthread_init(void)
21 {
22         /* Init the vcore system */
23         assert(!vcore_init());
24         /* Bug if vcore init was called with no 2LS */
25         assert(sched_ops->sched_init);
26         /* Get thread 0's thread struct (2LS allocs it) */
27         struct uthread *uthread = sched_ops->sched_init();
28         /* Save a pointer to thread0's tls region (the glibc one) into its tcb */
29         uthread->tls_desc = get_tls_desc(0);
30         /* Save a pointer to the uthread in its own TLS */
31         current_uthread = uthread;
32         /* Thread is currently running (it is 'us') */
33         uthread->state = UT_RUNNING;
34         /* Change temporarily to vcore0s tls region so we can save the newly created
35          * tcb into its current_uthread variable and then restore it.  One minor
36          * issue is that vcore0's transition-TLS isn't TLS_INITed yet.  Until it is
37          * (right before vcore_entry(), don't try and take the address of any of
38          * its TLS vars. */
39         extern void** vcore_thread_control_blocks;
40         set_tls_desc(vcore_thread_control_blocks[0], 0);
41         current_uthread = uthread;
42         set_tls_desc(uthread->tls_desc, 0);
43         assert(!in_vcore_context());
44         /* don't forget to enable notifs on vcore0.  if you don't, the kernel will
45          * restart your _S with notifs disabled, which is a path to confusion. */
46         __enable_notifs(0);
47         /* Get ourselves into _M mode.  Could consider doing this elsewhere... */
48         while (num_vcores() < 1) {
49                 vcore_request(1);
50                 /* TODO: consider blocking */
51                 cpu_relax();
52         }
53         return 0;
54 }
55
56 /* 2LSs shouldn't call uthread_vcore_entry directly */
57 void __attribute__((noreturn)) uthread_vcore_entry(void)
58 {
59         uint32_t vcoreid = vcore_id();
60
61         /* Should always have notifications disabled when coming in here. */
62         assert(!notif_is_enabled(vcoreid));
63         assert(in_vcore_context());
64
65         check_preempt_pending(vcoreid);
66         handle_events(vcoreid);
67         assert(in_vcore_context());     /* double check, in case and event changed it */
68         assert(sched_ops->sched_entry);
69         sched_ops->sched_entry();
70         /* 2LS sched_entry should never return */
71         assert(0);
72 }
73
74 /* Creates a uthread.  Will pass udata to sched_ops's thread_create.  For now,
75  * the vcore/default 2ls code handles start routines and args.  Mostly because
76  * this is used when initing a utf, which is vcore specific for now. */
77 struct uthread *uthread_create(void (*func)(void), void *udata)
78 {
79         /* First time through, init the uthread code (which makes a uthread out of
80          * thread0 / the current code.  Could move this to a ctor. */
81         static bool first = TRUE;
82         if (first) {
83                 assert(!uthread_init());
84                 first = FALSE;
85         }
86         assert(!in_vcore_context());
87         assert(sched_ops->thread_create);
88         struct uthread *new_thread = sched_ops->thread_create(func, udata);
89         new_thread->state = UT_CREATED;
90         /* They should have zero'd the uthread.  Let's check critical things: */
91         assert(!new_thread->flags && !new_thread->sysc);
92         /* Get a TLS */
93         assert(!__uthread_allocate_tls(new_thread));
94         /* Switch into the new guys TLS and let it know who it is */
95         struct uthread *caller = current_uthread;
96         assert(caller);
97         /* Don't migrate this thread to another vcore, since it depends on being on
98          * the same vcore throughout. */
99         caller->flags |= UTHREAD_DONT_MIGRATE;
100         wmb();
101         /* Note the first time we call this, we technically aren't on a vcore */
102         uint32_t vcoreid = vcore_id();
103         /* Save the new_thread to the new uthread in that uthread's TLS */
104         set_tls_desc(new_thread->tls_desc, vcoreid);
105         current_uthread = new_thread;
106         /* Switch back to the caller */
107         set_tls_desc(caller->tls_desc, vcoreid);
108         /* Okay to migrate now. */
109         wmb();
110         caller->flags &= ~UTHREAD_DONT_MIGRATE;
111         return new_thread;
112 }
113
114 void uthread_runnable(struct uthread *uthread)
115 {
116         /* Allow the 2LS to make the thread runnable, and do whatever. */
117         assert(sched_ops->thread_runnable);
118         uthread->state = UT_RUNNABLE;
119         sched_ops->thread_runnable(uthread);
120 }
121
122 /* Need to have this as a separate, non-inlined function since we clobber the
123  * stack pointer before calling it, and don't want the compiler to play games
124  * with my hart. */
125 static void __attribute__((noinline, noreturn)) 
126 __uthread_yield(void)
127 {
128         struct uthread *uthread = current_uthread;
129         assert(in_vcore_context());
130         assert(!notif_is_enabled(vcore_id()));
131         /* Do slightly different things depending on whether or not we're exiting.
132          * While it is tempting to get rid of the UTHREAD_DYING flag and have
133          * callers just set the thread state, we'd lose the ability to assert
134          * UT_RUNNING, which helps catch bugs. */
135         if (!(uthread->flags & UTHREAD_DYING)) {
136                 uthread->flags &= ~UTHREAD_DONT_MIGRATE;
137                 /* Determine if we're blocking on a syscall or just yielding.  Might end
138                  * up doing this differently when/if we have more ways to yield. */
139                 if (uthread->sysc) {
140                         uthread->state = UT_BLOCKED;
141                         assert(sched_ops->thread_blockon_sysc);
142                         sched_ops->thread_blockon_sysc(uthread->sysc);
143                 } else { /* generic yield */
144                         uthread->state = UT_RUNNABLE;
145                         assert(sched_ops->thread_yield);
146                         /* 2LS will save the thread somewhere for restarting.  Later on,
147                          * we'll probably have a generic function for all sorts of waiting.
148                          */
149                         sched_ops->thread_yield(uthread);
150                 }
151         } else { /* DYING */
152                 printd("[U] thread %08p on vcore %d is DYING!\n", uthread, vcore_id());
153                 uthread->state = UT_DYING;
154                 /* we alloc and manage the TLS, so lets get rid of it */
155                 __uthread_free_tls(uthread);
156                 /* 2LS specific cleanup */
157                 assert(sched_ops->thread_exit);
158                 sched_ops->thread_exit(uthread);
159         }
160         /* Leave the current vcore completely */
161         current_uthread = NULL;
162         /* Go back to the entry point, where we can handle notifications or
163          * reschedule someone. */
164         uthread_vcore_entry();
165 }
166
167 /* Calling thread yields.  Both exiting and yielding calls this, the difference
168  * is the thread's state (in the flags). */
169 void uthread_yield(void)
170 {
171         struct uthread *uthread = current_uthread;
172         volatile bool yielding = TRUE; /* signal to short circuit when restarting */
173         /* TODO: (HSS) Save silly state */
174         // if (!(uthread->flags & UTHREAD_DYING))
175         //      save_fp_state(&t->as);
176         assert(!in_vcore_context());
177         assert(uthread->state == UT_RUNNING);
178         /* Don't migrate this thread to another vcore, since it depends on being on
179          * the same vcore throughout (once it disables notifs).  The race is that we
180          * read vcoreid, then get interrupted / migrated before disabling notifs. */
181         uthread->flags |= UTHREAD_DONT_MIGRATE;
182         wmb();
183         uint32_t vcoreid = vcore_id();
184         printd("[U] Uthread %08p is yielding on vcore %d\n", uthread, vcoreid);
185         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
186         /* once we do this, we might miss a notif_pending, so we need to enter vcore
187          * entry later.  Need to disable notifs so we don't get in weird loops with
188          * save_ros_tf() and pop_ros_tf(). */
189         disable_notifs(vcoreid);
190         /* take the current state and save it into t->utf when this pthread
191          * restarts, it will continue from right after this, see yielding is false,
192          * and short ciruit the function.  Don't do this if we're dying. */
193         if (!(uthread->flags & UTHREAD_DYING))
194                 save_ros_tf(&uthread->utf);
195         /* Restart path doesn't matter if we're dying */
196         if (!yielding)
197                 goto yield_return_path;
198         yielding = FALSE; /* for when it starts back up */
199         /* Change to the transition context (both TLS and stack). */
200         extern void** vcore_thread_control_blocks;
201         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
202         assert(current_uthread == uthread);     
203         assert(in_vcore_context());     /* technically, we aren't fully in vcore context */
204         /* After this, make sure you don't use local variables.  Also, make sure the
205          * compiler doesn't use them without telling you (TODO).
206          *
207          * In each arch's set_stack_pointer, make sure you subtract off as much room
208          * as you need to any local vars that might be pushed before calling the
209          * next function, or for whatever other reason the compiler/hardware might
210          * walk up the stack a bit when calling a noreturn function. */
211         set_stack_pointer((void*)vcpd->transition_stack);
212         /* Finish exiting in another function. */
213         __uthread_yield();
214         /* Should never get here */
215         assert(0);
216         /* Will jump here when the uthread's trapframe is restarted/popped. */
217 yield_return_path:
218         printd("[U] Uthread %08p returning from a yield!\n", uthread);
219 }
220
221 /* Exits from the uthread.  Tempting to get rid of this function, but we need to
222  * manage the flags so we know to clean up the TLS and stuff later. */
223 void uthread_exit(void)
224 {
225         current_uthread->flags |= UTHREAD_DYING;
226         uthread_yield();
227 }
228
229 /* Attempts to block on sysc, returning when it is done or progress has been
230  * made. */
231 void ros_syscall_blockon(struct syscall *sysc)
232 {
233         if (in_vcore_context()) {
234                 /* vcore's don't know what to do yet, so do the default (spin) */
235                 __ros_syscall_blockon(sysc);
236                 return;
237         }
238         if (!sched_ops->thread_blockon_sysc || !current_uthread) {
239                 /* There isn't a 2LS op for blocking.  Spin for now. */
240                 __ros_syscall_blockon(sysc);
241                 return;
242         }
243         /* double check before doing all this crap */
244         if (sysc->flags & (SC_DONE | SC_PROGRESS))
245                 return;
246         /* So yield knows we are blocking on something */
247         current_uthread->sysc = sysc;
248         uthread_yield();
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. */
313 bool register_evq(struct syscall *sysc, struct event_queue *ev_q)
314 {
315         int old_flags;
316         sysc->ev_q = ev_q;
317         wmb();
318         /* Try and set the SC_UEVENT flag (so the kernel knows to look at ev_q) */
319         do {
320                 old_flags = sysc->flags;
321                 /* If the kernel finishes while we are trying to sign up for an event,
322                  * we need to bail out */
323                 if (old_flags & (SC_DONE | SC_PROGRESS)) {
324                         sysc->ev_q = 0;         /* not necessary, but might help with bugs */
325                         return FALSE;
326                 }
327         } while (!atomic_comp_swap(&sysc->flags, old_flags, old_flags | SC_UEVENT));
328         return TRUE;
329 }
330
331 /* TLS helpers */
332 static int __uthread_allocate_tls(struct uthread *uthread)
333 {
334         assert(!uthread->tls_desc);
335         uthread->tls_desc = allocate_tls();
336         if (!uthread->tls_desc) {
337                 errno = ENOMEM;
338                 return -1;
339         }
340         return 0;
341 }
342
343 static void __uthread_free_tls(struct uthread *uthread)
344 {
345         free_tls(uthread->tls_desc);
346         uthread->tls_desc = NULL;
347 }