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