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