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