Compiles with GCC
[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, (uint32_t)p,
152                                                      (uint32_t)&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,
158                                                              (uint32_t)p, 0, i);
159                         }
160                         /* There a subtle (attempted) race avoidance here.  proc_startcore
161                          * can handle a death message, but we can't have the startcore come
162                          * after the death message.  Otherwise, it would look like a new
163                          * process.  So we hold the lock to make sure our message went out
164                          * before a possible death message.
165                          * - Likewise, we need interrupts to be disabled, in case one of the
166                          *   messages was for us, and reenable them after letting go of the
167                          *   lock.  This is done by spin_lock_irqsave, so be careful if you
168                          *   change this.
169                          * - This can also be done far more intelligently / efficiently,
170                          *   like skipping in case it's busy and coming back later.
171                          * - Note there is no guarantee this core's interrupts were on, so
172                          *   it may not get the message for a while... */
173                         spin_unlock_irqsave(&p->proc_lock);
174                         break;
175                 default:
176                         spin_unlock_irqsave(&p->proc_lock);
177                         panic("Invalid process state in proc_run()!!");
178         }
179 }
180
181 /*
182  * Runs the given context (trapframe) of process p on the core this code
183  * executes on.  The refcnt tracks how many cores have "an interest" in this
184  * process, which so far just means it uses the process's page table.  See the
185  * massive comments around the incref function
186  *
187  * Given we are RUNNING_*, an IPI for death or preemption could come in:
188  * 1. death attempt (IPI to kill whatever is on your core):
189  *              we don't need to worry about protecting the stack, since we're
190  *              abandoning ship - just need to get a good cr3 and decref current, which
191  *              the death handler will do.
192  *              If a death IPI comes in, we immediately stop this function and will
193  *              never come back.
194  * 2. preempt attempt (IPI to package state and maybe run something else):
195  *              - if a preempt attempt comes in while we're in the kernel, it'll
196  *              just set a flag.  we could attempt to bundle the kernel state
197  *              and rerun it later, but it's really messy (and possibly given
198  *              back to userspace).  we'll disable ints, check this flag, and if
199  *              so, handle the preemption using the same funcs as the normal
200  *              preemption handler.  nonblocking kernel calls will just slow
201  *              down the preemption while they work.  blocking kernel calls will
202  *              need to package their state properly anyway.
203  *
204  * TODO: in general, think about when we no longer need the stack, in case we
205  * are preempted and expected to run again from somewhere else.  we can't
206  * expect to have the kernel stack around anymore.  the nice thing about being
207  * at this point is that we are just about ready to give up the stack anyways.
208  *
209  * I think we need to make it such that the kernel in "process context" never
210  * gets removed from the core (displaced from its stack) without going through
211  * some "bundling" code.
212  */
213 void proc_startcore(struct proc *p, trapframe_t *tf) {
214         // it's possible to be DYING, but it's a rare race.
215         //if (p->state & (PROC_RUNNING_S | PROC_RUNNING_M))
216         //      printk("dying before (re)startcore on core %d\n", core_id());
217
218         // sucks to have ints disabled when doing env_decref and possibly freeing
219         disable_irq();
220         if (per_cpu_info[core_id()].preempt_pending) {
221                 // TODO: handle preemption
222                 // the functions will need to consider deal with current like down below
223                 panic("Preemption not supported!");
224         }
225         /* If the process wasn't here, then we need to load its address space. */
226         if (p != current) {
227                 if (proc_incref(p)) {
228                         // getting here would mean someone tried killing this while we tried
229                         // to start one of it's contexts (from scratch, o/w we had it's CR3
230                         // loaded already)
231                         // if this happens, a no-op death-IPI ought to be on its way...  we can
232                         // just smp_idle()
233                         smp_idle();
234                 }
235                 lcr3(p->env_cr3);
236                 // we unloaded the old cr3, so decref it (if it exists)
237                 // TODO: Consider moving this to wherever we really "mean to leave the
238                 // process's context".
239                 if (current)
240                         proc_decref(current);
241                 current = p;
242         }
243         /* need to load our silly state, preferably somewhere other than here so we
244          * can avoid the case where the context was just running here.  it's not
245          * sufficient to do it in the "new process" if-block above (could be things
246          * like page faults that cause us to keep the same process, but want a
247          * different context.
248          * for now, we load this silly state here. (TODO) (HSS)
249          * We also need this to be per trapframe, and not per process...
250          */
251         env_pop_ancillary_state(p);
252         env_pop_tf(tf);
253 }
254
255 /*
256  * Destroys the given process.  This may be called from another process, a light
257  * kernel thread (no real process context), asynchronously/cross-core, or from
258  * the process on its own core.
259  *
260  * Here's the way process death works:
261  * 0. grab the lock (protects state transition and core map)
262  * 1. set state to dying.  that keeps the kernel from doing anything for the
263  * process (like proc_running it).
264  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
265  * 3. IPI to clean up those cores (decref, etc).
266  * 4. Unlock
267  * 5. Clean up your core, if applicable
268  * (Last core/kernel thread to decref cleans up and deallocates resources.)
269  *
270  * Note that some cores can be processing async calls, but will eventually
271  * decref.  Should think about this more.
272  */
273 void proc_destroy(struct proc *p)
274 {
275         // Note this code relies on this lock disabling interrupts, similar to
276         // proc_run.
277         spin_lock_irqsave(&p->proc_lock);
278         switch (p->state) {
279                 case PROC_DYING:
280                         return; // someone else killed this already.
281                 case PROC_RUNNABLE_S:
282                 case PROC_RUNNABLE_M:
283                         // Think about other lists, like WAITING, or better ways to do this
284                         deschedule_proc(p);
285                         break;
286                 case PROC_RUNNING_S:
287                         #if 0
288                         // here's how to do it manually
289                         if (current == p) {
290                                 lcr3(boot_cr3);
291                                 proc_decref(p); // this decref is for the cr3
292                                 current = NULL;
293                         }
294                         #endif
295                         send_active_msg_sync(p->vcoremap[0], __death, 0, 0, 0);
296                         #if 0
297                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
298                          * managed by the idlecoremap.  so don't do this yet. */
299                         spin_lock(&idle_lock);
300                         idlecoremap[num_idlecores++] = p->vcoremap[0];
301                         spin_unlock(&idle_lock);
302                         #endif
303                         break;
304                 case PROC_RUNNING_M:
305                         /* Send the DEATH message to every core running this process, and
306                          * deallocate the cores.
307                          * The rule is that the vcoremap is set before proc_run, and reset
308                          * within proc_destroy */
309                         spin_lock(&idle_lock);
310                         for (int i = 0; i < p->num_vcores; i++) {
311                                 send_active_msg_sync(p->vcoremap[i], __death, 0, 0, 0);
312                                 // give the pcore back to the idlecoremap
313                                 assert(num_idlecores < num_cpus); // sanity
314                                 idlecoremap[num_idlecores++] = p->vcoremap[i];
315                                 p->vcoremap[i] = 0; // TODO: might need a better signal
316                         }
317                         spin_unlock(&idle_lock);
318                         break;
319                 default:
320                         // TODO: getting here if it's already dead and free (ENV_FREE).
321                         // Need to sort reusing process structures and having pointers to
322                         // them floating around the system.
323                         panic("Weird state(0x%08x) in proc_destroy", p->state);
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 }
411
412 /* Active message handler to start a process's context on this core.  Tightly
413  * coupled with proc_run() */
414 void __startcore(trapframe_t *tf, uint32_t srcid, uint32_t a0, uint32_t a1,
415                  uint32_t a2)
416 {
417         uint32_t coreid = core_id();
418         struct proc *p_to_run = (struct proc *SAFE) TC(a0);
419         trapframe_t local_tf;
420         trapframe_t *tf_to_pop = (trapframe_t *SAFE) TC(a1);
421
422         printk("Startcore on core %d\n", coreid);
423         assert(p_to_run);
424         // TODO: handle silly state (HSS)
425         if (!tf_to_pop) {
426                 tf_to_pop = &local_tf;
427                 memset(tf_to_pop, 0, sizeof(*tf_to_pop));
428                 proc_init_trapframe(tf_to_pop);
429                 // Note the init_tf sets tf_to_pop->tf_esp = USTACKTOP;
430                 proc_set_tfcoreid(tf_to_pop, a2);
431                 proc_set_program_counter(tf_to_pop, p_to_run->env_entry);
432         }
433         proc_startcore(p_to_run, tf_to_pop);
434 }
435
436 /* Active message handler to stop running whatever context is on this core and
437  * to idle.  Note this leaves no trace of what was running.
438  * It's okay if death comes to a core that's already idling and has no current.
439  * It could happen if a process decref'd before proc_startcore could incref. */
440 void __death(trapframe_t *tf, uint32_t srcid, uint32_t a0, uint32_t a1,
441              uint32_t a2)
442 {
443         /* If we are currently running an address space on our core, we need a known
444          * good pgdir before releasing the old one.  This is currently the major
445          * practical implication of the kernel caring about a processes existence
446          * (the inc and decref).  This decref corresponds to the incref in
447          * proc_startcore (though it's not the only one). */
448         if (current) {
449                 lcr3(boot_cr3);
450                 proc_decref(current);
451                 current = NULL;
452         }
453         smp_idle();
454 }
455
456 void print_idlecoremap(void)
457 {
458         spin_lock(&idle_lock);
459         for (int i = 0; i < num_idlecores; i++)
460                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
461         spin_unlock(&idle_lock);
462 }