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