Vcore mapping and idle core management
[akaros.git] / kern / src / process.c
1 /*
2  * Copyright (c) 2009 The Regents of the University of California
3  * Barret Rhoden <brho@cs.berkeley.edu>
4  * See LICENSE for details.
5  */
6
7 #ifdef __SHARC__
8 #pragma nosharc
9 #endif
10
11 #include <arch/arch.h>
12 #include <process.h>
13 #include <atomic.h>
14 #include <smp.h>
15 #include <pmap.h>
16 #include <schedule.h>
17 #include <manager.h>
18 #include <stdio.h>
19 #include <assert.h>
20 #include <timing.h>
21 #include <sys/queue.h>
22
23 /* Process Lists */
24 struct proc_list proc_freelist = TAILQ_HEAD_INITIALIZER(proc_freelist);
25 spinlock_t freelist_lock = 0;
26 struct proc_list proc_runnablelist = TAILQ_HEAD_INITIALIZER(proc_runnablelist);
27 spinlock_t runnablelist_lock = 0;
28
29 /* Tracks which cores are idle, similar to the vcoremap.  Each value is the
30  * physical coreid of an unallocated core. */
31 spinlock_t idle_lock = 0;
32 uint32_t idlecoremap[MAX_NUM_CPUS];
33 uint32_t num_idlecores = 0;
34
35 /*
36  * While this could be done with just an assignment, this gives us the
37  * opportunity to check for bad transitions.  Might compile these out later, so
38  * we shouldn't rely on them for sanity checking from userspace.
39  */
40 int proc_set_state(struct proc *p, uint32_t state)
41 {
42         uint32_t curstate = p->state;
43         /* Valid transitions:
44          * C   -> RBS
45          * RBS -> RGS
46          * RGS -> RBS
47          * RGS -> W
48          * W   -> RBS
49          * RGS -> RBM
50          * RBM -> RGM
51          * RGM -> RBM
52          * RGM -> RBS
53          * RGS -> D
54          * RGM -> D
55          *
56          * These ought to be implemented later (allowed, not thought through yet).
57          * RBS -> D
58          * RBM -> D
59          *
60          * This isn't allowed yet, may be later.
61          * C   -> D
62          */
63         #if 1 // some sort of correctness flag
64         switch (curstate) {
65                 case PROC_CREATED:
66                         if (state != PROC_RUNNABLE_S)
67                                 panic("Invalid State Transition! PROC_CREATED to %d", state);
68                         break;
69                 case PROC_RUNNABLE_S:
70                         if (!(state & (PROC_RUNNING_S | PROC_DYING)))
71                                 panic("Invalid State Transition! PROC_RUNNABLE_S to %d", state);
72                         break;
73                 case PROC_RUNNING_S:
74                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
75                                        PROC_DYING)))
76                                 panic("Invalid State Transition! PROC_RUNNING_S to %d", state);
77                         break;
78                 case PROC_WAITING:
79                         if (state != PROC_RUNNABLE_S)
80                                 panic("Invalid State Transition! PROC_WAITING to %d", state);
81                         break;
82                 case PROC_DYING:
83                         if (state != PROC_CREATED) // when it is reused (TODO)
84                                 panic("Invalid State Transition! PROC_DYING to %d", state);
85                         break;
86                 case PROC_RUNNABLE_M:
87                         if (!(state & (PROC_RUNNING_M | PROC_DYING)))
88                                 panic("Invalid State Transition! PROC_RUNNABLE_M to %d", state);
89                         break;
90                 case PROC_RUNNING_M:
91                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_DYING)))
92                                 panic("Invalid State Transition! PROC_RUNNING_M to %d", state);
93                         break;
94         }
95         #endif
96         p->state = state;
97         return 0;
98 }
99
100 /* Change this when we aren't using an array */
101 struct proc *get_proc(unsigned pid)
102 {
103         // should have some error checking when we do this for real
104         return &envs[ENVX(pid)];
105 }
106
107 /* Whether or not actor can control target */
108 bool proc_controls(struct proc *actor, struct proc *target)
109 {
110         return target->env_parent_id == actor->env_id;
111 }
112
113 /*
114  * Dispatches a process to run, either on the current core in the case of a
115  * RUNNABLE_S, or on its partition in the case of a RUNNABLE_M.
116  * This should never be called to "restart" a core.
117  */
118 void proc_run(struct proc *p)
119 {
120         spin_lock_irqsave(&p->proc_lock);
121         switch (p->state) {
122                 case (PROC_DYING):
123                         spin_unlock_irqsave(&p->proc_lock);
124                         printk("Process %d not starting due to async death\n", p->env_id);
125                         // There should be no core cleanup to do (like decref).
126                         assert(current != p);
127                         // if we're a worker core, smp_idle, o/w return
128                         if (!management_core())
129                                 smp_idle(); // this never returns
130                         return;
131                 case (PROC_RUNNABLE_S):
132                         proc_set_state(p, PROC_RUNNING_S);
133                         // We will want to know where this process is running, even if it is
134                         // only in RUNNING_S.  can use the vcoremap, which makes death easy.
135                         // we may need the pcoremap entry to mark it as a RUNNING_S core, or
136                         // else update it here. (TODO) (PCORE)
137                         p->num_vcores = 0;
138                         p->vcoremap[0] = core_id();
139                         spin_unlock_irqsave(&p->proc_lock);
140                         // This normally doesn't return, but might error out in the future.
141                         proc_startcore(p, &p->env_tf);
142                         break;
143                 case (PROC_RUNNABLE_M):
144                         proc_set_state(p, PROC_RUNNING_M);
145                         /* vcoremap[i] holds the coreid of the physical core allocated to
146                          * this process.  It is set outside proc_run.  For the active
147                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
148                         if (p->num_vcores) {
149                                 // TODO: handle silly state (HSS)
150                                 // set virtual core 0 to run the main context
151                                 send_active_msg_sync(p->vcoremap[0], __startcore, p,
152                                                      &p->env_tf, 0);
153                                 /* handle the others.  note the sync message will spin until
154                                  * there is a free active message slot, which could lock up the
155                                  * system.  think about this. (TODO) */
156                                 for (int i = 1; i < p->num_vcores; i++)
157                                         send_active_msg_sync(p->vcoremap[i], __startcore, p, 0, i);
158                         }
159                         /* There a subtle (attempted) race avoidance here.  proc_startcore
160                          * can handle a death message, but we can't have the startcore come
161                          * after the death message.  Otherwise, it would look like a new
162                          * process.  So we hold the lock to make sure our message went out
163                          * before a possible death message.
164                          * - Likewise, we need interrupts to be disabled, in case one of the
165                          *   messages was for us, and reenable them after letting go of the
166                          *   lock.  This is done by spin_lock_irqsave, so be careful if you
167                          *   change this.
168                          * - This can also be done far more intelligently / efficiently,
169                          *   like skipping in case it's busy and coming back later.
170                          * - Note there is no guarantee this core's interrupts were on, so
171                          *   it may not get the message for a while... */
172                         spin_unlock_irqsave(&p->proc_lock);
173                         break;
174                 default:
175                         spin_unlock_irqsave(&p->proc_lock);
176                         panic("Invalid process state in proc_run()!!");
177         }
178 }
179
180 /*
181  * Runs the given context (trapframe) of process p on the core this code
182  * executes on.  The refcnt tracks how many cores have "an interest" in this
183  * process, which so far just means it uses the process's page table.  See the
184  * massive comments around the incref function
185  *
186  * Given we are RUNNING_*, an IPI for death or preemption could come in:
187  * 1. death attempt (IPI to kill whatever is on your core):
188  *              we don't need to worry about protecting the stack, since we're
189  *              abandoning ship - just need to get a good cr3 and decref current, which
190  *              the death handler will do.
191  *              If a death IPI comes in, we immediately stop this function and will
192  *              never come back.
193  * 2. preempt attempt (IPI to package state and maybe run something else):
194  *              - if a preempt attempt comes in while we're in the kernel, it'll
195  *              just set a flag.  we could attempt to bundle the kernel state
196  *              and rerun it later, but it's really messy (and possibly given
197  *              back to userspace).  we'll disable ints, check this flag, and if
198  *              so, handle the preemption using the same funcs as the normal
199  *              preemption handler.  nonblocking kernel calls will just slow
200  *              down the preemption while they work.  blocking kernel calls will
201  *              need to package their state properly anyway.
202  *
203  * TODO: in general, think about when we no longer need the stack, in case we
204  * are preempted and expected to run again from somewhere else.  we can't
205  * expect to have the kernel stack around anymore.  the nice thing about being
206  * at this point is that we are just about ready to give up the stack anyways.
207  *
208  * I think we need to make it such that the kernel in "process context" never
209  * gets removed from the core (displaced from its stack) without going through
210  * some "bundling" code.
211  */
212 void proc_startcore(struct proc *p, trapframe_t *tf) {
213         // it's possible to be DYING, but it's a rare race.
214         //if (p->state & (PROC_RUNNING_S | PROC_RUNNING_M))
215         //      printk("dying before (re)startcore on core %d\n", core_id());
216
217         // sucks to have ints disabled when doing env_decref and possibly freeing
218         disable_irq();
219         if (per_cpu_info[core_id()].preempt_pending) {
220                 // TODO: handle preemption
221                 // the functions will need to consider deal with current like down below
222                 panic("Preemption not supported!");
223         }
224         /* If the process wasn't here, then we need to load its address space. */
225         if (p != current) {
226                 if (proc_incref(p)) {
227                         // getting here would mean someone tried killing this while we tried
228                         // to start one of it's contexts (from scratch, o/w we had it's CR3
229                         // loaded already)
230                         // if this happens, a no-op death-IPI ought to be on its way...  we can
231                         // just smp_idle()
232                         smp_idle();
233                 }
234                 lcr3(p->env_cr3);
235                 // we unloaded the old cr3, so decref it (if it exists)
236                 // TODO: Consider moving this to wherever we really "mean to leave the
237                 // process's context".
238                 if (current)
239                         proc_decref(current);
240                 current = p;
241         }
242         /* need to load our silly state, preferably somewhere other than here so we
243          * can avoid the case where the context was just running here.  it's not
244          * sufficient to do it in the "new process" if-block above (could be things
245          * like page faults that cause us to keep the same process, but want a
246          * different context.
247          * for now, we load this silly state here. (TODO) (HSS)
248          * We also need this to be per trapframe, and not per process...
249          */
250         env_pop_ancillary_state(p);
251         env_pop_tf(tf);
252 }
253
254 /*
255  * Destroys the given process.  This may be called from another process, a light
256  * kernel thread (no real process context), asynchronously/cross-core, or from
257  * the process on its own core.
258  *
259  * Here's the way process death works:
260  * 0. grab the lock (protects state transition and core map)
261  * 1. set state to dying.  that keeps the kernel from doing anything for the
262  * process (like proc_running it).
263  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
264  * 3. IPI to clean up those cores (decref, etc).
265  * 4. Unlock
266  * 5. Clean up your core, if applicable
267  * (Last core/kernel thread to decref cleans up and deallocates resources.)
268  *
269  * Note that some cores can be processing async calls, but will eventually
270  * decref.  Should think about this more.
271  */
272 void proc_destroy(struct proc *p)
273 {
274         // Note this code relies on this lock disabling interrupts, similar to
275         // proc_run.
276         spin_lock_irqsave(&p->proc_lock);
277         switch (p->state) {
278                 case PROC_DYING:
279                         return; // someone else killed this already.
280                 case PROC_RUNNABLE_S:
281                 case PROC_RUNNABLE_M:
282                         // Think about other lists, like WAITING, or better ways to do this
283                         deschedule_proc(p);
284                         break;
285                 case PROC_RUNNING_S:
286                         #if 0
287                         // here's how to do it manually
288                         if (current == p) {
289                                 lcr3(boot_cr3);
290                                 proc_decref(p); // this decref is for the cr3
291                                 current = NULL;
292                         }
293                         #endif
294                         send_active_msg_sync(p->vcoremap[0], __death, 0, 0, 0);
295                         #if 0
296                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
297                          * managed by the idlecoremap.  so don't do this yet. */
298                         spin_lock(&idle_lock);
299                         idlecoremap[num_idlecores++] = p->vcoremap[0];
300                         spin_unlock(&idle_lock);
301                         #endif
302                         break;
303                 case PROC_RUNNING_M:
304                         /* Send the DEATH message to every core running this process, and
305                          * deallocate the cores.
306                          * The rule is that the vcoremap is set before proc_run, and reset
307                          * within proc_destroy */
308                         spin_lock(&idle_lock);
309                         for (int i = 0; i < p->num_vcores; i++) {
310                                 send_active_msg_sync(p->vcoremap[i], __death, 0, 0, 0);
311                                 // give the pcore back to the idlecoremap
312                                 assert(num_idlecores < num_cpus); // sanity
313                                 idlecoremap[num_idlecores++] = p->vcoremap[i];
314                                 p->vcoremap[i] = 0; // TODO: might need a better signal
315                         }
316                         spin_unlock(&idle_lock);
317                         break;
318                 default:
319                         panic("Weird state in proc_destroy");
320         }
321         proc_set_state(p, PROC_DYING);
322
323         atomic_dec(&num_envs);
324         /* TODO: (REF) dirty hack.  decref currently uses a lock, but needs to use
325          * CAS instead (another lock would be slightly less ghetto).  but we need to
326          * decref before releasing the lock, since that could enable interrupts,
327          * which would have us receive the DEATH IPI if this was called locally by
328          * the target process. */
329         //proc_decref(p); // this decref is for the process in general
330         p->env_refcnt--;
331         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
332
333         /* After unlocking, we can receive a DEATH IPI and clean up */
334         spin_unlock_irqsave(&p->proc_lock);
335
336         // coupled with the refcnt-- above, from decref.  if this happened,
337         // proc_destroy was called "remotely", and with no one else refcnting
338         if (!refcnt)
339                 env_free(p);
340
341         /* If we were running the process, we should have received an IPI by now.
342          * If not, odds are interrupts are disabled, which shouldn't happen while
343          * servicing syscalls. */
344         assert(current != p);
345         return;
346 }
347
348 /*
349  * The process refcnt is the number of places the process 'exists' in the
350  * system.  Creation counts as 1.  Having your page tables loaded somewhere
351  * (lcr3) counts as another 1.  A non-RUNNING_* process should have refcnt at
352  * least 1.  If the kernel is on another core and in a processes address space
353  * (like processing its backring), that counts as another 1.
354  *
355  * Note that the actual loading and unloading of cr3 is up to the caller, since
356  * that's not the only use for this (and decoupling is more flexible).
357  *
358  * The refcnt should always be greater than 0 for processes that aren't dying.
359  * When refcnt is 0, the process is dying and should not allow any more increfs.
360  * A process can be dying with a refcnt greater than 0, since it could be
361  * waiting for other cores to "get the message" to die, or a kernel core can be
362  * finishing work in the processes's address space.
363  *
364  * Implementation aside, the important thing is that we atomically increment
365  * only if it wasn't already 0.  If it was 0, then we shouldn't be attaching to
366  * the process, so we return an error, which should be handled however is
367  * appropriate.  We currently use spinlocks, but some sort of clever atomics
368  * would work too.
369  *
370  * Also, no one should ever update the refcnt outside of these functions.
371  * Eventually, we'll have Ivy support for this. (TODO)
372  *
373  * TODO: (REF) change to use CAS.
374  */
375 error_t proc_incref(struct proc *p)
376 {
377         error_t retval = 0;
378         spin_lock_irqsave(&p->proc_lock);
379         if (p->env_refcnt)
380                 p->env_refcnt++;
381         else
382                 retval = -EBADENV;
383         spin_unlock_irqsave(&p->proc_lock);
384         return retval;
385 }
386
387 /*
388  * When the kernel is done with a process, it decrements its reference count.
389  * When the count hits 0, no one is using it and it should be freed.
390  * "Last one out" actually finalizes the death of the process.  This is tightly
391  * coupled with the previous function (incref)
392  * Be sure to load a different cr3 before calling this!
393  *
394  * TODO: (REF) change to use CAS.  Note that when we do so, we may be holding
395  * the process lock when calling env_free().
396  */
397 void proc_decref(struct proc *p)
398 {
399         spin_lock_irqsave(&p->proc_lock);
400         p->env_refcnt--;
401         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
402         spin_unlock_irqsave(&p->proc_lock);
403         // if we hit 0, no one else will increment and we can check outside the lock
404         if (!refcnt)
405                 env_free(p);
406 }
407
408 /* Active message handler to start a process's context on this core.  Tightly
409  * coupled with proc_run() */
410 void __startcore(trapframe_t *tf, uint32_t srcid, uint32_t a0, uint32_t a1,
411                  uint32_t a2)
412 {
413         uint32_t coreid = core_id();
414         struct proc *p_to_run = (struct proc *SAFE) TC(a0);
415         trapframe_t local_tf;
416         trapframe_t *tf_to_pop = (trapframe_t *SAFE) TC(a1);
417
418         printk("Startcore on core %d\n", coreid);
419         assert(p_to_run);
420         // TODO: handle silly state (HSS)
421         if (!tf_to_pop) {
422                 tf_to_pop = &local_tf;
423                 memset(tf_to_pop, 0, sizeof(*tf_to_pop));
424                 proc_init_trapframe(tf_to_pop);
425                 // Note the init_tf sets tf_to_pop->tf_esp = USTACKTOP;
426                 proc_set_tfcoreid(tf_to_pop, a2);
427                 proc_set_program_counter(tf_to_pop, p_to_run->env_entry);
428         }
429         proc_startcore(p_to_run, tf_to_pop);
430 }
431
432 /* Active message handler to stop running whatever context is on this core and
433  * to idle.  Note this leaves no trace of what was running.
434  * It's okay if death comes to a core that's already idling and has no current.
435  * It could happen if a process decref'd before proc_startcore could incref. */
436 void __death(trapframe_t *tf, uint32_t srcid, uint32_t a0, uint32_t a1,
437              uint32_t a2)
438 {
439         /* If we are currently running an address space on our core, we need a known
440          * good pgdir before releasing the old one.  This is currently the major
441          * practical implication of the kernel caring about a processes existence
442          * (the inc and decref).  This decref corresponds to the incref in
443          * proc_startcore (though it's not the only one). */
444         if (current) {
445                 lcr3(boot_cr3);
446                 proc_decref(current);
447                 current = NULL;
448         }
449         smp_idle();
450 }
451
452 void print_idlecoremap(void)
453 {
454         spin_lock(&idle_lock);
455         for (int i = 0; i < num_idlecores; i++)
456                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
457         spin_unlock(&idle_lock);
458 }