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