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