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