Support for blocking and restarting uthreads (XCC)
[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 */
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         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
62
63         /* Should always have notifications disabled when coming in here. */
64         assert(vcpd->notif_enabled == FALSE);
65         assert(in_vcore_context());
66
67         check_preempt_pending(vcoreid);
68         handle_events(vcoreid);
69         assert(in_vcore_context());     /* double check, in case and event changed it */
70         assert(sched_ops->sched_entry);
71         sched_ops->sched_entry();
72         /* 2LS sched_entry should never return */
73         assert(0);
74 }
75
76 /* Creates a uthread.  Will pass udata to sched_ops's thread_create.  For now,
77  * the vcore/default 2ls code handles start routines and args.  Mostly because
78  * this is used when initing a utf, which is vcore specific for now. */
79 struct uthread *uthread_create(void (*func)(void), void *udata)
80 {
81         /* First time through, init the uthread code (which makes a uthread out of
82          * thread0 / the current code.  Could move this to a ctor. */
83         static bool first = TRUE;
84         if (first) {
85                 assert(!uthread_init());
86                 first = FALSE;
87         }
88         assert(!in_vcore_context());
89         assert(sched_ops->thread_create);
90         struct uthread *new_thread = sched_ops->thread_create(func, udata);
91         new_thread->state = UT_CREATED;
92         /* They should have zero'd the uthread.  Let's check critical things: */
93         assert(!new_thread->flags && !new_thread->sysc);
94         /* Get a TLS */
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         /* Don't migrate this thread to another vcore, since it depends on being on
100          * the same vcore throughout. */
101         caller->flags |= UTHREAD_DONT_MIGRATE;
102         wmb();
103         /* Note the first time we call this, we technically aren't on a vcore */
104         uint32_t vcoreid = vcore_id();
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. */
111         wmb();
112         caller->flags &= ~UTHREAD_DONT_MIGRATE;
113         return new_thread;
114 }
115
116 void uthread_runnable(struct uthread *uthread)
117 {
118         /* Allow the 2LS to make the thread runnable, and do whatever. */
119         assert(sched_ops->thread_runnable);
120         uthread->state = UT_RUNNABLE;
121         sched_ops->thread_runnable(uthread);
122
123         /* TODO: consider moving this to the 2LS */
124         /* Ask the 2LS how many vcores it wants, and put in the request. */
125         assert(sched_ops->vcores_wanted);
126         vcore_request(sched_ops->vcores_wanted());
127 }
128
129 /* Need to have this as a separate, non-inlined function since we clobber the
130  * stack pointer before calling it, and don't want the compiler to play games
131  * with my hart. */
132 static void __attribute__((noinline, noreturn)) 
133 __uthread_yield(struct uthread *uthread)
134 {
135         assert(in_vcore_context());
136         assert(uthread->state == UT_RUNNING);
137         assert(uthread == current_uthread);
138         /* Do slightly different things depending on whether or not we're exiting.
139          * While it is tempting to get rid of the UTHREAD_DYING flag and have
140          * callers just set the thread state, we'd lose the ability to assert
141          * UT_RUNNING, which helps catch bugs. */
142         if (!(uthread->flags & UTHREAD_DYING)) {
143                 uthread->flags &= ~UTHREAD_DONT_MIGRATE;
144                 /* Determine if we're blocking on a syscall or just yielding.  Might end
145                  * up doing this differently when/if we have more ways to yield. */
146                 if (uthread->sysc) {
147                         uthread->state = UT_BLOCKED;
148                         assert(sched_ops->thread_blockon_sysc);
149                         sched_ops->thread_blockon_sysc(uthread->sysc);
150                 } else { /* generic yield */
151                         uthread->state = UT_RUNNABLE;
152                         assert(sched_ops->thread_yield);
153                         /* 2LS will save the thread somewhere for restarting.  Later on,
154                          * we'll probably have a generic function for all sorts of waiting.
155                          */
156                         sched_ops->thread_yield(uthread);
157                 }
158         } else { /* DYING */
159                 printd("[U] thread %08p on vcore %d is DYING!\n", uthread, vcore_id());
160                 uthread->state = UT_DYING;
161                 /* we alloc and manage the TLS, so lets get rid of it */
162                 __uthread_free_tls(uthread);
163                 /* 2LS specific cleanup */
164                 assert(sched_ops->thread_exit);
165                 sched_ops->thread_exit(uthread);
166         }
167         /* Leave the current vcore completely */
168         current_uthread = NULL;
169         /* Go back to the entry point, where we can handle notifications or
170          * reschedule someone. */
171         uthread_vcore_entry();
172 }
173
174 /* Calling thread yields.  Both exiting and yielding calls this, the difference
175  * is the thread's state (in the flags). */
176 void uthread_yield(void)
177 {
178         struct uthread *uthread = current_uthread;
179         volatile bool yielding = TRUE; /* signal to short circuit when restarting */
180         /* TODO: (HSS) Save silly state */
181         // if (!(uthread->flags & UTHREAD_DYING))
182         //      save_fp_state(&t->as);
183         assert(!in_vcore_context());
184         /* Don't migrate this thread to another vcore, since it depends on being on
185          * the same vcore throughout (once it disables notifs).  The race is that we
186          * read vcoreid, then get interrupted / migrated before disabling notifs. */
187         uthread->flags |= UTHREAD_DONT_MIGRATE;
188         wmb();
189         uint32_t vcoreid = vcore_id();
190         printd("[U] Uthread %08p is yielding on vcore %d\n", uthread, vcoreid);
191         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
192         /* once we do this, we might miss a notif_pending, so we need to enter vcore
193          * entry later.  Need to disable notifs so we don't get in weird loops with
194          * save_ros_tf() and pop_ros_tf(). */
195         disable_notifs(vcoreid);
196         /* take the current state and save it into t->utf when this pthread
197          * restarts, it will continue from right after this, see yielding is false,
198          * and short ciruit the function.  Don't do this if we're dying. */
199         if (!(uthread->flags & UTHREAD_DYING))
200                 save_ros_tf(&uthread->utf);
201         /* Restart path doesn't matter if we're dying */
202         if (!yielding)
203                 goto yield_return_path;
204         yielding = FALSE; /* for when it starts back up */
205         /* Change to the transition context (both TLS and stack). */
206         extern void** vcore_thread_control_blocks;
207         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
208         assert(current_uthread == uthread);     
209         assert(in_vcore_context());     /* technically, we aren't fully in vcore context */
210         /* After this, make sure you don't use local variables.  Also, make sure the
211          * compiler doesn't use them without telling you (TODO).
212          *
213          * In each arch's set_stack_pointer, make sure you subtract off as much room
214          * as you need to any local vars that might be pushed before calling the
215          * next function, or for whatever other reason the compiler/hardware might
216          * walk up the stack a bit when calling a noreturn function. */
217         set_stack_pointer((void*)vcpd->transition_stack);
218         /* Finish exiting in another function. */
219         __uthread_yield(current_uthread);
220         /* Should never get here */
221         assert(0);
222         /* Will jump here when the uthread's trapframe is restarted/popped. */
223 yield_return_path:
224         printd("[U] Uthread %08p returning from a yield!\n", uthread);
225 }
226
227 /* Exits from the uthread.  Tempting to get rid of this function, but we need to
228  * manage the flags so we know to clean up the TLS and stuff later. */
229 void uthread_exit(void)
230 {
231         current_uthread->flags |= UTHREAD_DYING;
232         assert(!in_vcore_context());    /* try and catch the yield bug */
233         uthread_yield();
234 }
235
236 /* Attempts to block on sysc, returning when it is done or progress has been
237  * made. */
238 void ros_syscall_blockon(struct syscall *sysc)
239 {
240         if (in_vcore_context()) {
241                 /* vcore's don't know what to do yet, so do the default (spin) */
242                 __ros_syscall_blockon(sysc);
243                 return;
244         }
245         if (!sched_ops->thread_blockon_sysc || !current_uthread) {
246                 /* There isn't a 2LS op for blocking.  Spin for now. */
247                 __ros_syscall_blockon(sysc);
248                 return;
249         }
250         /* double check before doing all this crap */
251         if (sysc->flags & (SC_DONE | SC_PROGRESS))
252                 return;
253         /* So yield knows we are blocking on something */
254         current_uthread->sysc = sysc;
255         assert(!in_vcore_context());    /* try and catch the yield bug */
256         uthread_yield();
257 }
258
259 /* Runs whatever thread is vcore's current_uthread */
260 void run_current_uthread(void)
261 {
262         uint32_t vcoreid = vcore_id();
263         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
264         assert(current_uthread);
265         assert(current_uthread->state == UT_RUNNING);
266         printd("[U] Vcore %d is restarting uthread %d\n", vcoreid, uthread->id);
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 /* Launches the uthread on the vcore.  Don't call this on current_uthread. */
275 void run_uthread(struct uthread *uthread)
276 {
277         assert(uthread != current_uthread);
278         if (uthread->state != UT_RUNNABLE) {
279                 /* had vcore3 throw this, when the UT blocked on vcore1 and didn't come
280                  * back up yet (kernel didn't wake up, didn't send IPI) */
281                 printf("Uthread %08p not runnable (was %d) in run_uthread on vcore %d!\n",
282                        uthread, uthread->state, vcore_id());
283         }
284         assert(uthread->state == UT_RUNNABLE);
285         uthread->state = UT_RUNNING;
286         /* Save a ptr to the pthread running in the transition context's TLS */
287         uint32_t vcoreid = vcore_id();
288         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
289         current_uthread = uthread;
290         clear_notif_pending(vcoreid);
291         set_tls_desc(uthread->tls_desc, vcoreid);
292         /* Load silly state (Floating point) too.  For real */
293         /* TODO: (HSS) */
294         /* Pop the user trap frame */
295         pop_ros_tf(&uthread->utf, vcoreid);
296         assert(0);
297 }
298
299 /* Deals with a pending preemption (checks, responds).  If the 2LS registered a
300  * function, it will get run.  Returns true if you got preempted.  Called
301  * 'check' instead of 'handle', since this isn't an event handler.  It's the "Oh
302  * shit a preempt is on its way ASAP".  While it is isn't too involved with
303  * uthreads, it is tied in to sched_ops. */
304 bool check_preempt_pending(uint32_t vcoreid)
305 {
306         bool retval = FALSE;
307         if (__procinfo.vcoremap[vcoreid].preempt_pending) {
308                 retval = TRUE;
309                 if (sched_ops->preempt_pending)
310                         sched_ops->preempt_pending();
311                 /* this tries to yield, but will pop back up if this was a spurious
312                  * preempt_pending. */
313                 sys_yield(TRUE);
314         }
315         return retval;
316 }
317
318 /* Attempts to register ev_q with sysc, so long as sysc is not done/progress.
319  * Returns true if it succeeded, and false otherwise. */
320 bool register_evq(struct syscall *sysc, struct event_queue *ev_q)
321 {
322         int old_flags;
323         sysc->ev_q = ev_q;
324         wmb();
325         /* Try and set the SC_UEVENT flag (so the kernel knows to look at ev_q) */
326         do {
327                 old_flags = sysc->flags;
328                 /* If the kernel finishes while we are trying to sign up for an event,
329                  * we need to bail out */
330                 if (old_flags & (SC_DONE | SC_PROGRESS)) {
331                         sysc->ev_q = 0;         /* not necessary, but might help with bugs */
332                         return FALSE;
333                 }
334         } while (!atomic_comp_swap(&sysc->flags, old_flags, old_flags | SC_UEVENT));
335         return TRUE;
336 }
337
338 /* TLS helpers */
339 static int __uthread_allocate_tls(struct uthread *uthread)
340 {
341         assert(!uthread->tls_desc);
342         uthread->tls_desc = allocate_tls();
343         if (!uthread->tls_desc) {
344                 errno = ENOMEM;
345                 return -1;
346         }
347         return 0;
348 }
349
350 static void __uthread_free_tls(struct uthread *uthread)
351 {
352         free_tls(uthread->tls_desc);
353         uthread->tls_desc = NULL;
354 }