Send preemption messages (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 /* ev_q for all preempt messages (handled here to keep 2LSs from worrying
15  * extensively about the details.  Will call out when necessary. */
16 struct event_queue *preempt_ev_q;
17
18 /* static helpers: */
19 static int __uthread_allocate_tls(struct uthread *uthread);
20 static int __uthread_reinit_tls(struct uthread *uthread);
21 static void __uthread_free_tls(struct uthread *uthread);
22 static void __run_current_uthread_raw(void);
23 static void handle_vc_preempt(struct event_msg *ev_msg, unsigned int ev_type);
24
25 /* The real 2LS calls this, passing in a uthread representing thread0.  When it
26  * returns, you're in _M mode, still running thread0, on vcore0 */
27 int uthread_lib_init(struct uthread *uthread)
28 {
29         /* Make sure this only runs once */
30         static bool initialized = FALSE;
31         if (initialized)
32                 return -1;
33         initialized = TRUE;
34         /* Init the vcore system */
35         assert(!vcore_init());
36         assert(uthread);
37         /* Save a pointer to thread0's tls region (the glibc one) into its tcb */
38         uthread->tls_desc = get_tls_desc(0);
39         /* Save a pointer to the uthread in its own TLS */
40         current_uthread = uthread;
41         /* Thread is currently running (it is 'us') */
42         uthread->state = UT_RUNNING;
43         /* Change temporarily to vcore0s tls region so we can save the newly created
44          * tcb into its current_uthread variable and then restore it.  One minor
45          * issue is that vcore0's transition-TLS isn't TLS_INITed yet.  Until it is
46          * (right before vcore_entry(), don't try and take the address of any of
47          * its TLS vars. */
48         extern void** vcore_thread_control_blocks;
49         set_tls_desc(vcore_thread_control_blocks[0], 0);
50         current_uthread = uthread;
51         set_tls_desc(uthread->tls_desc, 0);
52         assert(!in_vcore_context());
53         /* don't forget to enable notifs on vcore0.  if you don't, the kernel will
54          * restart your _S with notifs disabled, which is a path to confusion. */
55         __enable_notifs(0);
56         /* Receive preemption events */
57         ev_handlers[EV_VCORE_PREEMPT] = handle_vc_preempt;
58         preempt_ev_q = get_big_event_q();
59         preempt_ev_q->ev_flags = EVENT_IPI | EVENT_INDIR | EVENT_FALLBACK |
60                                  EVENT_NOTHROTTLE | EVENT_VCORE_MUST_RUN;
61         register_kevent_q(preempt_ev_q, EV_VCORE_PREEMPT);
62         printd("[user] registered %08p (flags %08p) for preempt messages\n",
63                preempt_ev_q, preempt_ev_q->ev_flags);
64         /* Get ourselves into _M mode.  Could consider doing this elsewhere... */
65         while (!in_multi_mode()) {
66                 vcore_request(1);
67                 /* TODO: consider blocking */
68                 cpu_relax();
69         }
70         return 0;
71 }
72
73 /* 2LSs shouldn't call uthread_vcore_entry directly */
74 void __attribute__((noreturn)) uthread_vcore_entry(void)
75 {
76         uint32_t vcoreid = vcore_id();
77         /* Should always have notifications disabled when coming in here. */
78         assert(!notif_is_enabled(vcoreid));
79         assert(in_vcore_context());
80         /* If we have a current uthread that is DONT_MIGRATE, pop it real quick and
81          * let it disable notifs (like it wants to).  It's important that we don't
82          * check messages/handle events with a DONT_MIGRATE uthread. */
83         if (current_uthread && (current_uthread->flags & UTHREAD_DONT_MIGRATE))
84                 __run_current_uthread_raw();
85         /* Otherwise, go about our usual vcore business (messages, etc). */
86         check_preempt_pending(vcoreid);
87         handle_events(vcoreid);
88         assert(in_vcore_context());     /* double check, in case an event changed it */
89         assert(sched_ops->sched_entry);
90         sched_ops->sched_entry();
91         /* 2LS sched_entry should never return */
92         assert(0);
93 }
94
95 /* Does the uthread initialization of a uthread that the caller created.  Call
96  * this whenever you are "starting over" with a thread. */
97 void uthread_init(struct uthread *new_thread)
98 {
99         /* don't remove this assert without dealing with 'caller' below.  if we want
100          * to call this while in vcore context, we'll need to handle the TLS
101          * swapping a little differently */
102         assert(!in_vcore_context());
103         uint32_t vcoreid;
104         assert(new_thread);
105         new_thread->state = UT_CREATED;
106         /* They should have zero'd the uthread.  Let's check critical things: */
107         assert(!new_thread->flags && !new_thread->sysc);
108         /* Get a TLS.  If we already have one, reallocate/refresh it */
109         if (new_thread->tls_desc)
110                 assert(!__uthread_reinit_tls(new_thread));
111         else
112                 assert(!__uthread_allocate_tls(new_thread));
113         /* Switch into the new guys TLS and let it know who it is */
114         struct uthread *caller = current_uthread;
115         assert(caller);
116         /* We need to disable notifs here (in addition to not migrating), since we
117          * could get interrupted when we're in the other guy's TLS, and when the
118          * vcore restarts us, it will put us in our old TLS, not the one we were in
119          * when we were interrupted.  We need to not migrate, since once we know the
120          * vcoreid, we depend on being on the same vcore throughout. */
121         caller->flags |= UTHREAD_DONT_MIGRATE;
122         /* not concerned about cross-core memory ordering, so no CPU mbs needed */
123         cmb();  /* don't let the compiler issue the vcore read before the write */
124         /* Note the first time we call this, we technically aren't on a vcore */
125         vcoreid = vcore_id();
126         disable_notifs(vcoreid);
127         /* Save the new_thread to the new uthread in that uthread's TLS */
128         set_tls_desc(new_thread->tls_desc, vcoreid);
129         current_uthread = new_thread;
130         /* Switch back to the caller */
131         set_tls_desc(caller->tls_desc, vcoreid);
132         /* Okay to migrate now, and enable interrupts/notifs.  This could be called
133          * from vcore context, so only enable if we're in _M and in vcore context. */
134         caller->flags &= ~UTHREAD_DONT_MIGRATE;         /* turn this on first */
135         if (!in_vcore_context() && in_multi_mode())
136                 enable_notifs(vcoreid);
137         cmb();  /* issue this write after we're done with vcoreid */
138 }
139
140 void uthread_runnable(struct uthread *uthread)
141 {
142         /* Allow the 2LS to make the thread runnable, and do whatever. */
143         assert(sched_ops->thread_runnable);
144         uthread->state = UT_RUNNABLE;
145         sched_ops->thread_runnable(uthread);
146 }
147
148 /* Need to have this as a separate, non-inlined function since we clobber the
149  * stack pointer before calling it, and don't want the compiler to play games
150  * with my hart. */
151 static void __attribute__((noinline, noreturn)) 
152 __uthread_yield(void)
153 {
154         struct uthread *uthread = current_uthread;
155         assert(in_vcore_context());
156         assert(!notif_is_enabled(vcore_id()));
157         /* Note: we no longer care if the thread is exiting, the 2LS will call
158          * uthread_destroy() */
159         uthread->flags &= ~UTHREAD_DONT_MIGRATE;
160         /* Determine if we're blocking on a syscall or just yielding.  Might end
161          * up doing this differently when/if we have more ways to yield. */
162         if (uthread->sysc) {
163                 uthread->state = UT_BLOCKED;
164                 assert(sched_ops->thread_blockon_sysc);
165                 sched_ops->thread_blockon_sysc(uthread->sysc);
166         } else { /* generic yield */
167                 uthread->state = UT_RUNNABLE;
168                 assert(sched_ops->thread_yield);
169                 /* 2LS will save the thread somewhere for restarting.  Later on,
170                  * we'll probably have a generic function for all sorts of waiting.
171                  */
172                 sched_ops->thread_yield(uthread);
173         }
174         /* Leave the current vcore completely */
175         current_uthread = NULL;
176         /* Go back to the entry point, where we can handle notifications or
177          * reschedule someone. */
178         uthread_vcore_entry();
179 }
180
181 /* Calling thread yields.  Both exiting and yielding calls this, the difference
182  * is the thread's state (in the flags). */
183 void uthread_yield(bool save_state)
184 {
185         struct uthread *uthread = current_uthread;
186         volatile bool yielding = TRUE; /* signal to short circuit when restarting */
187         /* TODO: (HSS) Save silly state */
188         // if (save_state)
189         //      save_fp_state(&t->as);
190         assert(!in_vcore_context());
191         assert(uthread->state == UT_RUNNING);
192         /* Don't migrate this thread to another vcore, since it depends on being on
193          * the same vcore throughout (once it disables notifs).  The race is that we
194          * read vcoreid, then get interrupted / migrated before disabling notifs. */
195         uthread->flags |= UTHREAD_DONT_MIGRATE;
196         cmb();  /* don't let DONT_MIGRATE write pass the vcoreid read */
197         uint32_t vcoreid = vcore_id();
198         printd("[U] Uthread %08p is yielding on vcore %d\n", uthread, vcoreid);
199         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
200         /* once we do this, we might miss a notif_pending, so we need to enter vcore
201          * entry later.  Need to disable notifs so we don't get in weird loops with
202          * save_ros_tf() and pop_ros_tf(). */
203         disable_notifs(vcoreid);
204         /* take the current state and save it into t->utf when this pthread
205          * restarts, it will continue from right after this, see yielding is false,
206          * and short ciruit the function.  Don't do this if we're dying. */
207         if (save_state)
208                 save_ros_tf(&uthread->utf);
209         cmb();  /* Force a reread of yielding. Technically save_ros_tf() is enough*/
210         /* Restart path doesn't matter if we're dying */
211         if (!yielding)
212                 goto yield_return_path;
213         yielding = FALSE; /* for when it starts back up */
214         /* Change to the transition context (both TLS and stack). */
215         extern void** vcore_thread_control_blocks;
216         set_tls_desc(vcore_thread_control_blocks[vcoreid], vcoreid);
217         assert(current_uthread == uthread);     
218         assert(in_vcore_context());     /* technically, we aren't fully in vcore context */
219         /* After this, make sure you don't use local variables.  Also, make sure the
220          * compiler doesn't use them without telling you (TODO).
221          *
222          * In each arch's set_stack_pointer, make sure you subtract off as much room
223          * as you need to any local vars that might be pushed before calling the
224          * next function, or for whatever other reason the compiler/hardware might
225          * walk up the stack a bit when calling a noreturn function. */
226         set_stack_pointer((void*)vcpd->transition_stack);
227         /* Finish exiting in another function. */
228         __uthread_yield();
229         /* Should never get here */
230         assert(0);
231         /* Will jump here when the uthread's trapframe is restarted/popped. */
232 yield_return_path:
233         printd("[U] Uthread %08p returning from a yield!\n", uthread);
234 }
235
236 /* Cleans up the uthread (the stuff we did in uthread_init()).  If you want to
237  * destroy a currently running uthread, you'll want something like
238  * pthread_exit(), which yields, and calls this from its sched_ops yield. */
239 void uthread_cleanup(struct uthread *uthread)
240 {
241         printd("[U] thread %08p on vcore %d is DYING!\n", uthread, vcore_id());
242         uthread->state = UT_DYING;
243         /* we alloc and manage the TLS, so lets get rid of it */
244         __uthread_free_tls(uthread);
245 }
246
247 /* Attempts to block on sysc, returning when it is done or progress has been
248  * made. */
249 void ros_syscall_blockon(struct syscall *sysc)
250 {
251         if (in_vcore_context()) {
252                 /* vcore's don't know what to do yet, so do the default (spin) */
253                 __ros_syscall_blockon(sysc);
254                 return;
255         }
256         if (!sched_ops->thread_blockon_sysc || !in_multi_mode()) {
257                 /* There isn't a 2LS op for blocking, or we're _S.  Spin for now. */
258                 __ros_syscall_blockon(sysc);
259                 return;
260         }
261         /* double check before doing all this crap */
262         if (atomic_read(&sysc->flags) & (SC_DONE | SC_PROGRESS))
263                 return;
264         /* So yield knows we are blocking on something */
265         assert(current_uthread);
266         current_uthread->sysc = sysc;
267         uthread_yield(TRUE);
268 }
269
270 /* Runs whatever thread is vcore's current_uthread */
271 void run_current_uthread(void)
272 {
273         uint32_t vcoreid = vcore_id();
274         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
275         assert(current_uthread);
276         assert(current_uthread->state == UT_RUNNING);
277         printd("[U] Vcore %d is restarting uthread %08p\n", vcoreid,
278                current_uthread);
279         clear_notif_pending(vcoreid);
280         set_tls_desc(current_uthread->tls_desc, vcoreid);
281         /* Pop the user trap frame */
282         pop_ros_tf(&vcpd->notif_tf, vcoreid);
283         assert(0);
284 }
285
286 /* Runs the uthread, but doesn't care about notif pending.  Only call this when
287  * there was a DONT_MIGRATE uthread, or a similar situation where the uthread
288  * will check messages soon (like calling enable_notifs()). */
289 static void __run_current_uthread_raw(void)
290 {
291         uint32_t vcoreid = vcore_id();
292         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
293         /* We need to manually say we have a notif pending, so we eventually return
294          * to vcore context.  (note the kernel turned it off for us) */
295         vcpd->notif_pending = TRUE;
296         set_tls_desc(current_uthread->tls_desc, vcoreid);
297         /* Pop the user trap frame */
298         pop_ros_tf_raw(&vcpd->notif_tf, vcoreid);
299         assert(0);
300 }
301
302 /* Launches the uthread on the vcore.  Don't call this on current_uthread. */
303 void run_uthread(struct uthread *uthread)
304 {
305         uint32_t vcoreid;
306         assert(uthread != current_uthread);
307         if (uthread->state != UT_RUNNABLE) {
308                 /* had vcore3 throw this, when the UT blocked on vcore1 and didn't come
309                  * back up yet (kernel didn't wake up, didn't send IPI) */
310                 printf("Uthread %08p not runnable (was %d) in run_uthread on vcore %d!\n",
311                        uthread, uthread->state, vcore_id());
312         }
313         assert(uthread->state == UT_RUNNABLE);
314         uthread->state = UT_RUNNING;
315         /* Save a ptr to the uthread we'll run in the transition context's TLS */
316         current_uthread = uthread;
317         vcoreid = vcore_id();
318         clear_notif_pending(vcoreid);
319         set_tls_desc(uthread->tls_desc, vcoreid);
320         /* Load silly state (Floating point) too.  For real */
321         /* TODO: (HSS) */
322         /* Pop the user trap frame */
323         pop_ros_tf(&uthread->utf, vcoreid);
324         assert(0);
325 }
326
327 /* Deals with a pending preemption (checks, responds).  If the 2LS registered a
328  * function, it will get run.  Returns true if you got preempted.  Called
329  * 'check' instead of 'handle', since this isn't an event handler.  It's the "Oh
330  * shit a preempt is on its way ASAP".  While it is isn't too involved with
331  * uthreads, it is tied in to sched_ops. */
332 bool check_preempt_pending(uint32_t vcoreid)
333 {
334         bool retval = FALSE;
335         if (__procinfo.vcoremap[vcoreid].preempt_pending) {
336                 retval = TRUE;
337                 if (sched_ops->preempt_pending)
338                         sched_ops->preempt_pending();
339                 /* this tries to yield, but will pop back up if this was a spurious
340                  * preempt_pending.  Note this will handle events internally, and then
341                  * recurse once per event in the queue.  This sucks, but keeps us from
342                  * missing messages for now. */
343                 vcore_yield(TRUE);
344         }
345         return retval;
346 }
347
348 /* Helper: This is a safe way for code to disable notifs if it *might* be called
349  * from uthread context (like from a notif_safe lock).  Pair this with
350  * uth_enable_notifs() unless you know what you're doing. */
351 void uth_disable_notifs(void)
352 {
353         if (!in_vcore_context() && in_multi_mode()) {
354                 if (current_uthread)
355                         current_uthread->flags |= UTHREAD_DONT_MIGRATE;
356                 cmb();  /* don't issue the flag write before the vcore_id() read */
357                 disable_notifs(vcore_id());
358         }
359 }
360
361 /* Helper: Pair this with uth_disable_notifs(). */
362 void uth_enable_notifs(void)
363 {
364         if (!in_vcore_context() && in_multi_mode()) {
365                 if (current_uthread)
366                         current_uthread->flags &= ~UTHREAD_DONT_MIGRATE;
367                 cmb();  /* don't enable before ~DONT_MIGRATE */
368                 enable_notifs(vcore_id());
369         }
370 }
371
372 static void handle_vc_preempt(struct event_msg *ev_msg, unsigned int ev_type)
373 {
374         printf("Vcore %d was preempted, we're fucked!!!\n", ev_msg->ev_arg2);
375 }
376
377 /* Attempts to register ev_q with sysc, so long as sysc is not done/progress.
378  * Returns true if it succeeded, and false otherwise.  False means that the
379  * syscall is done, and does not need an event set (and should be handled
380  * accordingly)*/
381 bool register_evq(struct syscall *sysc, struct event_queue *ev_q)
382 {
383         int old_flags;
384         sysc->ev_q = ev_q;
385         wrmb(); /* don't let that write pass any future reads (flags) */
386         /* Try and set the SC_UEVENT flag (so the kernel knows to look at ev_q) */
387         do {
388                 /* no cmb() needed, the atomic_read will reread flags */
389                 old_flags = atomic_read(&sysc->flags);
390                 /* Spin if the kernel is mucking with syscall flags */
391                 while (old_flags & SC_K_LOCK)
392                         old_flags = atomic_read(&sysc->flags);
393                 /* If the kernel finishes while we are trying to sign up for an event,
394                  * we need to bail out */
395                 if (old_flags & (SC_DONE | SC_PROGRESS)) {
396                         sysc->ev_q = 0;         /* not necessary, but might help with bugs */
397                         return FALSE;
398                 }
399         } while (!atomic_cas(&sysc->flags, old_flags, old_flags | SC_UEVENT));
400         return TRUE;
401 }
402
403 /* De-registers a syscall, so that the kernel will not send an event when it is
404  * done.  The call could already be SC_DONE, or could even finish while we try
405  * to unset SC_UEVENT.
406  *
407  * There is a chance the kernel sent an event if you didn't do this in time, but
408  * once this returns, the kernel won't send a message.
409  *
410  * If the kernel is trying to send a message right now, this will spin (on
411  * SC_K_LOCK).  We need to make sure we deregistered, and that if a message
412  * is coming, that it already was sent (and possibly overflowed), before
413  * returning. */
414 void deregister_evq(struct syscall *sysc)
415 {
416         int old_flags;
417         sysc->ev_q = 0;
418         wrmb(); /* don't let that write pass any future reads (flags) */
419         /* Try and unset the SC_UEVENT flag */
420         do {
421                 /* no cmb() needed, the atomic_read will reread flags */
422                 old_flags = atomic_read(&sysc->flags);
423                 /* Spin if the kernel is mucking with syscall flags */
424                 while (old_flags & SC_K_LOCK)
425                         old_flags = atomic_read(&sysc->flags);
426                 /* Note we don't care if the SC_DONE flag is getting set.  We just need
427                  * to avoid clobbering flags */
428         } while (!atomic_cas(&sysc->flags, old_flags, old_flags & ~SC_UEVENT));
429 }
430
431 /* TLS helpers */
432 static int __uthread_allocate_tls(struct uthread *uthread)
433 {
434         assert(!uthread->tls_desc);
435         uthread->tls_desc = allocate_tls();
436         if (!uthread->tls_desc) {
437                 errno = ENOMEM;
438                 return -1;
439         }
440         return 0;
441 }
442
443 static int __uthread_reinit_tls(struct uthread *uthread)
444 {
445         uthread->tls_desc = reinit_tls(uthread->tls_desc);
446         if (!uthread->tls_desc) {
447                 errno = ENOMEM;
448                 return -1;
449         }
450         return 0;
451 }
452
453 static void __uthread_free_tls(struct uthread *uthread)
454 {
455         free_tls(uthread->tls_desc);
456         uthread->tls_desc = NULL;
457 }