Killing of parallel processes
[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                         if (!management_core())
123                                 smp_idle(); // this never returns
124                         return;
125                 case (PROC_RUNNABLE_S):
126                         proc_set_state(p, PROC_RUNNING_S);
127                         spin_unlock_irqsave(&p->proc_lock);
128                         // This normally doesn't return, but might error out in the future.
129                         proc_startcore(p, &p->env_tf);
130                         break;
131                 case (PROC_RUNNABLE_M):
132                         proc_set_state(p, PROC_RUNNING_M);
133                         /* Prep each core that we are going to run this process on.
134                          * vcoremap[i] holds the coreid of the physical core allocated to
135                          * this process.  It is set outside proc_run */
136                         for (int i = 0; i < p->num_vcores; i++) {
137                                 per_cpu_info[p->vcoremap[i]].p_to_run = p;
138                         }
139                         // set virtual core 0 to run the main context
140                         // TODO: handle silly state (HSS)
141                         per_cpu_info[p->vcoremap[0]].tf_to_pop = &p->env_tf;
142                         /* needed to make sure the writes beat the IPI.  could have done it
143                          * with other mem accesses, like grabbing a lock, and the write
144                          * would have made it */
145                         wmb_f();
146                         /* There a subtle (attempted) race avoidance here.  proc_startcore
147                          * can handle a death IPI, but we can't have the startcore come
148                          * after the death IPI.  Otherwise, it would look like a new
149                          * process.  So we hold the lock to make sure our IPI went out
150                          * before a possible death IPI.
151                          * Likewise, we need interrupts to be disabled, in case one of the
152                          * IPIs was for us, and reenable them after letting go of the lock.
153                          * This is done by spin_lock_irqsave, so be careful if you change
154                          * this.
155                          * Note there is no guarantee this core's interrupts were on, so it
156                          * may not get the IPI for a while... */
157                         for (int i = 0; i < p->num_vcores; i++)
158                                 send_ipi(p->vcoremap[i], 0, I_STARTCORE);
159                         spin_unlock_irqsave(&p->proc_lock);
160                         break;
161                 default:
162                         spin_unlock_irqsave(&p->proc_lock);
163                         panic("Invalid process state in proc_run()!!");
164         }
165 }
166
167 /*
168  * Runs the given context (trapframe) of process p on the core this code
169  * executes on.  The refcnt tracks how many cores have "an interest" in this
170  * process, which so far just means it uses the process's page table.  See the
171  * massive comments around the incref function
172  *
173  * Given we are RUNNING_*, an IPI for death or preemption could come in:
174  * 1. death attempt (IPI to kill whatever is on your core):
175  *              we don't need to worry about protecting the stack, since we're
176  *              abandoning ship - just need to get a good cr3 and decref current, which
177  *              the death handler will do.
178  *              If a death IPI comes in, we immediately stop this function and will
179  *              never come back.
180  * 2. preempt attempt (IPI to package state and maybe run something else):
181  *              - if a preempt attempt comes in while we're in the kernel, it'll
182  *              just set a flag.  we could attempt to bundle the kernel state
183  *              and rerun it later, but it's really messy (and possibly given
184  *              back to userspace).  we'll disable ints, check this flag, and if
185  *              so, handle the preemption using the same funcs as the normal
186  *              preemption handler.  nonblocking kernel calls will just slow
187  *              down the preemption while they work.  blocking kernel calls will
188  *              need to package their state properly anyway.
189  *
190  * TODO: in general, think about when we no longer need the stack, in case we
191  * are preempted and expected to run again from somewhere else.  we can't
192  * expect to have the kernel stack around anymore.  the nice thing about being
193  * at this point is that we are just about ready to give up the stack anyways.
194  *
195  * I think we need to make it such that the kernel in "process context" never
196  * gets removed from the core (displaced from its stack) without going through
197  * some "bundling" code.
198  */
199 void proc_startcore(struct proc *p, trapframe_t *tf) {
200         // TODO it's possible to be DYING, but it's a rare race.  remove this soon.
201         assert(p->state & (PROC_RUNNING_S | PROC_RUNNING_M));
202         // sucks to have ints disabled when doing env_decref and possibly freeing
203         disable_irq();
204         if (per_cpu_info[core_id()].preempt_pending) {
205                 // TODO: handle preemption
206                 // the functions will need to consider deal with current like down below
207                 panic("Preemption not supported!");
208         }
209         /* If the process wasn't here, then we need to load its address space. */
210         if (p != current) {
211                 if (proc_incref(p))
212                         // getting here would mean someone tried killing this while we tried
213                         // to start one of it's contexts (from scratch, o/w we had it's CR3
214                         // loaded already)
215                         // if this happens, the death-IPI ought to be on its way...  we can
216                         // either wait, or just cleanup_core() and smp_idle.
217                         panic("Proc is dying, handle me!"); // TODO
218                 lcr3(p->env_cr3);
219                 // we unloaded the old cr3, so decref it (if it exists)
220                 // TODO: Consider moving this to wherever we really "mean to leave the
221                 // process's context".
222                 if (current)
223                         proc_decref(current);
224                 current = p;
225         }
226         /* need to load our silly state, preferably somewhere other than here so we
227          * can avoid the case where the context was just running here.  it's not
228          * sufficient to do it in the "new process" if-block above (could be things
229          * like page faults that cause us to keep the same process, but want a
230          * different context.
231          * for now, we load this silly state here. (TODO) (HSS)
232          * We also need this to be per trapframe, and not per process...
233          */
234         env_pop_ancillary_state(p);
235         env_pop_tf(tf);
236 }
237
238 /*
239  * Destroys the given process.  This may be called from another process, a light
240  * kernel thread (no real process context), asynchronously/cross-core, or from
241  * the process on its own core.
242  *
243  * Here's the way process death works:
244  * 0. grab the lock (protects state transition and core map)
245  * 1. set state to dying.  that keeps the kernel from doing anything for the
246  * process (like proc_running it).
247  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
248  * 3. IPI to clean up those cores (decref, etc).
249  * 4. Unlock
250  * 5. Clean up your core, if applicable
251  * (Last core/kernel thread to decref cleans up and deallocates resources.)
252  *
253  * Note that some cores can be processing async calls, but will eventually
254  * decref.  Should think about this more.
255  */
256 void proc_destroy(struct proc *p)
257 {
258         // Note this code relies on this lock disabling interrupts, similar to
259         // proc_run.
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         /* Send the DEATH IPI to every core running this process */
274         for (int i = 0; i < p->num_vcores; i++) {
275                 send_ipi(p->vcoremap[i], 0, I_DEATH);
276         }
277         /* TODO: will need to update the pcoremap that's currently in schedule */
278
279         atomic_dec(&num_envs);
280         /* TODO: (REF) dirty hack.  decref currently uses a lock, but needs to use
281          * CAS instead (another lock would be slightly less ghetto).  but we need to
282          * decref before releasing the lock, since that could enable interrupts,
283          * which would have us receive the DEATH IPI if this was called locally by
284          * the target process. */ 
285         //proc_decref(p); // this decref is for the process in general
286         p->env_refcnt--;
287         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
288         
289         /* After unlocking, we can receive a DEATH IPI and clean up */
290         spin_unlock_irqsave(&p->proc_lock);
291
292         // coupled with the refcnt-- above, from decref.  if this happened,
293         // proc_destroy was called "remotely", and with no one else refcnting
294         if (!refcnt)
295                 env_free(p);
296
297         /* If we were running the process, we should have received an IPI by now.
298          * If not, odds are interrupts are disabled, which shouldn't happen while
299          * servicing syscalls. */
300         assert(current != p);
301         return;
302 }
303
304 /*
305  * The process refcnt is the number of places the process 'exists' in the
306  * system.  Creation counts as 1.  Having your page tables loaded somewhere
307  * (lcr3) counts as another 1.  A non-RUNNING_* process should have refcnt at
308  * least 1.  If the kernel is on another core and in a processes address space
309  * (like processing its backring), that counts as another 1.
310  *
311  * Note that the actual loading and unloading of cr3 is up to the caller, since
312  * that's not the only use for this (and decoupling is more flexible).
313  *
314  * The refcnt should always be greater than 0 for processes that aren't dying.
315  * When refcnt is 0, the process is dying and should not allow any more increfs.
316  * A process can be dying with a refcnt greater than 0, since it could be
317  * waiting for other cores to "get the message" to die, or a kernel core can be
318  * finishing work in the processes's address space.
319  *
320  * Implementation aside, the important thing is that we atomically increment
321  * only if it wasn't already 0.  If it was 0, then we shouldn't be attaching to
322  * the process, so we return an error, which should be handled however is
323  * appropriate.  We currently use spinlocks, but some sort of clever atomics
324  * would work too.
325  *
326  * Also, no one should ever update the refcnt outside of these functions.
327  * Eventually, we'll have Ivy support for this. (TODO)
328  *
329  * TODO: (REF) change to use CAS.
330  */
331 error_t proc_incref(struct proc *p)
332 {
333         error_t retval = 0;
334         spin_lock_irqsave(&p->proc_lock);
335         if (p->env_refcnt)
336                 p->env_refcnt++;
337         else
338                 retval = -EBADENV;
339         spin_unlock_irqsave(&p->proc_lock);
340         return retval;
341 }
342
343 /*
344  * When the kernel is done with a process, it decrements its reference count.
345  * When the count hits 0, no one is using it and it should be freed.
346  * "Last one out" actually finalizes the death of the process.  This is tightly
347  * coupled with the previous function (incref)
348  * Be sure to load a different cr3 before calling this!
349  *
350  * TODO: (REF) change to use CAS.  Note that when we do so, we may be holding
351  * the process lock when calling env_free().
352  */
353 void proc_decref(struct proc *p)
354 {
355         spin_lock_irqsave(&p->proc_lock);
356         p->env_refcnt--;
357         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
358         spin_unlock_irqsave(&p->proc_lock);
359         // if we hit 0, no one else will increment and we can check outside the lock
360         if (!refcnt)
361                 env_free(p);
362 }