notif_enabled -> notif_disabled (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 = &__procdata.vcore_preempt_data[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 vcore */
134         mmap_block = (uintptr_t)mmap(0, PGSIZE * 2 * 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                 /* two pages each from the big block */
145                 ucq_init_raw(&__procdata.vcore_preempt_data[i].ev_mbox.ev_msgs,
146                              mmap_block + (2 * i    ) * PGSIZE, 
147                              mmap_block + (2 * i + 1) * PGSIZE); 
148         }
149         atomic_init(&vc_req_being_handled, 0);
150         assert(!in_vcore_context());
151         initialized = 1;
152         /* no longer need to enable notifs on vcore 0, it is set like that by
153          * default (so you drop into vcore context immediately on transtioning to
154          * _M) */
155         return 0;
156 vcore_init_tls_fail:
157         free(vcore_thread_control_blocks);
158 vcore_init_fail:
159         errno = ENOMEM;
160         return -1;
161 }
162
163 /* Returns -1 with errno set on error, or 0 on success.  This does not return
164  * the number of cores actually granted (though some parts of the kernel do
165  * internally).
166  *
167  * Note the doesn't block or anything (despite the min number requested is
168  * 1), since the kernel won't block the call.
169  *
170  * There are a few concurrency concerns.  We have _max_vcores_ever_wanted,
171  * initialization of new vcore stacks/TLSs, making sure we don't ask for too
172  * many (minor point), and most importantly not asking the kernel for too much
173  * or otherwise miscommunicating our desires to the kernel.  Remember, the
174  * kernel wants just one answer from the process about what it wants, and it is
175  * up to the process to figure that out.
176  *
177  * So we basically have one thread do the submitting/prepping/bookkeeping, and
178  * other threads come in just update the number wanted and make sure someone
179  * is sorting things out.  This will perform a bit better too, since only one
180  * vcore makes syscalls (which hammer the proc_lock).  This essentially has
181  * cores submit work, and one core does the work (like Eric's old delta
182  * functions).
183  *
184  * There's a slight semantic change: this will return 0 (success) for the
185  * non-submitters, and 0 if we submitted.  -1 only if the submitter had some
186  * non-kernel failure.
187  *
188  * Also, beware that this (like the old version) doesn't protect with races on
189  * num_vcores().  num_vcores() is how many you have now or very soon (accounting
190  * for messages in flight that will take your cores), not how many you told the
191  * kernel you want. */
192 int vcore_request(long nr_new_vcores)
193 {
194         long nr_to_prep_now, nr_vcores_wanted;
195
196         if (vcore_init() < 0)
197                 return -1;      /* consider ERRNO */
198         /* Early sanity checks */
199         if ((nr_new_vcores < 0) || (nr_new_vcores + num_vcores() > max_vcores()))
200                 return -1;      /* consider ERRNO */
201         /* Post our desires (ROS atomic_add() conflicts with glibc) */
202         atomic_fetch_and_add(&nr_new_vcores_wanted, nr_new_vcores);
203 try_handle_it:
204         cmb();  /* inc before swap.  the atomic is a CPU mb() */
205         if (atomic_swap(&vc_req_being_handled, 1)) {
206                 /* We got a 1 back, so someone else is already working on it */
207                 return 0;
208         }
209 handle_it:
210         /* So now we're the ones supposed to handle things.  Figure out how many we
211          * have, though this is racy.  Yields/preempts/grants will change this over
212          * time, and we may end up asking for less than we had. */
213         nr_vcores_wanted = num_vcores();
214         cmb();  /* force a reread of num_vcores() later */
215         /* Pull all of the vcores wanted into our local variable, where we'll deal
216          * with prepping/requesting that many vcores.  Keep doing this til we think
217          * no more are wanted. */
218         while ((nr_to_prep_now = atomic_swap(&nr_new_vcores_wanted, 0))) {
219                 nr_vcores_wanted += nr_to_prep_now;
220                 /* Don't bother prepping or asking for more than we can ever get */
221                 nr_vcores_wanted = MIN(nr_vcores_wanted, max_vcores());
222                 /* Make sure all we might ask for are prepped */
223                 for(long i = _max_vcores_ever_wanted; i < nr_vcores_wanted; i++) {
224                         if (allocate_transition_stack(i) || allocate_transition_tls(i)) {
225                                 atomic_set(&vc_req_being_handled, 0);   /* unlock and bail out*/
226                                 return -1;
227                         }
228                         _max_vcores_ever_wanted++;      /* done in the loop to handle failures*/
229                 }
230         }
231         /* Got all the ones we can get, let's submit it to the kernel.  We check
232          * against num_vcores() one last time, though we still have some races... */
233         if (nr_vcores_wanted > num_vcores()) {
234                 sys_resource_req(RES_CORES, nr_vcores_wanted, 1, 0);
235                 cmb();  /* force a reread of num_vcores() at handle_it: */
236                 goto handle_it;
237         }
238         /* Here, we believe there are none left to do */
239         atomic_set(&vc_req_being_handled, 0);   /* unlock, to allow others to try */
240         /* Double check for any that might have come in while we were out */
241         if (atomic_read(&nr_new_vcores_wanted))
242                 goto try_handle_it;
243         return 0;
244 }
245
246 /* This can return, if you failed to yield due to a concurrent event. */
247 void vcore_yield(bool preempt_pending)
248 {
249         uint32_t vcoreid = vcore_id();
250         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
251         vcpd->can_rcv_msg = FALSE;
252         /* no wrmb() necessary, clear_notif() has an mb() */
253         /* Clears notif pending.  If we had an event outstanding, this will handle
254          * it and return TRUE, at which point we want to unwind and return to the
255          * 2LS loop (where we may not want to yield anymore).  Note that the kernel
256          * only cares about can_rcv_msg for the desired vcore, not for a FALLBACK.
257          * We need to deal with this notif_pending business regardless of
258          * can_rcv_msg.  We just want to avoid a yield syscall if possible.  It is
259          * important that clear_notif_pending will handle_events().  That is
260          * necessary to do/check after setting can_rcv_msg to FALSE. */
261         if (clear_notif_pending(vcoreid)) {
262                 vcpd->can_rcv_msg = TRUE;
263                 return;
264         }
265         /* We can probably yield.  This may pop back up if notif_pending became set
266          * by the kernel after we cleared it and we lost the race. */
267         sys_yield(preempt_pending);
268         vcpd->can_rcv_msg = TRUE;
269 }
270
271 /* Clear pending, and try to handle events that came in between a previous call
272  * to handle_events() and the clearing of pending.  While it's not a big deal,
273  * we'll loop in case we catch any.  Will break out of this once there are no
274  * events, and we will have send pending to 0. 
275  *
276  * Note that this won't catch every race/case of an incoming event.  Future
277  * events will get caught in pop_ros_tf() or proc_yield() */
278 bool clear_notif_pending(uint32_t vcoreid)
279 {
280         bool handled_event = FALSE;
281         do {
282                 __procdata.vcore_preempt_data[vcoreid].notif_pending = 0;
283                 /* need a full mb(), since handle events might be just a read or might
284                  * be a write, either way, it needs to happen after notif_pending */
285                 mb();
286                 handled_event = handle_events(vcoreid);
287         } while (handled_event);
288         return handled_event;
289 }
290
291 /* Enables notifs, and deals with missed notifs by self notifying.  This should
292  * be rare, so the syscall overhead isn't a big deal.  The other alternative
293  * would be to uthread_yield(), which would require us to revert some uthread
294  * interface changes. */
295 void enable_notifs(uint32_t vcoreid)
296 {
297         __enable_notifs(vcoreid);
298         wrmb(); /* need to read after the write that enabled notifs */
299         /* Note we could get migrated before executing this.  If that happens, our
300          * vcore had gone into vcore context (which is what we wanted), and this
301          * self_notify to our old vcore is spurious and harmless. */
302         if (__procdata.vcore_preempt_data[vcoreid].notif_pending)
303                 sys_self_notify(vcoreid, EV_NONE, 0);
304 }
305
306 /* Helper to disable notifs.  It simply checks to make sure we disabled uthread
307  * migration, which is a common mistake. */
308 void disable_notifs(uint32_t vcoreid)
309 {
310         if (!in_vcore_context() && current_uthread)
311                 assert(current_uthread->flags & UTHREAD_DONT_MIGRATE);
312         __disable_notifs(vcoreid);
313 }
314
315 /* Like smp_idle(), this will put the core in a state that it can only be woken
316  * up by an IPI.  In the future, we may halt or something. */
317 void __attribute__((noreturn)) vcore_idle(void)
318 {
319         uint32_t vcoreid = vcore_id();
320         clear_notif_pending(vcoreid);
321         enable_notifs(vcoreid);
322         while (1) {
323                 cpu_relax();
324         }
325 }