proc_run supports dispatching of RUNNABLE_Ms
[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 /*
30  * While this could be done with just an assignment, this gives us the
31  * opportunity to check for bad transitions.  Might compile these out later, so
32  * we shouldn't rely on them for sanity checking from userspace.
33  */
34 int proc_set_state(struct proc *p, uint32_t state)
35 {
36         uint32_t curstate = p->state;
37         /* Valid transitions:
38          * C   -> RBS
39          * RBS -> RGS
40          * RGS -> RBS
41          * RGS -> W
42          * W   -> RBS
43          * RGS -> RBM
44          * RBM -> RGM
45          * RGM -> RBM
46          * RGM -> RBS
47          * RGS -> D
48          * RGM -> D
49          *
50          * These ought to be implemented later (allowed, not thought through yet).
51          * RBS -> D
52          * RBM -> D
53          *
54          * This isn't allowed yet, may be later.
55          * C   -> D
56          */
57         #if 1 // some sort of correctness flag
58         switch (curstate) {
59                 case PROC_CREATED:
60                         if (state != PROC_RUNNABLE_S)
61                                 panic("Invalid State Transition! PROC_CREATED to %d", state);
62                         break;
63                 case PROC_RUNNABLE_S:
64                         if (!(state & (PROC_RUNNING_S | PROC_DYING)))
65                                 panic("Invalid State Transition! PROC_RUNNABLE_S to %d", state);
66                         break;
67                 case PROC_RUNNING_S:
68                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
69                                        PROC_DYING)))
70                                 panic("Invalid State Transition! PROC_RUNNING_S to %d", state);
71                         break;
72                 case PROC_WAITING:
73                         if (state != PROC_RUNNABLE_S)
74                                 panic("Invalid State Transition! PROC_WAITING to %d", state);
75                         break;
76                 case PROC_DYING:
77                         if (state != PROC_CREATED) // when it is reused (TODO)
78                                 panic("Invalid State Transition! PROC_DYING to %d", state);
79                         break;
80                 case PROC_RUNNABLE_M:
81                         if (!(state & (PROC_RUNNING_M | PROC_DYING)))
82                                 panic("Invalid State Transition! PROC_RUNNABLE_M to %d", state);
83                         break;
84                 case PROC_RUNNING_M:
85                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_DYING)))
86                                 panic("Invalid State Transition! PROC_RUNNING_M to %d", state);
87                         break;
88         }
89         #endif
90         p->state = state;
91         return 0;
92 }
93
94 /* Change this when we aren't using an array */
95 struct proc *get_proc(unsigned pid)
96 {
97         // should have some error checking when we do this for real
98         return &envs[ENVX(pid)];
99 }
100
101 /* Whether or not actor can control target */
102 bool proc_controls(struct proc *actor, struct proc *target)
103 {
104         return target->env_parent_id == actor->env_id;
105 }
106
107 /*
108  * Dispatches a process to run, either on the current core in the case of a
109  * RUNNABLE_S, or on its partition in the case of a RUNNABLE_M.
110  * This should never be called to "restart" a core.
111  */
112 void proc_run(struct proc *p)
113 {
114         spin_lock_irqsave(&p->proc_lock);
115         switch (p->state) {
116                 case (PROC_DYING):
117                         spin_unlock_irqsave(&p->proc_lock);
118                         printk("Process %d not starting due to async death\n", p->env_id);
119                         // There should be no core cleanup to do (like decref).
120                         assert(current != p);
121                         // if we're a worker core, smp_idle, o/w return
122                         // TODO considering encapsulating this block (core_id too)
123                         if (core_id())
124                                 smp_idle(); // this never returns
125                         return;
126                 case (PROC_RUNNABLE_S):
127                         proc_set_state(p, PROC_RUNNING_S);
128                         spin_unlock_irqsave(&p->proc_lock);
129                         // This normally doesn't return, but might error out in the future.
130                         proc_startcore(p, &p->env_tf);
131                         break;
132                 case (PROC_RUNNABLE_M):
133                         proc_set_state(p, PROC_RUNNING_M);
134                         /* Prep each core that we are going to run this process on.
135                          * vcoremap[i] holds the coreid of the physical core allocated to
136                          * this process.  It is set outside proc_run */
137                         for (int i = 0; i < p->num_vcores; i++) {
138                                 per_cpu_info[p->vcoremap[i]].p_to_run = p;
139                         }
140                         // set virtual core 0 to run the main context
141                         // TODO: handle silly state (HSS)
142                         per_cpu_info[p->vcoremap[0]].tf_to_pop = &p->env_tf;
143                         /* needed to make sure the writes beat the IPI.  could have done it
144                          * with other mem accesses, like grabbing a lock, and the write
145                          * would have made it */
146                         wmb_f();
147                         /* There a subtle (attempted) race avoidance here.  proc_startcore
148                          * can handle a death IPI, but we can't have the startcore come
149                          * after the death IPI.  Otherwise, it would look like a new
150                          * process.  So we hold the lock to make sure our IPI went out
151                          * before a possible death IPI.
152                          * Likewise, we disable interrupts, in case one of the IPIs was for
153                          * us, and reenable them after letting go of the lock.
154                          * Note there is no guarantee this core's interrupts were on, so it
155                          * may not get the IPI for a while... */
156                         int8_t state = 0;
157                         disable_irqsave(&state);
158                         for (int i = 0; i < p->num_vcores; i++)
159                                 send_ipi(p->vcoremap[i], 0, I_STARTCORE);
160                         spin_unlock_irqsave(&p->proc_lock);
161                         enable_irqsave(&state);
162                         break;
163                 default:
164                         spin_unlock_irqsave(&p->proc_lock);
165                         panic("Invalid process state in proc_run()!!");
166         }
167 }
168
169 /*
170  * Runs the given context (trapframe) of process p on the core this code
171  * executes on.  The refcnt tracks how many cores have "an interest" in this
172  * process, which so far just means it uses the process's page table.  See the
173  * massive comments around the incref function
174  *
175  * Given we are RUNNING_*, an IPI for death or preemption could come in:
176  * 1. death attempt (IPI to kill whatever is on your core):
177  *              we don't need to worry about protecting the stack, since we're
178  *              abandoning ship - just need to get a good cr3 and decref current, which
179  *              the death handler will do.
180  *              If a death IPI comes in, we immediately stop this function and will
181  *              never come back.
182  * 2. preempt attempt (IPI to package state and maybe run something else):
183  *              - if a preempt attempt comes in while we're in the kernel, it'll
184  *              just set a flag.  we could attempt to bundle the kernel state
185  *              and rerun it later, but it's really messy (and possibly given
186  *              back to userspace).  we'll disable ints, check this flag, and if
187  *              so, handle the preemption using the same funcs as the normal
188  *              preemption handler.  nonblocking kernel calls will just slow
189  *              down the preemption while they work.  blocking kernel calls will
190  *              need to package their state properly anyway.
191  *
192  * TODO: in general, think about when we no longer need the stack, in case we
193  * are preempted and expected to run again from somewhere else.  we can't
194  * expect to have the kernel stack around anymore.  the nice thing about being
195  * at this point is that we are just about ready to give up the stack anyways.
196  *
197  * I think we need to make it such that the kernel in "process context" never
198  * gets removed from the core (displaced from its stack) without going through
199  * some "bundling" code.
200  */
201 void proc_startcore(struct proc *p, trapframe_t *tf) {
202         // TODO it's possible to be DYING, but it's a rare race.  remove this soon.
203         assert(p->state & (PROC_RUNNING_S | PROC_RUNNING_M));
204         // sucks to have ints disabled when doing env_decref and possibly freeing
205         disable_irq();
206         if (per_cpu_info[core_id()].preempt_pending) {
207                 // TODO: handle preemption
208                 // the functions will need to consider deal with current like down below
209                 panic("Preemption not supported!");
210         }
211         /* If the process wasn't here, then we need to load its address space. */
212         if (p != current) {
213                 if (proc_incref(p))
214                         // getting here would mean someone tried killing this while we tried
215                         // to start one of it's contexts (from scratch, o/w we had it's CR3
216                         // loaded already)
217                         // if this happens, the death-IPI ought to be on its way...  we can
218                         // either wait, or just cleanup_core() and smp_idle.
219                         panic("Proc is dying, handle me!"); // TODO
220                 lcr3(p->env_cr3);
221                 // we unloaded the old cr3, so decref it (if it exists)
222                 // TODO: Consider moving this to wherever we really "mean to leave the
223                 // process's context".
224                 if (current)
225                         proc_decref(current);
226                 current = p;
227         }
228         /* need to load our silly state, preferably somewhere other than here so we
229          * can avoid the case where the context was just running here.  it's not
230          * sufficient to do it in the "new process" if-block above (could be things
231          * like page faults that cause us to keep the same process, but want a
232          * different context.
233          * for now, we load this silly state here. (TODO) (HSS)
234          * We also need this to be per trapframe, and not per process...
235          */
236         env_pop_ancillary_state(p);
237         env_pop_tf(tf);
238 }
239
240 /*
241  * Destroys the given process.  This may be called from another process, a light
242  * kernel thread (no real process context), asynchronously/cross-core, or from
243  * the process on its own core.
244  *
245  * Here's the way process death works:
246  * 0. grab the lock (protects state transition and core map)
247  * 1. set state to dying.  that keeps the kernel from doing anything for the
248  * process (like proc_running it).
249  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
250  * 3. IPI to clean up those cores (decref, etc).
251  * 4. Unlock
252  * 5. Clean up your core, if applicable
253  * (Last core/kernel thread to decref cleans up and deallocates resources.)
254  *
255  * Note that some cores can be processing async calls, but will eventually
256  * decref.  Should think about this more.
257  */
258 void proc_destroy(struct proc *p)
259 {
260         spin_lock_irqsave(&p->proc_lock);
261         // Could save the state and do this outside the lock
262         switch (p->state) {
263                 case PROC_DYING:
264                         return; // someone else killed this already.
265                 case PROC_RUNNABLE_S:
266                 case PROC_RUNNABLE_M:
267                         deschedule_proc(p);
268                         break;
269                 default:
270                         // Think about other lists, or better ways to do this
271         }
272         proc_set_state(p, PROC_DYING);
273         // BIG TODO: check the coremap to find out who needs to die
274         // send the death IPI to everyone else involved
275         spin_unlock_irqsave(&p->proc_lock);
276
277         proc_decref(p); // this decref is for the process in general
278         atomic_dec(&num_envs);
279
280         /*
281          * If we are currently running this address space on our core, we need a
282          * known good pgdir before releasing the old one.  This is currently the
283          * major practical implication of the kernel caring about a processes
284          * existence (the inc and decref).  This decref corresponds to the incref in
285          * proc_startcore (though it's not the only one).
286          */
287         // TODO - probably make this a function, which the death IPI calls
288         if (current == p) {
289                 lcr3(boot_cr3);
290                 proc_decref(p); // this decref is for the cr3
291                 current = NULL;
292         } else {
293                 return;
294         }
295
296         // for old envs that die on user cores.  since env run never returns, cores
297         // never get back to their old hlt/relaxed/spin state, so we need to force
298         // them back to an idle function.
299
300         if (core_id()) {
301                 smp_idle();
302                 panic("should never see me");
303         }
304         // else we're core 0 and can do the usual
305
306         /* Instead of picking a new environment to run, or defaulting to the monitor
307          * like before, for now we'll hop into the manager() function, which
308          * dispatches jobs.  Note that for now we start the manager from the top,
309          * and not from where we left off the last time we called manager.  That
310          * would require us to save some context (and a stack to work on) here.
311          */
312         manager();
313         assert(0); // never get here
314 }
315
316 /*
317  * The process refcnt is the number of places the process 'exists' in the
318  * system.  Creation counts as 1.  Having your page tables loaded somewhere
319  * (lcr3) counts as another 1.  A non-RUNNING_* process should have refcnt at
320  * least 1.  If the kernel is on another core and in a processes address space
321  * (like processing its backring), that counts as another 1.
322  *
323  * Note that the actual loading and unloading of cr3 is up to the caller, since
324  * that's not the only use for this (and decoupling is more flexible).
325  *
326  * The refcnt should always be greater than 0 for processes that aren't dying.
327  * When refcnt is 0, the process is dying and should not allow any more increfs.
328  * A process can be dying with a refcnt greater than 0, since it could be
329  * waiting for other cores to "get the message" to die, or a kernel core can be
330  * finishing work in the processes's address space.
331  *
332  * Implementation aside, the important thing is that we atomically increment
333  * only if it wasn't already 0.  If it was 0, then we shouldn't be attaching to
334  * the process, so we return an error, which should be handled however is
335  * appropriate.  We currently use spinlocks, but some sort of clever atomics
336  * would work too.
337  *
338  * Also, no one should ever update the refcnt outside of these functions.
339  * Eventually, we'll have Ivy support for this. (TODO)
340  */
341 error_t proc_incref(struct proc *p)
342 {
343         error_t retval = 0;
344         spin_lock_irqsave(&p->proc_lock);
345         if (p->env_refcnt)
346                 p->env_refcnt++;
347         else
348                 retval = -EBADENV;
349         spin_unlock_irqsave(&p->proc_lock);
350         return retval;
351 }
352
353 /*
354  * When the kernel is done with a process, it decrements its reference count.
355  * When the count hits 0, no one is using it and it should be freed.
356  * "Last one out" actually finalizes the death of the process.  This is tightly
357  * coupled with the previous function (incref)
358  * Be sure to load a different cr3 before calling this!
359  */
360 void proc_decref(struct proc *p)
361 {
362         spin_lock_irqsave(&p->proc_lock);
363         p->env_refcnt--;
364         spin_unlock_irqsave(&p->proc_lock);
365         // if we hit 0, no one else will increment and we can check outside the lock
366         if (p->env_refcnt == 0)
367                 env_free(p);
368 }