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