29c4240b11a4ada687dfc2ee41787f23fa53c4fa
[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
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(struct uthread *uthread)
129 {
130         assert(in_vcore_context());
131         assert(uthread->state == UT_RUNNING);
132         assert(uthread == current_uthread);
133         /* Do slightly different things depending on whether or not we're exiting.
134          * While it is tempting to get rid of the UTHREAD_DYING flag and have
135          * callers just set the thread state, we'd lose the ability to assert
136          * UT_RUNNING, which helps catch bugs. */
137         if (!(uthread->flags & UTHREAD_DYING)) {
138                 uthread->flags &= ~UTHREAD_DONT_MIGRATE;
139                 /* Determine if we're blocking on a syscall or just yielding.  Might end
140                  * up doing this differently when/if we have more ways to yield. */
141                 if (uthread->sysc) {
142                         uthread->state = UT_BLOCKED;
143                         assert(sched_ops->thread_blockon_sysc);
144                         sched_ops->thread_blockon_sysc(uthread->sysc);
145                 } else { /* generic yield */
146                         uthread->state = UT_RUNNABLE;
147                         assert(sched_ops->thread_yield);
148                         /* 2LS will save the thread somewhere for restarting.  Later on,
149                          * we'll probably have a generic function for all sorts of waiting.
150                          */
151                         sched_ops->thread_yield(uthread);
152                 }
153         } else { /* DYING */
154                 printd("[U] thread %08p on vcore %d is DYING!\n", uthread, vcore_id());
155                 uthread->state = UT_DYING;
156                 /* we alloc and manage the TLS, so lets get rid of it */
157                 __uthread_free_tls(uthread);
158                 /* 2LS specific cleanup */
159                 assert(sched_ops->thread_exit);
160                 sched_ops->thread_exit(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(void)
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 (!(uthread->flags & UTHREAD_DYING))
177         //      save_fp_state(&t->as);
178         assert(!in_vcore_context());
179         /* Don't migrate this thread to another vcore, since it depends on being on
180          * the same vcore throughout (once it disables notifs).  The race is that we
181          * read vcoreid, then get interrupted / migrated before disabling notifs. */
182         uthread->flags |= UTHREAD_DONT_MIGRATE;
183         wmb();
184         uint32_t vcoreid = vcore_id();
185         printd("[U] Uthread %08p is yielding on vcore %d\n", uthread, vcoreid);
186         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
187         /* once we do this, we might miss a notif_pending, so we need to enter vcore
188          * entry later.  Need to disable notifs so we don't get in weird loops with
189          * save_ros_tf() and pop_ros_tf(). */
190         disable_notifs(vcoreid);
191         /* take the current state and save it into t->utf when this pthread
192          * restarts, it will continue from right after this, see yielding is false,
193          * and short ciruit the function.  Don't do this if we're dying. */
194         if (!(uthread->flags & UTHREAD_DYING))
195                 save_ros_tf(&uthread->utf);
196         /* Restart path doesn't matter if we're dying */
197         if (!yielding)
198                 goto yield_return_path;
199         yielding = FALSE; /* for when it starts back up */
200         /* Change to the transition context (both TLS and stack). */
201         extern void** vcore_thread_control_blocks;
202         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
203         assert(current_uthread == uthread);     
204         assert(in_vcore_context());     /* technically, we aren't fully in vcore context */
205         /* After this, make sure you don't use local variables.  Also, make sure the
206          * compiler doesn't use them without telling you (TODO).
207          *
208          * In each arch's set_stack_pointer, make sure you subtract off as much room
209          * as you need to any local vars that might be pushed before calling the
210          * next function, or for whatever other reason the compiler/hardware might
211          * walk up the stack a bit when calling a noreturn function. */
212         set_stack_pointer((void*)vcpd->transition_stack);
213         /* Finish exiting in another function. */
214         __uthread_yield(current_uthread);
215         /* Should never get here */
216         assert(0);
217         /* Will jump here when the uthread's trapframe is restarted/popped. */
218 yield_return_path:
219         printd("[U] Uthread %08p returning from a yield!\n", uthread);
220 }
221
222 /* Exits from the uthread.  Tempting to get rid of this function, but we need to
223  * manage the flags so we know to clean up the TLS and stuff later. */
224 void uthread_exit(void)
225 {
226         current_uthread->flags |= UTHREAD_DYING;
227         assert(!in_vcore_context());    /* try and catch the yield bug */
228         uthread_yield();
229 }
230
231 /* Attempts to block on sysc, returning when it is done or progress has been
232  * made. */
233 void ros_syscall_blockon(struct syscall *sysc)
234 {
235         if (in_vcore_context()) {
236                 /* vcore's don't know what to do yet, so do the default (spin) */
237                 __ros_syscall_blockon(sysc);
238                 return;
239         }
240         if (!sched_ops->thread_blockon_sysc || !current_uthread) {
241                 /* There isn't a 2LS op for blocking.  Spin for now. */
242                 __ros_syscall_blockon(sysc);
243                 return;
244         }
245         /* double check before doing all this crap */
246         if (sysc->flags & (SC_DONE | SC_PROGRESS))
247                 return;
248         /* So yield knows we are blocking on something */
249         current_uthread->sysc = sysc;
250         assert(!in_vcore_context());    /* try and catch the yield bug */
251         uthread_yield();
252 }
253
254 /* Runs whatever thread is vcore's current_uthread */
255 void run_current_uthread(void)
256 {
257         uint32_t vcoreid = vcore_id();
258         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
259         assert(current_uthread);
260         assert(current_uthread->state == UT_RUNNING);
261         printd("[U] Vcore %d is restarting uthread %d\n", vcoreid, uthread->id);
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         assert(uthread != current_uthread);
273         if (uthread->state != UT_RUNNABLE) {
274                 /* had vcore3 throw this, when the UT blocked on vcore1 and didn't come
275                  * back up yet (kernel didn't wake up, didn't send IPI) */
276                 printf("Uthread %08p not runnable (was %d) in run_uthread on vcore %d!\n",
277                        uthread, uthread->state, vcore_id());
278         }
279         assert(uthread->state == UT_RUNNABLE);
280         uthread->state = UT_RUNNING;
281         /* Save a ptr to the pthread running in the transition context's TLS */
282         uint32_t vcoreid = vcore_id();
283         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
284         current_uthread = uthread;
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. */
308                 sys_yield(TRUE);
309         }
310         return retval;
311 }
312
313 /* Attempts to register ev_q with sysc, so long as sysc is not done/progress.
314  * Returns true if it succeeded, and false otherwise. */
315 bool register_evq(struct syscall *sysc, struct event_queue *ev_q)
316 {
317         int old_flags;
318         sysc->ev_q = ev_q;
319         wmb();
320         /* Try and set the SC_UEVENT flag (so the kernel knows to look at ev_q) */
321         do {
322                 old_flags = sysc->flags;
323                 /* If the kernel finishes while we are trying to sign up for an event,
324                  * we need to bail out */
325                 if (old_flags & (SC_DONE | SC_PROGRESS)) {
326                         sysc->ev_q = 0;         /* not necessary, but might help with bugs */
327                         return FALSE;
328                 }
329         } while (!atomic_comp_swap(&sysc->flags, old_flags, old_flags | SC_UEVENT));
330         return TRUE;
331 }
332
333 /* TLS helpers */
334 static int __uthread_allocate_tls(struct uthread *uthread)
335 {
336         assert(!uthread->tls_desc);
337         uthread->tls_desc = allocate_tls();
338         if (!uthread->tls_desc) {
339                 errno = ENOMEM;
340                 return -1;
341         }
342         return 0;
343 }
344
345 static void __uthread_free_tls(struct uthread *uthread)
346 {
347         free_tls(uthread->tls_desc);
348         uthread->tls_desc = NULL;
349 }