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