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