Fixes mhello to play nice with uthread
[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         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
124 /* Need to have this as a separate, non-inlined function since we clobber the
125  * stack pointer before calling it, and don't want the compiler to play games
126  * with my hart. */
127 static void __attribute__((noinline, noreturn)) 
128 __uthread_yield(void)
129 {
130         struct uthread *uthread = current_uthread;
131         assert(in_vcore_context());
132         assert(uthread->state == UT_RUNNING);
133         assert(uthread == current_uthread);
134         /* Do slightly different things depending on whether or not we're exiting.
135          * While it is tempting to get rid of the UTHREAD_DYING flag and have
136          * callers just set the thread state, we'd lose the ability to assert
137          * UT_RUNNING, which helps catch bugs. */
138         if (!(uthread->flags & UTHREAD_DYING)) {
139                 uthread->flags &= ~UTHREAD_DONT_MIGRATE;
140                 /* Determine if we're blocking on a syscall or just yielding.  Might end
141                  * up doing this differently when/if we have more ways to yield. */
142                 if (uthread->sysc) {
143                         uthread->state = UT_BLOCKED;
144                         assert(sched_ops->thread_blockon_sysc);
145                         sched_ops->thread_blockon_sysc(uthread->sysc);
146                 } else { /* generic yield */
147                         uthread->state = UT_RUNNABLE;
148                         assert(sched_ops->thread_yield);
149                         /* 2LS will save the thread somewhere for restarting.  Later on,
150                          * we'll probably have a generic function for all sorts of waiting.
151                          */
152                         sched_ops->thread_yield(uthread);
153                 }
154         } else { /* DYING */
155                 printd("[U] thread %08p on vcore %d is DYING!\n", uthread, vcore_id());
156                 uthread->state = UT_DYING;
157                 /* we alloc and manage the TLS, so lets get rid of it */
158                 __uthread_free_tls(uthread);
159                 /* 2LS specific cleanup */
160                 assert(sched_ops->thread_exit);
161                 sched_ops->thread_exit(uthread);
162         }
163         /* Leave the current vcore completely */
164         current_uthread = NULL;
165         /* Go back to the entry point, where we can handle notifications or
166          * reschedule someone. */
167         uthread_vcore_entry();
168 }
169
170 /* Calling thread yields.  Both exiting and yielding calls this, the difference
171  * is the thread's state (in the flags). */
172 void uthread_yield(void)
173 {
174         struct uthread *uthread = current_uthread;
175         volatile bool yielding = TRUE; /* signal to short circuit when restarting */
176         /* TODO: (HSS) Save silly state */
177         // if (!(uthread->flags & UTHREAD_DYING))
178         //      save_fp_state(&t->as);
179         assert(!in_vcore_context());
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         wmb();
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 (!(uthread->flags & UTHREAD_DYING))
196                 save_ros_tf(&uthread->utf);
197         /* Restart path doesn't matter if we're dying */
198         if (!yielding)
199                 goto yield_return_path;
200         yielding = FALSE; /* for when it starts back up */
201         /* Change to the transition context (both TLS and stack). */
202         extern void** vcore_thread_control_blocks;
203         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
204         assert(current_uthread == uthread);     
205         assert(in_vcore_context());     /* technically, we aren't fully in vcore context */
206         /* After this, make sure you don't use local variables.  Also, make sure the
207          * compiler doesn't use them without telling you (TODO).
208          *
209          * In each arch's set_stack_pointer, make sure you subtract off as much room
210          * as you need to any local vars that might be pushed before calling the
211          * next function, or for whatever other reason the compiler/hardware might
212          * walk up the stack a bit when calling a noreturn function. */
213         set_stack_pointer((void*)vcpd->transition_stack);
214         /* Finish exiting in another function. */
215         __uthread_yield();
216         /* Should never get here */
217         assert(0);
218         /* Will jump here when the uthread's trapframe is restarted/popped. */
219 yield_return_path:
220         printd("[U] Uthread %08p returning from a yield!\n", uthread);
221 }
222
223 /* Exits from the uthread.  Tempting to get rid of this function, but we need to
224  * manage the flags so we know to clean up the TLS and stuff later. */
225 void uthread_exit(void)
226 {
227         current_uthread->flags |= UTHREAD_DYING;
228         assert(!in_vcore_context());    /* try and catch the yield bug */
229         uthread_yield();
230 }
231
232 /* Attempts to block on sysc, returning when it is done or progress has been
233  * made. */
234 void ros_syscall_blockon(struct syscall *sysc)
235 {
236         if (in_vcore_context()) {
237                 /* vcore's don't know what to do yet, so do the default (spin) */
238                 __ros_syscall_blockon(sysc);
239                 return;
240         }
241         if (!sched_ops->thread_blockon_sysc || !current_uthread) {
242                 /* There isn't a 2LS op for blocking.  Spin for now. */
243                 __ros_syscall_blockon(sysc);
244                 return;
245         }
246         /* double check before doing all this crap */
247         if (sysc->flags & (SC_DONE | SC_PROGRESS))
248                 return;
249         /* So yield knows we are blocking on something */
250         current_uthread->sysc = sysc;
251         assert(!in_vcore_context());    /* try and catch the yield bug */
252         uthread_yield();
253 }
254
255 /* Runs whatever thread is vcore's current_uthread */
256 void run_current_uthread(void)
257 {
258         uint32_t vcoreid = vcore_id();
259         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
260         assert(current_uthread);
261         assert(current_uthread->state == UT_RUNNING);
262         printd("[U] Vcore %d is restarting uthread %d\n", vcoreid, uthread->id);
263         clear_notif_pending(vcoreid);
264         set_tls_desc(current_uthread->tls_desc, vcoreid);
265         /* Pop the user trap frame */
266         pop_ros_tf(&vcpd->notif_tf, vcoreid);
267         assert(0);
268 }
269
270 /* Launches the uthread on the vcore.  Don't call this on current_uthread. */
271 void run_uthread(struct uthread *uthread)
272 {
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 pthread running in the transition context's TLS */
283         uint32_t vcoreid = vcore_id();
284         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
285         current_uthread = uthread;
286         clear_notif_pending(vcoreid);
287         set_tls_desc(uthread->tls_desc, vcoreid);
288         /* Load silly state (Floating point) too.  For real */
289         /* TODO: (HSS) */
290         /* Pop the user trap frame */
291         pop_ros_tf(&uthread->utf, vcoreid);
292         assert(0);
293 }
294
295 /* Deals with a pending preemption (checks, responds).  If the 2LS registered a
296  * function, it will get run.  Returns true if you got preempted.  Called
297  * 'check' instead of 'handle', since this isn't an event handler.  It's the "Oh
298  * shit a preempt is on its way ASAP".  While it is isn't too involved with
299  * uthreads, it is tied in to sched_ops. */
300 bool check_preempt_pending(uint32_t vcoreid)
301 {
302         bool retval = FALSE;
303         if (__procinfo.vcoremap[vcoreid].preempt_pending) {
304                 retval = TRUE;
305                 if (sched_ops->preempt_pending)
306                         sched_ops->preempt_pending();
307                 /* this tries to yield, but will pop back up if this was a spurious
308                  * preempt_pending. */
309                 sys_yield(TRUE);
310         }
311         return retval;
312 }
313
314 /* Attempts to register ev_q with sysc, so long as sysc is not done/progress.
315  * Returns true if it succeeded, and false otherwise. */
316 bool register_evq(struct syscall *sysc, struct event_queue *ev_q)
317 {
318         int old_flags;
319         sysc->ev_q = ev_q;
320         wmb();
321         /* Try and set the SC_UEVENT flag (so the kernel knows to look at ev_q) */
322         do {
323                 old_flags = sysc->flags;
324                 /* If the kernel finishes while we are trying to sign up for an event,
325                  * we need to bail out */
326                 if (old_flags & (SC_DONE | SC_PROGRESS)) {
327                         sysc->ev_q = 0;         /* not necessary, but might help with bugs */
328                         return FALSE;
329                 }
330         } while (!atomic_comp_swap(&sysc->flags, old_flags, old_flags | SC_UEVENT));
331         return TRUE;
332 }
333
334 /* TLS helpers */
335 static int __uthread_allocate_tls(struct uthread *uthread)
336 {
337         assert(!uthread->tls_desc);
338         uthread->tls_desc = allocate_tls();
339         if (!uthread->tls_desc) {
340                 errno = ENOMEM;
341                 return -1;
342         }
343         return 0;
344 }
345
346 static void __uthread_free_tls(struct uthread *uthread)
347 {
348         free_tls(uthread->tls_desc);
349         uthread->tls_desc = NULL;
350 }