Uthread arch-dependent code uses user_contexts
[akaros.git] / user / parlib / vcore.c
1 #include <arch/arch.h>
2 #include <stdbool.h>
3 #include <errno.h>
4 #include <vcore.h>
5 #include <mcs.h>
6 #include <sys/param.h>
7 #include <parlib.h>
8 #include <unistd.h>
9 #include <stdlib.h>
10 #include <sys/mman.h>
11 #include <stdio.h>
12 #include <event.h>
13 #include <uthread.h>
14 #include <ucq.h>
15 #include <ros/arch/membar.h>
16
17 /* starting with 1 since we alloc vcore0's stacks and TLS in vcore_init(). */
18 static size_t _max_vcores_ever_wanted = 1;
19 atomic_t nr_new_vcores_wanted;
20 atomic_t vc_req_being_handled;
21
22 extern void** vcore_thread_control_blocks;
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(vcore_thread_control_blocks[id])
33         {
34                 free_tls(vcore_thread_control_blocks[id]);
35                 vcore_thread_control_blocks[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
50         if ((vcore_thread_control_blocks[id] = tcb) == NULL) {
51                 errno = ENOMEM;
52                 return -1;
53         }
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 void vcore_init(void)
81 {
82         uintptr_t mmap_block;
83         /* Note this is racy, but okay.  The first time through, we are _S */
84         init_once_racy(return);
85
86         vcore_thread_control_blocks = (void**)calloc(max_vcores(),sizeof(void*));
87
88         if(!vcore_thread_control_blocks)
89                 goto vcore_init_fail;
90
91         /* Need to alloc vcore0's transition stuff here (technically, just the TLS)
92          * so that schedulers can use vcore0's transition TLS before it comes up in
93          * vcore_entry() */
94         if(allocate_transition_stack(0) || allocate_transition_tls(0))
95                 goto vcore_init_tls_fail;
96
97         /* Initialize our VCPD event queues' ucqs, two pages per ucq, 4 per vcore */
98         mmap_block = (uintptr_t)mmap(0, PGSIZE * 4 * max_vcores(),
99                                      PROT_WRITE | PROT_READ,
100                                      MAP_POPULATE | MAP_ANONYMOUS, -1, 0);
101         /* Yeah, this doesn't fit in the error-handling scheme, but this whole
102          * system doesn't really handle failure, and needs a rewrite involving less
103          * mmaps/munmaps. */
104         assert(mmap_block);
105         /* Note we may end up doing vcore 0's elsewhere, for _Ss, or else have a
106          * separate ev_q for that. */
107         for (int i = 0; i < max_vcores(); i++) {
108                 /* four pages total for both ucqs from the big block (2 pages each) */
109                 ucq_init_raw(&vcpd_of(i)->ev_mbox_public.ev_msgs,
110                              mmap_block + (4 * i    ) * PGSIZE,
111                              mmap_block + (4 * i + 1) * PGSIZE);
112                 ucq_init_raw(&vcpd_of(i)->ev_mbox_private.ev_msgs,
113                              mmap_block + (4 * i + 2) * PGSIZE,
114                              mmap_block + (4 * i + 3) * PGSIZE);
115         }
116         atomic_init(&vc_req_being_handled, 0);
117         assert(!in_vcore_context());
118         /* no longer need to enable notifs on vcore 0, it is set like that by
119          * default (so you drop into vcore context immediately on transtioning to
120          * _M) */
121         vc_initialized = TRUE;
122         return;
123 vcore_init_tls_fail:
124         free(vcore_thread_control_blocks);
125 vcore_init_fail:
126         assert(0);
127 }
128
129 /* Helper functions used to reenter at the top of a vcore's stack for an
130  * arbitrary function */
131 static void __attribute__((noinline, noreturn)) 
132 __vcore_reenter()
133 {
134   __vcore_reentry_func();
135   assert(0);
136 }
137
138 void vcore_reenter(void (*entry_func)(void))
139 {
140   assert(in_vcore_context());
141   struct preempt_data *vcpd = vcpd_of(vcore_id());
142
143   __vcore_reentry_func = entry_func;
144   set_stack_pointer((void*)vcpd->transition_stack);
145   cmb();
146   __vcore_reenter();
147 }
148
149 /* This gets called in glibc before calling the programs 'main'.  Need to set
150  * ourselves up so that thread0 is a uthread, and then register basic signals to
151  * go to vcore 0. */
152 void vcore_event_init(void)
153 {
154         /* set up our thread0 as a uthread */
155         uthread_slim_init();
156         /* TODO: register for other kevents/signals and whatnot (can probably reuse
157          * the simple ev_q).  Could also do this via explicit functions from the
158          * program. */
159 }
160
161 /* Helper, picks some sane defaults and changes the process into an MCP */
162 void vcore_change_to_m(void)
163 {
164         int ret;
165         __procdata.res_req[RES_CORES].amt_wanted = 1;
166         __procdata.res_req[RES_CORES].amt_wanted_min = 1;       /* whatever */
167         assert(!in_multi_mode());
168         assert(!in_vcore_context());
169         ret = sys_change_to_m();
170         assert(!ret);
171         assert(in_multi_mode());
172         assert(!in_vcore_context());
173 }
174
175 /* Returns -1 with errno set on error, or 0 on success.  This does not return
176  * the number of cores actually granted (though some parts of the kernel do
177  * internally).
178  *
179  * This tries to get "more vcores", based on the number we currently have.
180  * We'll probably need smarter 2LSs in the future that just directly set
181  * amt_wanted.  What happens is we can have a bunch of 2LS vcore contexts
182  * trying to get "another vcore", which currently means more than num_vcores().
183  * If you have someone ask for two more, and then someone else ask for one more,
184  * how many you ultimately ask for depends on if the kernel heard you and
185  * adjusted num_vcores in between the two calls.  Or maybe your amt_wanted
186  * already was num_vcores + 5, so neither call is telling the kernel anything
187  * new.  It comes down to "one more than I have" vs "one more than I've already
188  * asked for".
189  *
190  * So for now, this will keep the older behavior (one more than I have).  It
191  * will try to accumulate any concurrent requests, and adjust amt_wanted up.
192  * Interleaving, repetitive calls (everyone asking for one more) may get
193  * ignored.
194  *
195  * Note the doesn't block or anything (despite the min number requested is
196  * 1), since the kernel won't block the call.
197  *
198  * There are a few concurrency concerns.  We have _max_vcores_ever_wanted,
199  * initialization of new vcore stacks/TLSs, making sure we don't ask for too
200  * many (minor point), and most importantly not asking the kernel for too much
201  * or otherwise miscommunicating our desires to the kernel.  Remember, the
202  * kernel wants just one answer from the process about what it wants, and it is
203  * up to the process to figure that out.
204  *
205  * So we basically have one thread do the submitting/prepping/bookkeeping, and
206  * other threads come in just update the number wanted and make sure someone
207  * is sorting things out.  This will perform a bit better too, since only one
208  * vcore makes syscalls (which hammer the proc_lock).  This essentially has
209  * cores submit work, and one core does the work (like Eric's old delta
210  * functions).
211  *
212  * There's a slight semantic change: this will return 0 (success) for the
213  * non-submitters, and 0 if we submitted.  -1 only if the submitter had some
214  * non-kernel failure.
215  *
216  * Also, beware that this (like the old version) doesn't protect with races on
217  * num_vcores().  num_vcores() is how many you have now or very soon (accounting
218  * for messages in flight that will take your cores), not how many you told the
219  * kernel you want. */
220 int vcore_request(long nr_new_vcores)
221 {
222         long nr_to_prep_now, nr_vcores_wanted;
223
224         assert(vc_initialized);
225         /* Early sanity checks */
226         if ((nr_new_vcores < 0) || (nr_new_vcores + num_vcores() > max_vcores()))
227                 return -1;      /* consider ERRNO */
228         /* Post our desires (ROS atomic_add() conflicts with glibc) */
229         atomic_fetch_and_add(&nr_new_vcores_wanted, nr_new_vcores);
230 try_handle_it:
231         cmb();  /* inc before swap.  the atomic is a CPU mb() */
232         if (atomic_swap(&vc_req_being_handled, 1)) {
233                 /* We got a 1 back, so someone else is already working on it */
234                 return 0;
235         }
236         /* So now we're the ones supposed to handle things.  This does things in the
237          * "increment based on the number we have", vs "increment on the number we
238          * said we want".
239          *
240          * Figure out how many we have, though this is racy.  Yields/preempts/grants
241          * will change this over time, and we may end up asking for less than we
242          * had. */
243         nr_vcores_wanted = num_vcores();
244         /* Pull all of the vcores wanted into our local variable, where we'll deal
245          * with prepping/requesting that many vcores.  Keep doing this til we think
246          * no more are wanted. */
247         while ((nr_to_prep_now = atomic_swap(&nr_new_vcores_wanted, 0))) {
248                 nr_vcores_wanted += nr_to_prep_now;
249                 /* Don't bother prepping or asking for more than we can ever get */
250                 nr_vcores_wanted = MIN(nr_vcores_wanted, max_vcores());
251                 /* Make sure all we might ask for are prepped */
252                 for (long i = _max_vcores_ever_wanted; i < nr_vcores_wanted; i++) {
253                         if (allocate_transition_stack(i) || allocate_transition_tls(i)) {
254                                 atomic_set(&vc_req_being_handled, 0);   /* unlock and bail out*/
255                                 return -1;
256                         }
257                         _max_vcores_ever_wanted++;      /* done in the loop to handle failures*/
258                 }
259         }
260         cmb();  /* force a reread of num_vcores() */
261         /* Update amt_wanted if we now want *more* than what the kernel already
262          * knows.  See notes in the func doc. */
263         if (nr_vcores_wanted > __procdata.res_req[RES_CORES].amt_wanted)
264                 __procdata.res_req[RES_CORES].amt_wanted = nr_vcores_wanted;
265         /* If num_vcores isn't what we want, we can poke the ksched.  Due to some
266          * races with yield, our desires may be old.  Not a big deal; any vcores
267          * that pop up will just end up yielding (or get preempt messages.)  */
268         if (nr_vcores_wanted > num_vcores())
269                 sys_poke_ksched(RES_CORES);
270         /* Unlock, (which lets someone else work), and check to see if more work
271          * needs to be done.  If so, we'll make sure it gets handled. */
272         atomic_set(&vc_req_being_handled, 0);   /* unlock, to allow others to try */
273         wrmb();
274         /* check for any that might have come in while we were out */
275         if (atomic_read(&nr_new_vcores_wanted))
276                 goto try_handle_it;
277         return 0;
278 }
279
280 /* This can return, if you failed to yield due to a concurrent event.  Note
281  * we're atomicly setting the CAN_RCV flag, and aren't bothering with CASing
282  * (either with the kernel or uthread's handle_indirs()).  We don't particularly
283  * care what other code does - we intend to set those flags no matter what. */
284 void vcore_yield(bool preempt_pending)
285 {
286         uint32_t vcoreid = vcore_id();
287         struct preempt_data *vcpd = vcpd_of(vcoreid);
288         __sync_fetch_and_and(&vcpd->flags, ~VC_CAN_RCV_MSG);
289         /* no wrmb() necessary, handle_events() has an mb() if it is checking */
290         /* Clears notif pending and tries to handle events.  This is an optimization
291          * to avoid the yield syscall if we have an event pending.  If there is one,
292          * we want to unwind and return to the 2LS loop, where we may not want to
293          * yield anymore.
294          * Note that the kernel only cares about CAN_RCV_MSG for the desired vcore,
295          * not for a FALLBACK.  */
296         if (handle_events(vcoreid)) {
297                 __sync_fetch_and_or(&vcpd->flags, VC_CAN_RCV_MSG);
298                 return;
299         }
300         /* If we are yielding since we don't want the core, tell the kernel we want
301          * one less vcore.  If yield fails (slight race), we may end up having more
302          * vcores than amt_wanted for a while, and might lose one later on (after a
303          * preempt/timeslicing) - the 2LS will have to notice eventually if it
304          * actually needs more vcores (which it already needs to do).  We need to
305          * atomically decrement, though I don't want the kernel's data type here to
306          * be atomic_t (only userspace cares in this one case). */
307         if (!preempt_pending)
308                 __sync_fetch_and_sub(&__procdata.res_req[RES_CORES].amt_wanted, 1);
309         /* We can probably yield.  This may pop back up if notif_pending became set
310          * by the kernel after we cleared it and we lost the race. */
311         sys_yield(preempt_pending);
312         __sync_fetch_and_or(&vcpd->flags, VC_CAN_RCV_MSG);
313 }
314
315 /* Enables notifs, and deals with missed notifs by self notifying.  This should
316  * be rare, so the syscall overhead isn't a big deal.  The other alternative
317  * would be to uthread_yield(), which would require us to revert some uthread
318  * interface changes. */
319 void enable_notifs(uint32_t vcoreid)
320 {
321         __enable_notifs(vcoreid);
322         wrmb(); /* need to read after the write that enabled notifs */
323         /* Note we could get migrated before executing this.  If that happens, our
324          * vcore had gone into vcore context (which is what we wanted), and this
325          * self_notify to our old vcore is spurious and harmless. */
326         if (vcpd_of(vcoreid)->notif_pending)
327                 sys_self_notify(vcoreid, EV_NONE, 0, TRUE);
328 }
329
330 /* Helper to disable notifs.  It simply checks to make sure we disabled uthread
331  * migration, which is a common mistake. */
332 void disable_notifs(uint32_t vcoreid)
333 {
334         if (!in_vcore_context() && current_uthread)
335                 assert(current_uthread->flags & UTHREAD_DONT_MIGRATE);
336         __disable_notifs(vcoreid);
337 }
338
339 /* Like smp_idle(), this will put the core in a state that it can only be woken
340  * up by an IPI.  In the future, we may halt or something.  This will return if
341  * an event was pending (could be the one you were waiting for). */
342 void vcore_idle(void)
343 {
344         uint32_t vcoreid = vcore_id();
345         if (handle_events(vcoreid))
346                 return;
347         enable_notifs(vcoreid);
348         while (1) {
349                 cpu_relax();
350         }
351 }
352
353 /* Helper, that actually makes sure a vcore is running.  Call this is you really
354  * want vcoreid.  More often, you'll want to call the regular version. */
355 static void __ensure_vcore_runs(uint32_t vcoreid)
356 {
357         if (vcore_is_preempted(vcoreid)) {
358                 printd("[vcore]: VC %d changing to VC %d\n", vcore_id(), vcoreid);
359                 /* Note that at this moment, the vcore could still be mapped (we're
360                  * racing with __preempt.  If that happens, we'll just fail the
361                  * sys_change_vcore(), and next time __ensure runs we'll get it. */
362                 /* We want to recover them from preemption.  Since we know they have
363                  * notifs disabled, they will need to be directly restarted, so we can
364                  * skip the other logic and cut straight to the sys_change_vcore() */
365                 sys_change_vcore(vcoreid, FALSE);
366         }
367 }
368
369 /* Helper, looks for any preempted vcores, making sure each of them runs at some
370  * point.  This is pretty heavy-weight, and should be used to help get out of
371  * weird deadlocks (spinning in vcore context, waiting on another vcore).  If
372  * you might know which vcore you are waiting on, use ensure_vc_runs. */
373 static void __ensure_all_run(void)
374 {
375         for (int i = 0; i < max_vcores(); i++)
376                 __ensure_vcore_runs(i);
377 }
378
379 /* Makes sure a vcore is running.  If it is preempted, we'll switch to
380  * it.  This will return, either immediately if the vcore is running, or later
381  * when someone preempt-recovers us.
382  *
383  * If you pass in your own vcoreid, this will make sure all other preempted
384  * vcores run. */
385 void ensure_vcore_runs(uint32_t vcoreid)
386 {
387         /* if the vcoreid is ourselves, make sure everyone else is running */
388         if (vcoreid == vcore_id()) {
389                 __ensure_all_run();
390                 return;
391         }
392         __ensure_vcore_runs(vcoreid);
393 }
394
395 #define NR_RELAX_SPINS 1000
396 /* If you are spinning in vcore context and it is likely that you don't know who
397  * you are waiting on, call this.  It will spin for a bit before firing up the
398  * potentially expensive __ensure_all_run().  Don't call this from uthread
399  * context.  sys_change_vcore will probably mess you up. */
400 void cpu_relax_vc(uint32_t vcoreid)
401 {
402         static __thread unsigned int spun;              /* vcore TLS */
403         assert(in_vcore_context());
404         spun = 0;
405         if (spun++ >= NR_RELAX_SPINS) {
406                 /* if vcoreid == vcore_id(), this might be expensive */
407                 ensure_vcore_runs(vcoreid);
408                 spun = 0;
409         }
410         cpu_relax();
411 }
412
413 /* Check with the kernel to determine what vcore we are.  Normally, you should
414  * never call this, since your vcoreid is stored in your TLS.  Also, if you call
415  * it from a uthread, you could get migrated, so you should drop into some form
416  * of vcore context (DONT_MIGRATE on) */
417 uint32_t get_vcoreid(void)
418 {
419         if (!in_vcore_context()) {
420                 assert(current_uthread);
421                 assert(current_uthread->flags & UTHREAD_DONT_MIGRATE);
422         }
423         return __get_vcoreid();
424 }
425
426 /* Debugging helper.  Pass in the string you want printed if your vcoreid is
427  * wrong, and pass in what vcoreid you think you are.  Don't call from uthread
428  * context unless migrations are disabled.  Will print some stuff and return
429  * FALSE if you were wrong. */
430 bool check_vcoreid(const char *str, uint32_t vcoreid)
431 {
432         uint32_t kvcoreid = get_vcoreid();
433         if (vcoreid != kvcoreid) {
434                 ros_debug("%s: VC %d thought it was VC %d\n", str, kvcoreid, vcoreid);
435                 return FALSE;
436         }
437         return TRUE;
438 }