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