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