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