Vcore TLS desc in procdata (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 bool vc_initialized = FALSE;
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 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         /* Need to alloc vcore0's transition stuff here (technically, just the TLS)
87          * so that schedulers can use vcore0's transition TLS before it comes up in
88          * vcore_entry() */
89         if(allocate_transition_stack(0) || allocate_transition_tls(0))
90                 goto vcore_init_fail;
91
92         /* Initialize our VCPD event queues' ucqs, two pages per ucq, 4 per vcore */
93         mmap_block = (uintptr_t)mmap(0, PGSIZE * 4 * max_vcores(),
94                                      PROT_WRITE | PROT_READ,
95                                      MAP_POPULATE | MAP_ANONYMOUS, -1, 0);
96         /* Yeah, this doesn't fit in the error-handling scheme, but this whole
97          * system doesn't really handle failure, and needs a rewrite involving less
98          * mmaps/munmaps. */
99         assert(mmap_block);
100         /* Note we may end up doing vcore 0's elsewhere, for _Ss, or else have a
101          * separate ev_q for that. */
102         for (int i = 0; i < max_vcores(); i++) {
103                 /* four pages total for both ucqs from the big block (2 pages each) */
104                 ucq_init_raw(&vcpd_of(i)->ev_mbox_public.ev_msgs,
105                              mmap_block + (4 * i    ) * PGSIZE,
106                              mmap_block + (4 * i + 1) * PGSIZE);
107                 ucq_init_raw(&vcpd_of(i)->ev_mbox_private.ev_msgs,
108                              mmap_block + (4 * i + 2) * PGSIZE,
109                              mmap_block + (4 * i + 3) * PGSIZE);
110         }
111         atomic_init(&vc_req_being_handled, 0);
112         assert(!in_vcore_context());
113         /* no longer need to enable notifs on vcore 0, it is set like that by
114          * default (so you drop into vcore context immediately on transtioning to
115          * _M) */
116         vc_initialized = TRUE;
117         return;
118 vcore_init_fail:
119         assert(0);
120 }
121
122 /* Helper functions used to reenter at the top of a vcore's stack for an
123  * arbitrary function */
124 static void __attribute__((noinline, noreturn)) 
125 __vcore_reenter()
126 {
127   __vcore_reentry_func();
128   assert(0);
129 }
130
131 void vcore_reenter(void (*entry_func)(void))
132 {
133   assert(in_vcore_context());
134   struct preempt_data *vcpd = vcpd_of(vcore_id());
135
136   __vcore_reentry_func = entry_func;
137   set_stack_pointer((void*)vcpd->transition_stack);
138   cmb();
139   __vcore_reenter();
140 }
141
142 /* This gets called in glibc before calling the programs 'main'.  Need to set
143  * ourselves up so that thread0 is a uthread, and then register basic signals to
144  * go to vcore 0. */
145 void vcore_event_init(void)
146 {
147         /* set up our thread0 as a uthread */
148         uthread_slim_init();
149         /* TODO: register for other kevents/signals and whatnot (can probably reuse
150          * the simple ev_q).  Could also do this via explicit functions from the
151          * program. */
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         assert(vc_initialized);
218         /* Early sanity checks */
219         if ((nr_new_vcores < 0) || (nr_new_vcores + num_vcores() > max_vcores()))
220                 return -1;      /* consider ERRNO */
221         /* Post our desires (ROS atomic_add() conflicts with glibc) */
222         atomic_fetch_and_add(&nr_new_vcores_wanted, nr_new_vcores);
223 try_handle_it:
224         cmb();  /* inc before swap.  the atomic is a CPU mb() */
225         if (atomic_swap(&vc_req_being_handled, 1)) {
226                 /* We got a 1 back, so someone else is already working on it */
227                 return 0;
228         }
229         /* So now we're the ones supposed to handle things.  This does things in the
230          * "increment based on the number we have", vs "increment on the number we
231          * said we want".
232          *
233          * Figure out how many we have, though this is racy.  Yields/preempts/grants
234          * will change this over time, and we may end up asking for less than we
235          * had. */
236         nr_vcores_wanted = num_vcores();
237         /* Pull all of the vcores wanted into our local variable, where we'll deal
238          * with prepping/requesting that many vcores.  Keep doing this til we think
239          * no more are wanted. */
240         while ((nr_to_prep_now = atomic_swap(&nr_new_vcores_wanted, 0))) {
241                 nr_vcores_wanted += nr_to_prep_now;
242                 /* Don't bother prepping or asking for more than we can ever get */
243                 nr_vcores_wanted = MIN(nr_vcores_wanted, max_vcores());
244                 /* Make sure all we might ask for are prepped */
245                 for (long i = _max_vcores_ever_wanted; i < nr_vcores_wanted; i++) {
246                         if (allocate_transition_stack(i) || allocate_transition_tls(i)) {
247                                 atomic_set(&vc_req_being_handled, 0);   /* unlock and bail out*/
248                                 return -1;
249                         }
250                         _max_vcores_ever_wanted++;      /* done in the loop to handle failures*/
251                 }
252         }
253         cmb();  /* force a reread of num_vcores() */
254         /* Update amt_wanted if we now want *more* than what the kernel already
255          * knows.  See notes in the func doc. */
256         if (nr_vcores_wanted > __procdata.res_req[RES_CORES].amt_wanted)
257                 __procdata.res_req[RES_CORES].amt_wanted = nr_vcores_wanted;
258         /* If num_vcores isn't what we want, we can poke the ksched.  Due to some
259          * races with yield, our desires may be old.  Not a big deal; any vcores
260          * that pop up will just end up yielding (or get preempt messages.)  */
261         if (nr_vcores_wanted > num_vcores())
262                 sys_poke_ksched(0, RES_CORES);  /* 0 -> poke for ourselves */
263         /* Unlock, (which lets someone else work), and check to see if more work
264          * needs to be done.  If so, we'll make sure it gets handled. */
265         atomic_set(&vc_req_being_handled, 0);   /* unlock, to allow others to try */
266         wrmb();
267         /* check for any that might have come in while we were out */
268         if (atomic_read(&nr_new_vcores_wanted))
269                 goto try_handle_it;
270         return 0;
271 }
272
273 /* This can return, if you failed to yield due to a concurrent event.  Note
274  * we're atomicly setting the CAN_RCV flag, and aren't bothering with CASing
275  * (either with the kernel or uthread's handle_indirs()).  We don't particularly
276  * care what other code does - we intend to set those flags no matter what. */
277 void vcore_yield(bool preempt_pending)
278 {
279         unsigned long old_nr;
280         uint32_t vcoreid = vcore_id();
281         struct preempt_data *vcpd = vcpd_of(vcoreid);
282         __sync_fetch_and_and(&vcpd->flags, ~VC_CAN_RCV_MSG);
283         /* no wrmb() necessary, handle_events() has an mb() if it is checking */
284         /* Clears notif pending and tries to handle events.  This is an optimization
285          * to avoid the yield syscall if we have an event pending.  If there is one,
286          * we want to unwind and return to the 2LS loop, where we may not want to
287          * yield anymore.
288          * Note that the kernel only cares about CAN_RCV_MSG for the desired vcore,
289          * not for a FALLBACK.  */
290         if (handle_events(vcoreid)) {
291                 __sync_fetch_and_or(&vcpd->flags, VC_CAN_RCV_MSG);
292                 return;
293         }
294         /* If we are yielding since we don't want the core, tell the kernel we want
295          * one less vcore (vc_yield assumes a dumb 2LS).
296          *
297          * If yield fails (slight race), we may end up having more vcores than
298          * amt_wanted for a while, and might lose one later on (after a
299          * preempt/timeslicing) - the 2LS will have to notice eventually if it
300          * actually needs more vcores (which it already needs to do).  amt_wanted
301          * could even be 0.
302          *
303          * In general, any time userspace decrements or sets to 0, it could get
304          * preempted, so the kernel will still give us at least one, until the last
305          * vcore properly yields without missing a message (and becomes a WAITING
306          * proc, which the ksched will not give cores to).
307          *
308          * I think it's possible for userspace to do this (lock, read amt_wanted,
309          * check all message queues for all vcores, subtract amt_wanted (not set to
310          * 0), unlock) so long as every event handler +1s the amt wanted, but that's
311          * a huge pain, and we already have event handling code making sure a
312          * process can't sleep (transition to WAITING) if a message arrives (can't
313          * yield if notif_pending, can't go WAITING without yielding, and the event
314          * posting the notif_pending will find the online VC or be delayed by
315          * spinlock til the proc is WAITING). */
316         if (!preempt_pending) {
317                 do {
318                         old_nr = __procdata.res_req[RES_CORES].amt_wanted;
319                         if (old_nr == 0)
320                                 break;
321                 } while (!__sync_bool_compare_and_swap(
322                              &__procdata.res_req[RES_CORES].amt_wanted,
323                              old_nr, old_nr - 1));
324         }
325         /* We can probably yield.  This may pop back up if notif_pending became set
326          * by the kernel after we cleared it and we lost the race. */
327         sys_yield(preempt_pending);
328         __sync_fetch_and_or(&vcpd->flags, VC_CAN_RCV_MSG);
329 }
330
331 /* Enables notifs, and deals with missed notifs by self notifying.  This should
332  * be rare, so the syscall overhead isn't a big deal.  The other alternative
333  * would be to uthread_yield(), which would require us to revert some uthread
334  * interface changes. */
335 void enable_notifs(uint32_t vcoreid)
336 {
337         __enable_notifs(vcoreid);
338         wrmb(); /* need to read after the write that enabled notifs */
339         /* Note we could get migrated before executing this.  If that happens, our
340          * vcore had gone into vcore context (which is what we wanted), and this
341          * self_notify to our old vcore is spurious and harmless. */
342         if (vcpd_of(vcoreid)->notif_pending)
343                 sys_self_notify(vcoreid, EV_NONE, 0, TRUE);
344 }
345
346 /* Helper to disable notifs.  It simply checks to make sure we disabled uthread
347  * migration, which is a common mistake. */
348 void disable_notifs(uint32_t vcoreid)
349 {
350         if (!in_vcore_context() && current_uthread)
351                 assert(current_uthread->flags & UTHREAD_DONT_MIGRATE);
352         __disable_notifs(vcoreid);
353 }
354
355 /* Like smp_idle(), this will put the core in a state that it can only be woken
356  * up by an IPI.  In the future, we may halt or something.  This will return if
357  * an event was pending (could be the one you were waiting for). */
358 void vcore_idle(void)
359 {
360         uint32_t vcoreid = vcore_id();
361         if (handle_events(vcoreid))
362                 return;
363         enable_notifs(vcoreid);
364         while (1) {
365                 cpu_relax();
366         }
367 }
368
369 /* Helper, that actually makes sure a vcore is running.  Call this is you really
370  * want vcoreid.  More often, you'll want to call the regular version. */
371 static void __ensure_vcore_runs(uint32_t vcoreid)
372 {
373         if (vcore_is_preempted(vcoreid)) {
374                 printd("[vcore]: VC %d changing to VC %d\n", vcore_id(), vcoreid);
375                 /* Note that at this moment, the vcore could still be mapped (we're
376                  * racing with __preempt.  If that happens, we'll just fail the
377                  * sys_change_vcore(), and next time __ensure runs we'll get it. */
378                 /* We want to recover them from preemption.  Since we know they have
379                  * notifs disabled, they will need to be directly restarted, so we can
380                  * skip the other logic and cut straight to the sys_change_vcore() */
381                 sys_change_vcore(vcoreid, FALSE);
382         }
383 }
384
385 /* Helper, looks for any preempted vcores, making sure each of them runs at some
386  * point.  This is pretty heavy-weight, and should be used to help get out of
387  * weird deadlocks (spinning in vcore context, waiting on another vcore).  If
388  * you might know which vcore you are waiting on, use ensure_vc_runs. */
389 static void __ensure_all_run(void)
390 {
391         for (int i = 0; i < max_vcores(); i++)
392                 __ensure_vcore_runs(i);
393 }
394
395 /* Makes sure a vcore is running.  If it is preempted, we'll switch to
396  * it.  This will return, either immediately if the vcore is running, or later
397  * when someone preempt-recovers us.
398  *
399  * If you pass in your own vcoreid, this will make sure all other preempted
400  * vcores run. */
401 void ensure_vcore_runs(uint32_t vcoreid)
402 {
403         /* if the vcoreid is ourselves, make sure everyone else is running */
404         if (vcoreid == vcore_id()) {
405                 __ensure_all_run();
406                 return;
407         }
408         __ensure_vcore_runs(vcoreid);
409 }
410
411 #define NR_RELAX_SPINS 1000
412 /* If you are spinning in vcore context and it is likely that you don't know who
413  * you are waiting on, call this.  It will spin for a bit before firing up the
414  * potentially expensive __ensure_all_run().  Don't call this from uthread
415  * context.  sys_change_vcore will probably mess you up. */
416 void cpu_relax_vc(uint32_t vcoreid)
417 {
418         unsigned int spun = 0;
419         assert(in_vcore_context());
420         if (spun++ >= NR_RELAX_SPINS) {
421                 /* if vcoreid == vcore_id(), this might be expensive */
422                 ensure_vcore_runs(vcoreid);
423                 spun = 0;
424         }
425         cpu_relax();
426 }
427
428 /* Check with the kernel to determine what vcore we are.  Normally, you should
429  * never call this, since your vcoreid is stored in your TLS.  Also, if you call
430  * it from a uthread, you could get migrated, so you should drop into some form
431  * of vcore context (DONT_MIGRATE on) */
432 uint32_t get_vcoreid(void)
433 {
434         if (!in_vcore_context()) {
435                 assert(current_uthread);
436                 assert(current_uthread->flags & UTHREAD_DONT_MIGRATE);
437         }
438         return __get_vcoreid();
439 }
440
441 /* Debugging helper.  Pass in the string you want printed if your vcoreid is
442  * wrong, and pass in what vcoreid you think you are.  Don't call from uthread
443  * context unless migrations are disabled.  Will print some stuff and return
444  * FALSE if you were wrong. */
445 bool check_vcoreid(const char *str, uint32_t vcoreid)
446 {
447         uint32_t kvcoreid = get_vcoreid();
448         if (vcoreid != kvcoreid) {
449                 ros_debug("%s: VC %d thought it was VC %d\n", str, kvcoreid, vcoreid);
450                 return FALSE;
451         }
452         return TRUE;
453 }