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