uthread_exit() replaced with uthread_destroy()
[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         /* Note: we no longer care if the thread is exiting, the 2LS will call
142          * uthread_destroy() */
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         /* Leave the current vcore completely */
159         current_uthread = NULL;
160         /* Go back to the entry point, where we can handle notifications or
161          * reschedule someone. */
162         uthread_vcore_entry();
163 }
164
165 /* Calling thread yields.  Both exiting and yielding calls this, the difference
166  * is the thread's state (in the flags). */
167 void uthread_yield(bool save_state)
168 {
169         struct uthread *uthread = current_uthread;
170         volatile bool yielding = TRUE; /* signal to short circuit when restarting */
171         /* TODO: (HSS) Save silly state */
172         // if (save_state)
173         //      save_fp_state(&t->as);
174         assert(!in_vcore_context());
175         assert(uthread->state == UT_RUNNING);
176         /* Don't migrate this thread to another vcore, since it depends on being on
177          * the same vcore throughout (once it disables notifs).  The race is that we
178          * read vcoreid, then get interrupted / migrated before disabling notifs. */
179         uthread->flags |= UTHREAD_DONT_MIGRATE;
180         wmb();
181         uint32_t vcoreid = vcore_id();
182         printd("[U] Uthread %08p is yielding on vcore %d\n", uthread, vcoreid);
183         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
184         /* once we do this, we might miss a notif_pending, so we need to enter vcore
185          * entry later.  Need to disable notifs so we don't get in weird loops with
186          * save_ros_tf() and pop_ros_tf(). */
187         disable_notifs(vcoreid);
188         /* take the current state and save it into t->utf when this pthread
189          * restarts, it will continue from right after this, see yielding is false,
190          * and short ciruit the function.  Don't do this if we're dying. */
191         if (save_state)
192                 save_ros_tf(&uthread->utf);
193         /* Restart path doesn't matter if we're dying */
194         if (!yielding)
195                 goto yield_return_path;
196         yielding = FALSE; /* for when it starts back up */
197         /* Change to the transition context (both TLS and stack). */
198         extern void** vcore_thread_control_blocks;
199         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
200         assert(current_uthread == uthread);     
201         assert(in_vcore_context());     /* technically, we aren't fully in vcore context */
202         /* After this, make sure you don't use local variables.  Also, make sure the
203          * compiler doesn't use them without telling you (TODO).
204          *
205          * In each arch's set_stack_pointer, make sure you subtract off as much room
206          * as you need to any local vars that might be pushed before calling the
207          * next function, or for whatever other reason the compiler/hardware might
208          * walk up the stack a bit when calling a noreturn function. */
209         set_stack_pointer((void*)vcpd->transition_stack);
210         /* Finish exiting in another function. */
211         __uthread_yield();
212         /* Should never get here */
213         assert(0);
214         /* Will jump here when the uthread's trapframe is restarted/popped. */
215 yield_return_path:
216         printd("[U] Uthread %08p returning from a yield!\n", uthread);
217 }
218
219 /* Destroys the uthread.  If you want to destroy a currently running uthread,
220  * you'll want something like pthread_exit(), which yields, and calls this from
221  * its sched_ops yield. */
222 void uthread_destroy(struct uthread *uthread)
223 {
224         printd("[U] thread %08p on vcore %d is DYING!\n", uthread, vcore_id());
225         uthread->state = UT_DYING;
226         /* we alloc and manage the TLS, so lets get rid of it */
227         __uthread_free_tls(uthread);
228         assert(sched_ops->thread_destroy);
229         sched_ops->thread_destroy(uthread);
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 || !in_multi_mode()) {
242                 /* There isn't a 2LS op for blocking, or we're _S.  Spin for now. */
243                 __ros_syscall_blockon(sysc);
244                 return;
245         }
246         /* double check before doing all this crap */
247         if (atomic_read(&sysc->flags) & (SC_DONE | SC_PROGRESS))
248                 return;
249         /* So yield knows we are blocking on something */
250         assert(current_uthread);
251         current_uthread->sysc = sysc;
252         uthread_yield(TRUE);
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 %08p\n", vcoreid,
263                current_uthread);
264         clear_notif_pending(vcoreid);
265         set_tls_desc(current_uthread->tls_desc, vcoreid);
266         /* Pop the user trap frame */
267         pop_ros_tf(&vcpd->notif_tf, vcoreid);
268         assert(0);
269 }
270
271 /* Launches the uthread on the vcore.  Don't call this on current_uthread. */
272 void run_uthread(struct uthread *uthread)
273 {
274         assert(uthread != current_uthread);
275         if (uthread->state != UT_RUNNABLE) {
276                 /* had vcore3 throw this, when the UT blocked on vcore1 and didn't come
277                  * back up yet (kernel didn't wake up, didn't send IPI) */
278                 printf("Uthread %08p not runnable (was %d) in run_uthread on vcore %d!\n",
279                        uthread, uthread->state, vcore_id());
280         }
281         assert(uthread->state == UT_RUNNABLE);
282         uthread->state = UT_RUNNING;
283         /* Save a ptr to the pthread running in the transition context's TLS */
284         uint32_t vcoreid = vcore_id();
285         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
286         current_uthread = uthread;
287         clear_notif_pending(vcoreid);
288         set_tls_desc(uthread->tls_desc, vcoreid);
289         /* Load silly state (Floating point) too.  For real */
290         /* TODO: (HSS) */
291         /* Pop the user trap frame */
292         pop_ros_tf(&uthread->utf, vcoreid);
293         assert(0);
294 }
295
296 /* Deals with a pending preemption (checks, responds).  If the 2LS registered a
297  * function, it will get run.  Returns true if you got preempted.  Called
298  * 'check' instead of 'handle', since this isn't an event handler.  It's the "Oh
299  * shit a preempt is on its way ASAP".  While it is isn't too involved with
300  * uthreads, it is tied in to sched_ops. */
301 bool check_preempt_pending(uint32_t vcoreid)
302 {
303         bool retval = FALSE;
304         if (__procinfo.vcoremap[vcoreid].preempt_pending) {
305                 retval = TRUE;
306                 if (sched_ops->preempt_pending)
307                         sched_ops->preempt_pending();
308                 /* this tries to yield, but will pop back up if this was a spurious
309                  * preempt_pending. */
310                 sys_yield(TRUE);
311         }
312         return retval;
313 }
314
315 /* Attempts to register ev_q with sysc, so long as sysc is not done/progress.
316  * Returns true if it succeeded, and false otherwise.  False means that the
317  * syscall is done, and does not need an event set (and should be handled
318  * accordingly)*/
319 bool register_evq(struct syscall *sysc, struct event_queue *ev_q)
320 {
321         int old_flags;
322         sysc->ev_q = ev_q;
323         wmb();
324         /* Try and set the SC_UEVENT flag (so the kernel knows to look at ev_q) */
325         do {
326                 cmb();
327                 old_flags = atomic_read(&sysc->flags);
328                 /* Spin if the kernel is mucking with syscall flags */
329                 while (old_flags & SC_K_LOCK)
330                         old_flags = atomic_read(&sysc->flags);
331                 /* If the kernel finishes while we are trying to sign up for an event,
332                  * we need to bail out */
333                 if (old_flags & (SC_DONE | SC_PROGRESS)) {
334                         sysc->ev_q = 0;         /* not necessary, but might help with bugs */
335                         return FALSE;
336                 }
337         } while (!atomic_cas(&sysc->flags, old_flags, old_flags | SC_UEVENT));
338         return TRUE;
339 }
340
341 /* De-registers a syscall, so that the kernel will not send an event when it is
342  * done.  The call could already be SC_DONE, or could even finish while we try
343  * to unset SC_UEVENT.
344  *
345  * There is a chance the kernel sent an event if you didn't do this in time, but
346  * once this returns, the kernel won't send a message.
347  *
348  * If the kernel is trying to send a message right now, this will spin (on
349  * SC_K_LOCK).  We need to make sure we deregistered, and that if a message
350  * is coming, that it already was sent (and possibly overflowed), before
351  * returning. */
352 void deregister_evq(struct syscall *sysc)
353 {
354         int old_flags;
355         sysc->ev_q = 0;
356         /* Try and unset the SC_UEVENT flag */
357         do {
358                 cmb();
359                 old_flags = atomic_read(&sysc->flags);
360                 /* Spin if the kernel is mucking with syscall flags */
361                 while (old_flags & SC_K_LOCK)
362                         old_flags = atomic_read(&sysc->flags);
363                 /* Note we don't care if the SC_DONE flag is getting set.  We just need
364                  * to avoid clobbering flags */
365         } while (!atomic_cas(&sysc->flags, old_flags, old_flags & ~SC_UEVENT));
366 }
367
368 /* TLS helpers */
369 static int __uthread_allocate_tls(struct uthread *uthread)
370 {
371         assert(!uthread->tls_desc);
372         uthread->tls_desc = allocate_tls();
373         if (!uthread->tls_desc) {
374                 errno = ENOMEM;
375                 return -1;
376         }
377         return 0;
378 }
379
380 static void __uthread_free_tls(struct uthread *uthread)
381 {
382         free_tls(uthread->tls_desc);
383         uthread->tls_desc = NULL;
384 }