Allow sys_halt_core() to monitor notif_pending
[akaros.git] / user / parlib / vcore.c
1 #include <parlib/arch/arch.h>
2 #include <stdbool.h>
3 #include <errno.h>
4 #include <parlib/vcore.h>
5 #include <parlib/mcs.h>
6 #include <sys/param.h>
7 #include <parlib/parlib.h>
8 #include <unistd.h>
9 #include <stdlib.h>
10 #include <sys/mman.h>
11 #include <stdio.h>
12 #include <parlib/event.h>
13 #include <parlib/uthread.h>
14 #include <parlib/ucq.h>
15 #include <ros/arch/membar.h>
16 #include <parlib/printf-ext.h>
17 #include <parlib/poke.h>
18 #include <parlib/assert.h>
19 #include <parlib/stdio.h>
20
21 __thread int __vcoreid = 0;
22 __thread bool __vcore_context = FALSE;
23
24 __thread struct syscall __vcore_one_sysc = {.flags = (atomic_t)SC_DONE, 0};
25
26 /* Per vcore entery function used when reentering at the top of a vcore's stack */
27 static __thread void (*__vcore_reentry_func)(void) = NULL;
28
29 /* The default user vcore_entry function. */
30 void __attribute__((noreturn)) __vcore_entry(void)
31 {
32         extern void uthread_vcore_entry(void);
33         uthread_vcore_entry();
34         fprintf(stderr, "vcore_entry() should never return!\n");
35         abort();
36         __builtin_unreachable();
37 }
38 void vcore_entry(void) __attribute__((weak, alias ("__vcore_entry")));
39
40 /* TODO: probably don't want to dealloc.  Considering caching */
41 static void free_transition_tls(int id)
42 {
43         if (get_vcpd_tls_desc(id)) {
44                 /* Note we briefly have no TLS desc in VCPD.  This is fine so long as
45                  * that vcore doesn't get started fresh before we put in a new desc */
46                 free_tls(get_vcpd_tls_desc(id));
47                 set_vcpd_tls_desc(id, NULL);
48         }
49 }
50
51 static int allocate_transition_tls(int id)
52 {
53         /* Libc function to initialize TLS-based locale info for ctype functions. */
54         extern void __ctype_init(void);
55
56         /* We want to free and then reallocate the tls rather than simply 
57          * reinitializing it because its size may have changed.  TODO: not sure if
58          * this is right.  0-ing is one thing, but freeing and reallocating can be
59          * expensive, esp if syscalls are involved.  Check out glibc's
60          * allocatestack.c for what might work. */
61         free_transition_tls(id);
62
63         void *tcb = allocate_tls();
64         if (!tcb) {
65                 errno = ENOMEM;
66                 return -1;
67         }
68
69         /* Setup some intitial TLS data for the newly allocated transition tls. */
70         void *temp_tcb = get_tls_desc();
71         set_tls_desc(tcb);
72         begin_safe_access_tls_vars();
73         __vcoreid = id;
74         __vcore_context = TRUE;
75         __ctype_init();
76         end_safe_access_tls_vars();
77         set_tls_desc(temp_tcb);
78
79         /* Install the new tls into the vcpd. */
80         set_vcpd_tls_desc(id, tcb);
81         return 0;
82 }
83
84 static void free_vcore_stack(int id)
85 {
86         // don't actually free stacks
87 }
88
89 static int allocate_vcore_stack(int id)
90 {
91         struct preempt_data *vcpd = vcpd_of(id);
92         if (vcpd->vcore_stack)
93                 return 0; // reuse old stack
94
95         void* stackbot = mmap(0, TRANSITION_STACK_SIZE,
96                               PROT_READ | PROT_WRITE | PROT_EXEC,
97                               MAP_POPULATE | MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
98
99         if(stackbot == MAP_FAILED)
100                 return -1; // errno set by mmap
101
102         vcpd->vcore_stack = (uintptr_t)stackbot + TRANSITION_STACK_SIZE;
103
104         return 0;
105 }
106
107 /* Helper: prepares a vcore for use.  Takes a block of pages for the UCQs.
108  *
109  * Vcores need certain things, such as a stack and TLS.  These are determined by
110  * userspace.  Every vcore needs these set up before we drop into vcore context
111  * on that vcore.  This means we need to prep before asking the kernel for those
112  * vcores.
113  *
114  * We could have this function do its own mmap, at the expense of O(n) syscalls
115  * when we prepare the extra vcores. */
116 static void __prep_vcore(int vcoreid, uintptr_t mmap_block)
117 {
118         struct preempt_data *vcpd = vcpd_of(vcoreid);
119         int ret;
120
121         ret = allocate_vcore_stack(vcoreid);
122                 assert(!ret);
123         ret = allocate_transition_tls(vcoreid);
124                 assert(!ret);
125
126         vcpd->ev_mbox_public.type = EV_MBOX_UCQ;
127         ucq_init_raw(&vcpd->ev_mbox_public.ucq,
128                      mmap_block + 0 * PGSIZE,
129                      mmap_block + 1 * PGSIZE);
130         vcpd->ev_mbox_private.type = EV_MBOX_UCQ;
131         ucq_init_raw(&vcpd->ev_mbox_private.ucq,
132                      mmap_block + 2 * PGSIZE,
133                      mmap_block + 3 * PGSIZE);
134
135         /* Set the lowest level entry point for each vcore. */
136         vcpd->vcore_entry = (uintptr_t)__kernel_vcore_entry;
137 }
138
139 static void prep_vcore_0(void)
140 {
141         uintptr_t mmap_block;
142
143         mmap_block = (uintptr_t)mmap(0, PGSIZE * 4,
144                                      PROT_WRITE | PROT_READ,
145                                      MAP_POPULATE | MAP_ANONYMOUS | MAP_PRIVATE,
146                                      -1, 0);
147         assert((void*)mmap_block != MAP_FAILED);
148         __prep_vcore(0, mmap_block);
149 }
150
151 static void prep_remaining_vcores(void)
152 {
153         uintptr_t mmap_block;
154
155         mmap_block = (uintptr_t)mmap(0, PGSIZE * 4 * (max_vcores() - 1),
156                                      PROT_WRITE | PROT_READ,
157                                      MAP_POPULATE | MAP_ANONYMOUS | MAP_PRIVATE,
158                                      -1, 0);
159         assert((void*)mmap_block != MAP_FAILED);
160         for (int i = 1; i < max_vcores(); i++)
161                 __prep_vcore(i, mmap_block + 4 * (i - 1) * PGSIZE);
162 }
163
164 /* Run libc specific early setup code. */
165 static void vcore_libc_init(void)
166 {
167         register_printf_specifier('r', printf_errstr, printf_errstr_info);
168         /* TODO: register for other kevents/signals and whatnot (can probably reuse
169          * the simple ev_q).  Could also do this via explicit functions from the
170          * program. */
171 }
172
173 /* We need to separate the guts of vcore_lib_ctor() into a separate function,
174  * since the uthread ctor depends on this ctor running first.
175  *
176  * Also note that if you make a global ctor (not static, like this used to be),
177  * any shared objects that you load when the binary is built with -rdynamic will
178  * run the global ctor from the binary, not the one from the .so. */
179 void vcore_lib_init(void)
180 {
181         /* Note this is racy, but okay.  The first time through, we are _S.
182          * Also, this is the "lowest" level constructor for now, so we don't need
183          * to call any other init functions after our run_once() call. This may
184          * change in the future. */
185         parlib_init_once_racy(return);
186         /* Need to alloc vcore0's transition stuff here (technically, just the TLS)
187          * so that schedulers can use vcore0's transition TLS before it comes up in
188          * vcore_entry() */
189         prep_vcore_0();
190         assert(!in_vcore_context());
191         vcore_libc_init();
192 }
193
194 static void __attribute__((constructor)) vcore_lib_ctor(void)
195 {
196         if (__in_fake_parlib())
197                 return;
198         vcore_lib_init();
199 }
200
201 /* Helper functions used to reenter at the top of a vcore's stack for an
202  * arbitrary function */
203 static void __attribute__((noinline, noreturn)) 
204 __vcore_reenter()
205 {
206   __vcore_reentry_func();
207   assert(0);
208 }
209
210 void vcore_reenter(void (*entry_func)(void))
211 {
212   assert(in_vcore_context());
213   struct preempt_data *vcpd = vcpd_of(vcore_id());
214
215   __vcore_reentry_func = entry_func;
216   set_stack_pointer((void*)vcpd->vcore_stack);
217   cmb();
218   __vcore_reenter();
219 }
220
221 /* Helper, picks some sane defaults and changes the process into an MCP */
222 void vcore_change_to_m(void)
223 {
224         int ret;
225
226         prep_remaining_vcores();
227         __procdata.res_req[RES_CORES].amt_wanted = 1;
228         __procdata.res_req[RES_CORES].amt_wanted_min = 1;       /* whatever */
229         assert(!in_multi_mode());
230         assert(!in_vcore_context());
231         ret = sys_change_to_m();
232         assert(!ret);
233         assert(in_multi_mode());
234         assert(!in_vcore_context());
235 }
236
237 static void __vc_req_poke(void *nr_vc_wanted)
238 {
239         long nr_vcores_wanted = *(long*)nr_vc_wanted;
240
241         /* We init'd up to max_vcores() VCs during init.  This assumes the kernel
242          * doesn't magically change that value (which it should not do). */
243         nr_vcores_wanted = MIN(nr_vcores_wanted, max_vcores());
244         if (nr_vcores_wanted > __procdata.res_req[RES_CORES].amt_wanted)
245                 __procdata.res_req[RES_CORES].amt_wanted = nr_vcores_wanted;
246         if (nr_vcores_wanted > num_vcores())
247                 sys_poke_ksched(0, RES_CORES);  /* 0 -> poke for ourselves */
248 }
249 static struct poke_tracker vc_req_poke = POKE_INITIALIZER(__vc_req_poke);
250
251 /* Requests the kernel that we have a total of nr_vcores_wanted.
252  *
253  * This is callable by multiple threads/vcores concurrently.  Exactly one of
254  * them will actually run __vc_req_poke.  The others will just return.
255  *
256  * This means that two threads could ask for differing amounts, and only one of
257  * them will succeed.  This is no different than a racy write to a shared
258  * variable.  The poke provides a single-threaded environment, so that we don't
259  * worry about racing on VCPDs or hitting the kernel with excessive SYS_pokes.
260  *
261  * Since we're using the post-and-poke style, we can do a 'last write wins'
262  * policy for the value used in the poke (and subsequent pokes). */
263 void vcore_request_total(long nr_vcores_wanted)
264 {
265         static long nr_vc_wanted;
266
267         if (parlib_never_vc_request || !parlib_wants_to_be_mcp)
268                 return;
269         if (nr_vcores_wanted == __procdata.res_req[RES_CORES].amt_wanted)
270                 return;
271
272         /* We race to "post our work" here.  Whoever handles the poke will get the
273          * latest value written here. */
274         nr_vc_wanted = nr_vcores_wanted;
275         poke(&vc_req_poke, &nr_vc_wanted);
276 }
277
278 /* This tries to get "more vcores", based on the number we currently have.
279  *
280  * What happens is we can have a bunch of threads trying to get "another vcore",
281  * which currently means more than num_vcores().  If you have someone ask for
282  * two more, and then someone else ask for one more, how many you ultimately ask
283  * for depends on if the kernel heard you and adjusted num_vcores in between the
284  * two calls.  Or maybe your amt_wanted already was num_vcores + 5, so neither
285  * call is telling the kernel anything new.  It comes down to "one more than I
286  * have" vs "one more than I've already asked for".
287  *
288  * So for now, this will keep the older behavior (one more than I have).  This
289  * is all quite racy, so we can just guess and request a total number of vcores.
290  */
291 void vcore_request_more(long nr_new_vcores)
292 {
293         vcore_request_total(nr_new_vcores + num_vcores());
294 }
295
296 /* This can return, if you failed to yield due to a concurrent event.  Note
297  * we're atomicly setting the CAN_RCV flag, and aren't bothering with CASing
298  * (either with the kernel or uthread's handle_indirs()).  We don't particularly
299  * care what other code does - we intend to set those flags no matter what. */
300 void vcore_yield(bool preempt_pending)
301 {
302         unsigned long old_nr;
303         uint32_t vcoreid = vcore_id();
304         struct preempt_data *vcpd = vcpd_of(vcoreid);
305
306         if (!preempt_pending && parlib_never_yield)
307                 return;
308         __sync_fetch_and_and(&vcpd->flags, ~VC_CAN_RCV_MSG);
309         /* no wrmb() necessary, handle_events() has an mb() if it is checking */
310         /* Clears notif pending and tries to handle events.  This is an optimization
311          * to avoid the yield syscall if we have an event pending.  If there is one,
312          * we want to unwind and return to the 2LS loop, where we may not want to
313          * yield anymore.
314          * Note that the kernel only cares about CAN_RCV_MSG for the desired vcore;
315          * when spamming, it relies on membership of lists within the kernel.  Look
316          * at spam_list_member() for more info (k/s/event.c). */
317         if (handle_events(vcoreid)) {
318                 __sync_fetch_and_or(&vcpd->flags, VC_CAN_RCV_MSG);
319                 return;
320         }
321         /* If we are yielding since we don't want the core, tell the kernel we want
322          * one less vcore (vc_yield assumes a dumb 2LS).
323          *
324          * If yield fails (slight race), we may end up having more vcores than
325          * amt_wanted for a while, and might lose one later on (after a
326          * preempt/timeslicing) - the 2LS will have to notice eventually if it
327          * actually needs more vcores (which it already needs to do).  amt_wanted
328          * could even be 0.
329          *
330          * In general, any time userspace decrements or sets to 0, it could get
331          * preempted, so the kernel will still give us at least one, until the last
332          * vcore properly yields without missing a message (and becomes a WAITING
333          * proc, which the ksched will not give cores to).
334          *
335          * I think it's possible for userspace to do this (lock, read amt_wanted,
336          * check all message queues for all vcores, subtract amt_wanted (not set to
337          * 0), unlock) so long as every event handler +1s the amt wanted, but that's
338          * a huge pain, and we already have event handling code making sure a
339          * process can't sleep (transition to WAITING) if a message arrives (can't
340          * yield if notif_pending, can't go WAITING without yielding, and the event
341          * posting the notif_pending will find the online VC or be delayed by
342          * spinlock til the proc is WAITING). */
343         if (!preempt_pending) {
344                 do {
345                         old_nr = __procdata.res_req[RES_CORES].amt_wanted;
346                         if (old_nr == 0)
347                                 break;
348                 } while (!__sync_bool_compare_and_swap(
349                              &__procdata.res_req[RES_CORES].amt_wanted,
350                              old_nr, old_nr - 1));
351         }
352         /* We can probably yield.  This may pop back up if notif_pending became set
353          * by the kernel after we cleared it and we lost the race. */
354         sys_yield(preempt_pending);
355         __sync_fetch_and_or(&vcpd->flags, VC_CAN_RCV_MSG);
356 }
357
358 /* Enables notifs, and deals with missed notifs by self notifying.  This should
359  * be rare, so the syscall overhead isn't a big deal.  The other alternative
360  * would be to uthread_yield(), which would require us to revert some uthread
361  * interface changes. */
362 void enable_notifs(uint32_t vcoreid)
363 {
364         __enable_notifs(vcoreid);
365         wrmb(); /* need to read after the write that enabled notifs */
366         /* Note we could get migrated before executing this.  If that happens, our
367          * vcore had gone into vcore context (which is what we wanted), and this
368          * self_notify to our old vcore is spurious and harmless. */
369         if (vcpd_of(vcoreid)->notif_pending)
370                 sys_self_notify(vcoreid, EV_NONE, 0, TRUE);
371 }
372
373 /* Helper to disable notifs.  It simply checks to make sure we disabled uthread
374  * migration, which is a common mistake. */
375 void disable_notifs(uint32_t vcoreid)
376 {
377         if (!in_vcore_context() && current_uthread)
378                 assert(current_uthread->flags & UTHREAD_DONT_MIGRATE);
379         __disable_notifs(vcoreid);
380 }
381
382 /* Like smp_idle(), this will put the core in a state that it can only be woken
383  * up by an IPI.  For now, this is a halt.  Maybe an mwait in the future.
384  *
385  * This will return if an event was pending (could be the one you were waiting
386  * for) or if the halt failed for some reason, such as a concurrent RKM.  If
387  * successful, this will not return at all, and the vcore will restart from the
388  * top next time it wakes.  Any sort of IRQ will wake the core.
389  *
390  * Alternatively, I might make this so it never returns, if that's easier to
391  * work with (similar issues with yield). */
392 void vcore_idle(void)
393 {
394         uint32_t vcoreid = vcore_id();
395         /* Once we enable notifs, the calling context will be treated like a uthread
396          * (saved into the uth slot).  We don't want to ever run it again, so we
397          * need to make sure there's no cur_uth. */
398         assert(!current_uthread);
399         /* This clears notif_pending (check, signal, check again pattern). */
400         if (handle_events(vcoreid))
401                 return;
402         /* This enables notifs, but also checks notif pending.  At this point, any
403          * new notifs will restart the vcore from the top. */
404         enable_notifs(vcoreid);
405         /* From now, til we get into the kernel, any notifs will permanently destroy
406          * this context and start the VC from the top.
407          *
408          * Once we're in the kernel, any messages (__notify, __preempt), will be
409          * RKMs.  halt will need to check for those atomically.  Checking for
410          * notif_pending in the kernel (sleep only if not set) is not enough, since
411          * not all reasons for the kernel to stay awak set notif_pending (e.g.,
412          * __preempts and __death).
413          *
414          * At this point, we're out of VC ctx, so anyone who sets notif_pending
415          * should also send an IPI / __notify */
416         sys_halt_core(0);
417         /* in case halt returns without actually restarting the VC ctx. */
418         disable_notifs(vcoreid);
419 }
420
421 /* Helper, that actually makes sure a vcore is running.  Call this is you really
422  * want vcoreid.  More often, you'll want to call the regular version. */
423 static void __ensure_vcore_runs(uint32_t vcoreid)
424 {
425         if (vcore_is_preempted(vcoreid)) {
426                 printd("[vcore]: VC %d changing to VC %d\n", vcore_id(), vcoreid);
427                 /* Note that at this moment, the vcore could still be mapped (we're
428                  * racing with __preempt.  If that happens, we'll just fail the
429                  * sys_change_vcore(), and next time __ensure runs we'll get it. */
430                 /* We want to recover them from preemption.  Since we know they have
431                  * notifs disabled, they will need to be directly restarted, so we can
432                  * skip the other logic and cut straight to the sys_change_vcore() */
433                 sys_change_vcore(vcoreid, FALSE);
434         }
435 }
436
437 /* Helper, looks for any preempted vcores, making sure each of them runs at some
438  * point.  This is pretty heavy-weight, and should be used to help get out of
439  * weird deadlocks (spinning in vcore context, waiting on another vcore).  If
440  * you might know which vcore you are waiting on, use ensure_vc_runs. */
441 static void __ensure_all_run(void)
442 {
443         for (int i = 0; i < max_vcores(); i++)
444                 __ensure_vcore_runs(i);
445 }
446
447 /* Makes sure a vcore is running.  If it is preempted, we'll switch to
448  * it.  This will return, either immediately if the vcore is running, or later
449  * when someone preempt-recovers us.
450  *
451  * If you pass in your own vcoreid, this will make sure all other preempted
452  * vcores run. */
453 void ensure_vcore_runs(uint32_t vcoreid)
454 {
455         /* if the vcoreid is ourselves, make sure everyone else is running */
456         if (vcoreid == vcore_id()) {
457                 __ensure_all_run();
458                 return;
459         }
460         __ensure_vcore_runs(vcoreid);
461 }
462
463 #define NR_RELAX_SPINS 1000
464 /* If you are spinning and waiting on another vcore, call this.  Pass in the
465  * vcoreid of the core you are waiting on, or your own vcoreid if you don't
466  * know.  It will spin for a bit before firing up the potentially expensive
467  * __ensure_all_run(). */
468 void cpu_relax_vc(uint32_t other_vcoreid)
469 {
470         static __thread unsigned int __vc_relax_spun = 0;
471
472         /* Uthreads with notifs enabled can just spin normally.  This actually
473          * depends on the 2LS preemption policy.  Currently, we receive notifs
474          * whenever another core is preempted, so we don't need to poll. */
475         if (notif_is_enabled(vcore_id())) {
476                 cpu_relax();
477                 return;
478         }
479         if (__vc_relax_spun++ >= NR_RELAX_SPINS) {
480                 /* if other_vcoreid == vcore_id(), this might be expensive */
481                 ensure_vcore_runs(other_vcoreid);
482                 __vc_relax_spun = 0;
483         }
484         cpu_relax();
485 }
486
487 /* Check with the kernel to determine what vcore we are.  Normally, you should
488  * never call this, since your vcoreid is stored in your TLS.  Also, if you call
489  * it from a uthread, you could get migrated, so you should drop into some form
490  * of vcore context (DONT_MIGRATE on) */
491 uint32_t get_vcoreid(void)
492 {
493         if (!in_vcore_context()) {
494                 assert(current_uthread);
495                 assert(current_uthread->flags & UTHREAD_DONT_MIGRATE);
496         }
497         return __get_vcoreid();
498 }
499
500 /* Debugging helper.  Pass in the string you want printed if your vcoreid is
501  * wrong, and pass in what vcoreid you think you are.  Don't call from uthread
502  * context unless migrations are disabled.  Will print some stuff and return
503  * FALSE if you were wrong. */
504 bool check_vcoreid(const char *str, uint32_t vcoreid)
505 {
506         uint32_t kvcoreid = get_vcoreid();
507         if (vcoreid != kvcoreid) {
508                 printf("%s: VC %d thought it was VC %d\n", str, kvcoreid, vcoreid);
509                 return FALSE;
510         }
511         return TRUE;
512 }
513
514 /* Helper.  Yields the vcore, or restarts it from scratch. */
515 void __attribute__((noreturn)) vcore_yield_or_restart(void)
516 {
517         struct preempt_data *vcpd = vcpd_of(vcore_id());
518
519         vcore_yield(FALSE);
520         /* If vcore_yield returns, we have an event.  Just restart vcore context. */
521         set_stack_pointer((void*)vcpd->vcore_stack);
522         vcore_entry();
523 }
524
525 void vcore_wake(uint32_t vcoreid, bool force_ipi)
526 {
527         struct preempt_data *vcpd = vcpd_of(vcoreid);
528
529         vcpd->notif_pending = true;
530         if (vcoreid == vcore_id())
531                 return;
532         if (force_ipi || !arch_has_mwait())
533                 sys_self_notify(vcoreid, EV_NONE, 0, true);
534 }