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