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