Merge branch 'master' of ssh://scm.millennium.berkeley.edu/project/cs/radlab/src...
[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 <trap.h>
17 #include <schedule.h>
18 #include <manager.h>
19 #include <stdio.h>
20 #include <assert.h>
21 #include <timing.h>
22 #include <sys/queue.h>
23
24 /* Process Lists */
25 struct proc_list proc_freelist = TAILQ_HEAD_INITIALIZER(proc_freelist);
26 spinlock_t freelist_lock = SPINLOCK_INITIALIZER;
27 struct proc_list proc_runnablelist = TAILQ_HEAD_INITIALIZER(proc_runnablelist);
28 spinlock_t runnablelist_lock = SPINLOCK_INITIALIZER;
29
30 /* Tracks which cores are idle, similar to the vcoremap.  Each value is the
31  * physical coreid of an unallocated core. */
32 spinlock_t idle_lock = SPINLOCK_INITIALIZER;
33 uint32_t LCKD(&idle_lock) (RO idlecoremap)[MAX_NUM_CPUS];
34 uint32_t LCKD(&idle_lock) num_idlecores = 0;
35
36 /*
37  * While this could be done with just an assignment, this gives us the
38  * opportunity to check for bad transitions.  Might compile these out later, so
39  * we shouldn't rely on them for sanity checking from userspace.
40  */
41 int proc_set_state(struct proc *p, uint32_t state)
42 {
43         uint32_t curstate = p->state;
44         /* Valid transitions:
45          * C   -> RBS
46          * RBS -> RGS
47          * RGS -> RBS
48          * RGS -> W
49          * W   -> RBS
50          * RGS -> RBM
51          * RBM -> RGM
52          * RGM -> RBM
53          * RGM -> RBS
54          * RGS -> D
55          * RGM -> D
56          *
57          * These ought to be implemented later (allowed, not thought through yet).
58          * RBS -> D
59          * RBM -> D
60          *
61          * This isn't allowed yet, may be later.
62          * C   -> D
63          */
64         #if 1 // some sort of correctness flag
65         switch (curstate) {
66                 case PROC_CREATED:
67                         if (state != PROC_RUNNABLE_S)
68                                 panic("Invalid State Transition! PROC_CREATED to %d", state);
69                         break;
70                 case PROC_RUNNABLE_S:
71                         if (!(state & (PROC_RUNNING_S | PROC_DYING)))
72                                 panic("Invalid State Transition! PROC_RUNNABLE_S to %d", state);
73                         break;
74                 case PROC_RUNNING_S:
75                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
76                                        PROC_DYING)))
77                                 panic("Invalid State Transition! PROC_RUNNING_S to %d", state);
78                         break;
79                 case PROC_WAITING:
80                         if (state != PROC_RUNNABLE_S)
81                                 panic("Invalid State Transition! PROC_WAITING to %d", state);
82                         break;
83                 case PROC_DYING:
84                         if (state != PROC_CREATED) // when it is reused (TODO)
85                                 panic("Invalid State Transition! PROC_DYING to %d", state);
86                         break;
87                 case PROC_RUNNABLE_M:
88                         if (!(state & (PROC_RUNNING_M | PROC_DYING)))
89                                 panic("Invalid State Transition! PROC_RUNNABLE_M to %d", state);
90                         break;
91                 case PROC_RUNNING_M:
92                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_DYING)))
93                                 panic("Invalid State Transition! PROC_RUNNING_M to %d", state);
94                         break;
95         }
96         #endif
97         p->state = state;
98         return 0;
99 }
100
101 /* Change this when we aren't using an array */
102 struct proc *get_proc(unsigned pid)
103 {
104         // should have some error checking when we do this for real
105         return &envs[ENVX(pid)];
106 }
107
108 /* Whether or not actor can control target */
109 bool proc_controls(struct proc *actor, struct proc *target)
110 {
111         return target->env_parent_id == actor->env_id;
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.  This should
116  * never be called to "restart" a core.  This expects that the "instructions"
117  * for which core(s) to run this on will be in the vcoremap, which needs to be
118  * set externally.
119  *
120  * When a process goes from RUNNABLE_M to RUNNING_M, its vcoremap will be
121  * "packed" (no holes in the vcore->pcore mapping), vcore0 will continue to run
122  * it's old core0 context, and the other cores will come in at the entry point.
123  * Including in the case of preemption.  */
124 void proc_run(struct proc *p)
125 {
126         spin_lock_irqsave(&p->proc_lock);
127         switch (p->state) {
128                 case (PROC_DYING):
129                         spin_unlock_irqsave(&p->proc_lock);
130                         printk("Process %d not starting due to async death\n", p->env_id);
131                         // There should be no core cleanup to do (like decref).
132                         assert(current != p);
133                         // if we're a worker core, smp_idle, o/w return
134                         if (!management_core())
135                                 smp_idle(); // this never returns
136                         return;
137                 case (PROC_RUNNABLE_S):
138                         proc_set_state(p, PROC_RUNNING_S);
139                         /* We will want to know where this process is running, even if it is
140                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
141                          * Also, this is the signal used in trap.c to know to save the tf in
142                          * env_tf.
143                          * We may need the pcoremap entry to mark it as a RUNNING_S core, or
144                          * else update it here. (TODO) (PCORE) */
145                         p->num_vcores = 0;
146                         p->vcoremap[0] = core_id();
147                         spin_unlock_irqsave(&p->proc_lock);
148                         // This normally doesn't return, but might error out in the future.
149                         proc_startcore(p, &p->env_tf);
150                         break;
151                 case (PROC_RUNNABLE_M):
152                         proc_set_state(p, PROC_RUNNING_M);
153                         /* vcoremap[i] holds the coreid of the physical core allocated to
154                          * this process.  It is set outside proc_run.  For the active
155                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
156                         if (p->num_vcores) {
157                                 // TODO: handle silly state (HSS)
158                                 // set virtual core 0 to run the main context
159                                 // TODO: this should only happen on transition (VC0)
160 #ifdef __IVY__
161                                 send_active_message(p->vcoremap[0], __startcore, p,
162                                                     &p->env_tf, (void *SNT)0);
163 #else
164                                 send_active_message(p->vcoremap[0], (void *)__startcore,
165                                                     (void *)p, (void *)&p->env_tf, 0);
166 #endif
167                                 /* handle the others. */
168                                 for (int i = 1; i < p->num_vcores; i++)
169 #ifdef __IVY__
170                                         send_active_message(p->vcoremap[i], __startcore,
171                                                             p, (trapframe_t *CT(1))NULL, (void *SNT)i);
172 #else
173                                         send_active_message(p->vcoremap[i], (void *)__startcore,
174                                                             (void *)p, (void *)0, (void *)i);
175 #endif
176                         }
177                         /* There a subtle (attempted) race avoidance here.  proc_startcore
178                          * can handle a death message, but we can't have the startcore come
179                          * after the death message.  Otherwise, it would look like a new
180                          * process.  So we hold the lock to make sure our message went out
181                          * before a possible death message.
182                          * - Likewise, we need interrupts to be disabled, in case one of the
183                          *   messages was for us, and reenable them after letting go of the
184                          *   lock.  This is done by spin_lock_irqsave, so be careful if you
185                          *   change this.
186                          * - This can also be done far more intelligently / efficiently,
187                          *   like skipping in case it's busy and coming back later.
188                          * - Note there is no guarantee this core's interrupts were on, so
189                          *   it may not get the message for a while... */
190                         spin_unlock_irqsave(&p->proc_lock);
191                         break;
192                 default:
193                         spin_unlock_irqsave(&p->proc_lock);
194                         panic("Invalid process state %p in proc_run()!!", p->state);
195         }
196 }
197
198 /*
199  * Runs the given context (trapframe) of process p on the core this code
200  * executes on.  The refcnt tracks how many cores have "an interest" in this
201  * process, which so far just means it uses the process's page table.  See the
202  * massive comments around the incref function
203  *
204  * Given we are RUNNING_*, an IPI for death or preemption could come in:
205  * 1. death attempt (IPI to kill whatever is on your core):
206  *              we don't need to worry about protecting the stack, since we're
207  *              abandoning ship - just need to get a good cr3 and decref current, which
208  *              the death handler will do.
209  *              If a death IPI comes in, we immediately stop this function and will
210  *              never come back.
211  * 2. preempt attempt (IPI to package state and maybe run something else):
212  *              - if a preempt attempt comes in while we're in the kernel, it'll
213  *              just set a flag.  we could attempt to bundle the kernel state
214  *              and rerun it later, but it's really messy (and possibly given
215  *              back to userspace).  we'll disable ints, check this flag, and if
216  *              so, handle the preemption using the same funcs as the normal
217  *              preemption handler.  nonblocking kernel calls will just slow
218  *              down the preemption while they work.  blocking kernel calls will
219  *              need to package their state properly anyway.
220  *
221  * TODO: in general, think about when we no longer need the stack, in case we
222  * are preempted and expected to run again from somewhere else.  we can't
223  * expect to have the kernel stack around anymore.  the nice thing about being
224  * at this point is that we are just about ready to give up the stack anyways.
225  *
226  * I think we need to make it such that the kernel in "process context" never
227  * gets removed from the core (displaced from its stack) without going through
228  * some "bundling" code.
229  */
230 void proc_startcore(struct proc *p, trapframe_t *tf) {
231         // it's possible to be DYING, but it's a rare race.
232         //if (p->state & (PROC_RUNNING_S | PROC_RUNNING_M))
233         //      printk("dying before (re)startcore on core %d\n", core_id());
234
235         // sucks to have ints disabled when doing env_decref and possibly freeing
236         disable_irq();
237         if (per_cpu_info[core_id()].preempt_pending) {
238                 // TODO: handle preemption
239                 // the functions will need to consider deal with current like down below
240                 panic("Preemption not supported!");
241         }
242         /* If the process wasn't here, then we need to load its address space. */
243         if (p != current) {
244                 if (proc_incref(p)) {
245                         // getting here would mean someone tried killing this while we tried
246                         // to start one of it's contexts (from scratch, o/w we had it's CR3
247                         // loaded already)
248                         // if this happens, a no-op death-IPI ought to be on its way...  we can
249                         // just smp_idle()
250                         smp_idle();
251                 }
252                 lcr3(p->env_cr3);
253                 // we unloaded the old cr3, so decref it (if it exists)
254                 // TODO: Consider moving this to wherever we really "mean to leave the
255                 // process's context".  abandon_core() does this.
256                 if (current)
257                         proc_decref(current);
258                 set_cpu_curenv(p);
259         }
260         /* need to load our silly state, preferably somewhere other than here so we
261          * can avoid the case where the context was just running here.  it's not
262          * sufficient to do it in the "new process" if-block above (could be things
263          * like page faults that cause us to keep the same process, but want a
264          * different context.
265          * for now, we load this silly state here. (TODO) (HSS)
266          * We also need this to be per trapframe, and not per process...
267          */
268         env_pop_ancillary_state(p);
269         env_pop_tf(tf);
270 }
271
272 /* Helper function, helps with receiving local death IPIs, for the cases when
273  * this core is running the process.  We should received an IPI shortly.  If
274  * not, odds are interrupts are disabled, which shouldn't happen while servicing
275  * syscalls. */
276 static void check_for_local_death(struct proc *p)
277 {
278         if (current == p) {
279                 /* a death IPI should be on its way, either from the RUNNING_S one, or
280                  * from proc_take_cores with a __death.  in general, interrupts should
281                  * be on when you call proc_destroy locally, but currently aren't for
282                  * all things (like traphandlers).  since we're dying anyway, it seems
283                  * reasonable to turn on interrupts.  note this means all non-proc
284                  * management interrupt handlers must return (which they need to do
285                  * anyway), so that we get back to this point.  Eventually, we can
286                  * remove the enable_irq.  think about this (TODO) */
287                 enable_irq();
288                 udelay(1000000);
289                 panic("Waiting too long on core %d for an IPI in proc_destroy()!",
290                       core_id());
291         }
292 }
293
294 /*
295  * Destroys the given process.  This may be called from another process, a light
296  * kernel thread (no real process context), asynchronously/cross-core, or from
297  * the process on its own core.
298  *
299  * Here's the way process death works:
300  * 0. grab the lock (protects state transition and core map)
301  * 1. set state to dying.  that keeps the kernel from doing anything for the
302  * process (like proc_running it).
303  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
304  * 3. IPI to clean up those cores (decref, etc).
305  * 4. Unlock
306  * 5. Clean up your core, if applicable
307  * (Last core/kernel thread to decref cleans up and deallocates resources.)
308  *
309  * Note that some cores can be processing async calls, but will eventually
310  * decref.  Should think about this more.
311  */
312 void proc_destroy(struct proc *p)
313 {
314         // Note this code relies on this lock disabling interrupts, similar to
315         // proc_run.
316         uint32_t corelist[MAX_NUM_CPUS];
317         size_t num_cores_freed;
318         spin_lock_irqsave(&p->proc_lock);
319         switch (p->state) {
320                 case PROC_DYING: // someone else killed this already.
321                         spin_unlock_irqsave(&p->proc_lock);
322                         check_for_local_death(p); // IPI may be on it's way.
323                         return;
324                 case PROC_RUNNABLE_M:
325                         /* Need to reclaim any cores this proc might have, even though it's
326                          * not running yet. */
327                         proc_take_allcores(p, NULL, NULL, NULL, NULL);
328                         // fallthrough
329                 case PROC_RUNNABLE_S:
330                         // Think about other lists, like WAITING, or better ways to do this
331                         deschedule_proc(p);
332                         break;
333                 case PROC_RUNNING_S:
334                         #if 0
335                         // here's how to do it manually
336                         if (current == p) {
337                                 lcr3(boot_cr3);
338                                 proc_decref(p); // this decref is for the cr3
339                                 current = NULL;
340                         }
341                         #endif
342                         send_active_message(p->vcoremap[0], __death, (void *SNT)0,
343                                             (void *SNT)0, (void *SNT)0);
344                         #if 0
345                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
346                          * managed by the idlecoremap.  so don't do this yet. */
347                         spin_lock(&idle_lock);
348                         idlecoremap[num_idlecores++] = p->vcoremap[0];
349                         spin_unlock(&idle_lock);
350                         #endif
351                         break;
352                 case PROC_RUNNING_M:
353                         /* Send the DEATH message to every core running this process, and
354                          * deallocate the cores.
355                          * The rule is that the vcoremap is set before proc_run, and reset
356                          * within proc_destroy */
357                         proc_take_allcores(p, __death, (void *SNT)0, (void *SNT)0,
358                                            (void *SNT)0);
359                         break;
360                 default:
361                         // TODO: getting here if it's already dead and free (ENV_FREE).
362                         // Need to sort reusing process structures and having pointers to
363                         // them floating around the system.
364                         panic("Weird state(0x%08x) in proc_destroy", p->state);
365         }
366         proc_set_state(p, PROC_DYING);
367
368         atomic_dec(&num_envs);
369         /* TODO: (REF) dirty hack.  decref currently uses a lock, but needs to use
370          * CAS instead (another lock would be slightly less ghetto).  but we need to
371          * decref before releasing the lock, since that could enable interrupts,
372          * which would have us receive the DEATH IPI if this was called locally by
373          * the target process. */
374         //proc_decref(p); // this decref is for the process in general
375         p->env_refcnt--;
376         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
377
378         /* After unlocking, we can receive a DEATH IPI and clean up */
379         spin_unlock_irqsave(&p->proc_lock);
380
381         // coupled with the refcnt-- above, from decref.  if this happened,
382         // proc_destroy was called "remotely", and with no one else refcnting
383         if (!refcnt)
384                 env_free(p);
385
386         /* if our core is part of process p, then check/wait for the death IPI. */
387         check_for_local_death(p);
388         return;
389 }
390
391 /* Helper function.  Starting from prev, it will find the next free vcoreid,
392  * which is the next slot with a -1 in it.
393  * You better hold the lock before calling this. */
394 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev)
395 {
396         uint32_t i;
397         for (i = prev; i < MAX_NUM_CPUS; i++)
398                 if (p->vcoremap[i] == -1)
399                         break;
400         if (i + 1 >= MAX_NUM_CPUS)
401                 warn("At the end of the vcorelist.  Might want to check that out.");
402         return i;
403 }
404
405 /* Helper function.  Starting from prev, it will find the next busy vcoreid,
406  * which is the next slot with something other than a -1 in it.
407  * You better hold the lock before calling this. */
408 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev)
409 {
410         uint32_t i;
411         for (i = prev; i < MAX_NUM_CPUS; i++)
412                 if (p->vcoremap[i] != -1)
413                         break;
414         if (i + 1 >= MAX_NUM_CPUS)
415                 warn("At the end of the vcorelist.  Might want to check that out.");
416         return i;
417 }
418
419 /* Helper function.  Find the vcoreid for a given physical core id.
420  * You better hold the lock before calling this.  If we use some sort of
421  * pcoremap, we can avoid this linear search. */
422 static uint32_t get_vcoreid(struct proc *SAFE p, int32_t pcoreid)
423 {
424         uint32_t i;
425         for (i = 0; i < MAX_NUM_CPUS; i++)
426                 if (p->vcoremap[i] == pcoreid)
427                         break;
428         if (i + 1 >= MAX_NUM_CPUS)
429                 warn("At the end of the vcorelist.  Might want to check that out.");
430         return i;
431 }
432
433 /* Yields the calling core.  Must be called locally (not async) for now.
434  * - If RUNNING_S, you just give up your time slice and will eventually return.
435  * - If RUNNING_M, you give up the current vcore (which never returns), and
436  *   adjust the amount of cores wanted/granted.
437  * - If you have only one vcore, you switch to RUNNABLE_S.
438  * - If you yield from vcore0 but are still RUNNING_M, your context will be
439  *   saved, but may not be restarted, depending on how you get that core back.
440  *   (currently)  see proc_give_cores for details.
441  * - RES_CORES amt_wanted will be the amount running after taking away the
442  *   yielder.
443  */
444 void proc_yield(struct proc *SAFE p)
445 {
446         spin_lock_irqsave(&p->proc_lock);
447         switch (p->state) {
448                 case (PROC_RUNNING_S):
449                         proc_set_state(p, PROC_RUNNABLE_S);
450                         schedule_proc(p);
451                         break;
452                 case (PROC_RUNNING_M):
453                         p->resources[RES_CORES].amt_granted = --(p->num_vcores);
454                         p->resources[RES_CORES].amt_wanted = p->num_vcores;
455                         // give up core
456                         p->vcoremap[get_vcoreid(p, core_id())] = -1;
457                         // add to idle list
458                         spin_lock(&idle_lock);
459                         idlecoremap[num_idlecores++] = core_id();
460                         spin_unlock(&idle_lock);
461                         // out of vcores?  if so, we're now a regular process
462                         if (p->num_vcores == 0) {
463                                 // switch to runnable_s
464                                 proc_set_state(p, PROC_RUNNABLE_S);
465                                 schedule_proc(p);
466                         }
467                         break;
468                 default:
469                         // there are races that can lead to this (async death, preempt, etc)
470                         panic("Weird state(0x%08x) in sys_yield", p->state);
471         }
472         spin_unlock_irqsave(&p->proc_lock);
473         // clean up the core and idle.  for mgmt cores, they will ultimately call
474         // manager, which will call schedule(), which will repick the yielding proc.
475         abandon_core();
476 }
477
478 /* Gives process p the additional num cores listed in corelist.  You must be
479  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
480  * startup your new cores at the entry point with their virtual IDs.  If you're
481  * RUNNABLE_M, you should call proc_run after this so that the process can start
482  * to use its cores.
483  *
484  * If you're *_S, make sure your core0's TF is set (which is done when coming in
485  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
486  * Then call proc_run().
487  *
488  * The reason I didn't bring the _S cases from core_request over here is so we
489  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
490  * this is called from another core, and to avoid the need_to_idle business.
491  * The other way would be to have this function have the side effect of changing
492  * state, and finding another way to do the need_to_idle.
493  *
494  * In the event of an error, corelist will include all the cores that were *NOT*
495  * given to the process (cores that are still free).  Practically, this will be
496  * all of them, since it seems like an all or nothing deal right now.
497  *
498  * WARNING: You must hold the proc_lock before calling this!*/
499
500 // zra: If corelist has *num elements, then it would be best if the value is
501 // passed instead of a pointer to it. If in the future some way will be needed
502 // to return the number of cores, then it might be best to use a separate
503 // parameter for that.
504 error_t proc_give_cores(struct proc *SAFE p, uint32_t corelist[], size_t *num)
505 { TRUSTEDBLOCK
506         uint32_t free_vcoreid = 0;
507         switch (p->state) {
508                 case (PROC_RUNNABLE_S):
509                 case (PROC_RUNNING_S):
510                         panic("Don't give cores to a process in a *_S state!\n");
511                         return -EINVAL;
512                         break;
513                 case (PROC_DYING):
514                         // just FYI, for debugging
515                         printk("[kernel] attempted to give cores to a DYING process.\n");
516                         return -EFAIL;
517                         break;
518                 case (PROC_RUNNABLE_M):
519                         // set up vcoremap.  list should be empty, but could be called
520                         // multiple times before proc_running (someone changed their mind?)
521                         if (p->num_vcores) {
522                                 printk("[kernel] Yaaaaaarrrrr!  Giving extra cores, are we?\n");
523                                 // debugging: if we aren't packed, then there's a problem
524                                 // somewhere, like someone forgot to take vcores after
525                                 // preempting.
526                                 for (int i = 0; i < p->num_vcores; i++)
527                                         assert(p->vcoremap[i]);
528                         }
529                         // add new items to the vcoremap
530                         for (int i = 0; i < *num; i++) {
531                                 // find the next free slot, which should be the next one
532                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
533                                 printd("setting vcore %d to pcore %d\n", free_vcoreid, corelist[i]);
534                                 p->vcoremap[free_vcoreid] = corelist[i];
535                                 p->num_vcores++;
536                         }
537                         break;
538                 case (PROC_RUNNING_M):
539                         for (int i = 0; i < *num; i++) {
540                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
541                                 printd("setting vcore %d to pcore %d\n", free_vcoreid, corelist[i]);
542                                 p->vcoremap[free_vcoreid] = corelist[i];
543                                 p->num_vcores++;
544                                 assert(corelist[i] != core_id()); // sanity
545                                 /* if we want to allow yielding of vcore0 and restarting it at
546                                  * its yield point *while still RUNNING_M*, uncomment this */
547                                 // TODO: we don't (VC0)
548                                 /*
549                                 if (i == 0)
550                                         send_active_message(p->vcoremap[0], __startcore,
551                                                             (uint32_t)p, (uint32_t)&p->env_tf, 0);
552                                 else */
553                                 send_active_msg_sync(corelist[i], __startcore, p,
554                                                      (struct Trapframe *)0,
555                                                      (void*SNT)free_vcoreid);
556                                 //send_active_message(corelist[i], __startcore, p,
557                                 //                    (void*)0, (void*)free_vcoreid);
558                         }
559                         break;
560                 default:
561                         panic("Weird proc state %d in proc_give_cores()!\n", p->state);
562         }
563         return ESUCCESS;
564 }
565
566 /* Makes process p's coremap look like corelist (add, remove, etc).  Caller
567  * needs to know what cores are free after this call (removed, failed, etc).
568  * This info will be returned via corelist and *num.  This will send message to
569  * any cores that are getting removed.
570  *
571  * Before implementing this, we should probably think about when this will be
572  * used.  Implies preempting for the message.
573  *
574  * WARNING: You must hold the proc_lock before calling this!*/
575 error_t proc_set_allcores(struct proc *SAFE p, uint32_t corelist[], size_t *num,
576                           amr_t message,TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
577 {
578         panic("Set all cores not implemented.\n");
579 }
580
581 /* Takes from process p the num cores listed in corelist.  In the event of an
582  * error, corelist will contain the list of cores that are free, and num will
583  * contain how many items are in corelist.  This isn't implemented yet, but
584  * might be necessary later.  Or not, and we'll never do it.
585  *
586  * TODO: think about taking vcore0.  probably are issues... (or not (VC0))
587  *
588  * WARNING: You must hold the proc_lock before calling this!*/
589 error_t proc_take_cores(struct proc *SAFE p, uint32_t corelist[], size_t *num,
590                         amr_t message, TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
591 { TRUSTEDBLOCK
592         uint32_t vcoreid;
593         switch (p->state) {
594                 case (PROC_RUNNABLE_M):
595                         assert(!message);
596                         break;
597                 case (PROC_RUNNING_M):
598                         assert(message);
599                         break;
600                 default:
601                         panic("Weird state %d in proc_take_cores()!\n", p->state);
602         }
603         spin_lock(&idle_lock);
604         assert((*num <= p->num_vcores) && (num_idlecores + *num <= num_cpus));
605         for (int i = 0; i < *num; i++) {
606                 vcoreid = get_vcoreid(p, corelist[i]);
607                 assert(p->vcoremap[vcoreid] == corelist[i]);
608                 if (message)
609                         send_active_msg_sync(corelist[i], message, arg0, arg1, arg2);
610                 // give the pcore back to the idlecoremap
611                 idlecoremap[num_idlecores++] = corelist[i];
612                 p->vcoremap[vcoreid] = -1;
613         }
614         spin_unlock(&idle_lock);
615         p->num_vcores -= *num;
616         return 0;
617 }
618
619 /* Takes all cores from a process, which must be in an _M state.  Cores are
620  * placed back in the idlecoremap.  If there's a message, such as __death or
621  * __preempt, it will be sent to the cores.
622  *
623  * WARNING: You must hold the proc_lock before calling this! */
624 error_t proc_take_allcores(struct proc *SAFE p, amr_t message,
625                            TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
626 {
627         uint32_t active_vcoreid = 0;
628         switch (p->state) {
629                 case (PROC_RUNNABLE_M):
630                         assert(!message);
631                         break;
632                 case (PROC_RUNNING_M):
633                         assert(message);
634                         break;
635                 default:
636                         panic("Weird state %d in proc_take_allcores()!\n", p->state);
637         }
638         spin_lock(&idle_lock);
639         assert(num_idlecores + p->num_vcores <= num_cpus); // sanity
640         for (int i = 0; i < p->num_vcores; i++) {
641                 // find next active vcore
642                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
643                 if (message)
644                         send_active_msg_sync(p->vcoremap[active_vcoreid], message,
645                                              arg0, arg1, arg2);
646                 // give the pcore back to the idlecoremap
647                 idlecoremap[num_idlecores++] = p->vcoremap[active_vcoreid];
648                 p->vcoremap[active_vcoreid] = -1;
649         }
650         spin_unlock(&idle_lock);
651         p->num_vcores = 0;
652         return 0;
653 }
654
655 /*
656  * The process refcnt is the number of places the process 'exists' in the
657  * system.  Creation counts as 1.  Having your page tables loaded somewhere
658  * (lcr3) counts as another 1.  A non-RUNNING_* process should have refcnt at
659  * least 1.  If the kernel is on another core and in a processes address space
660  * (like processing its backring), that counts as another 1.
661  *
662  * Note that the actual loading and unloading of cr3 is up to the caller, since
663  * that's not the only use for this (and decoupling is more flexible).
664  *
665  * The refcnt should always be greater than 0 for processes that aren't dying.
666  * When refcnt is 0, the process is dying and should not allow any more increfs.
667  * A process can be dying with a refcnt greater than 0, since it could be
668  * waiting for other cores to "get the message" to die, or a kernel core can be
669  * finishing work in the processes's address space.
670  *
671  * Implementation aside, the important thing is that we atomically increment
672  * only if it wasn't already 0.  If it was 0, then we shouldn't be attaching to
673  * the process, so we return an error, which should be handled however is
674  * appropriate.  We currently use spinlocks, but some sort of clever atomics
675  * would work too.
676  *
677  * Also, no one should ever update the refcnt outside of these functions.
678  * Eventually, we'll have Ivy support for this. (TODO)
679  *
680  * TODO: (REF) change to use CAS.
681  */
682 error_t proc_incref(struct proc *p)
683 {
684         error_t retval = 0;
685         spin_lock_irqsave(&p->proc_lock);
686         if (p->env_refcnt)
687                 p->env_refcnt++;
688         else
689                 retval = -EBADENV;
690         spin_unlock_irqsave(&p->proc_lock);
691         return retval;
692 }
693
694 /*
695  * When the kernel is done with a process, it decrements its reference count.
696  * When the count hits 0, no one is using it and it should be freed.
697  * "Last one out" actually finalizes the death of the process.  This is tightly
698  * coupled with the previous function (incref)
699  * Be sure to load a different cr3 before calling this!
700  *
701  * TODO: (REF) change to use CAS.  Note that when we do so, we may be holding
702  * the process lock when calling env_free().
703  */
704 void proc_decref(struct proc *p)
705 {
706         spin_lock_irqsave(&p->proc_lock);
707         p->env_refcnt--;
708         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
709         spin_unlock_irqsave(&p->proc_lock);
710         // if we hit 0, no one else will increment and we can check outside the lock
711         if (!refcnt)
712                 env_free(p);
713 }
714
715 /* Active message handler to start a process's context on this core.  Tightly
716  * coupled with proc_run() */
717 #ifdef __IVY__
718 void __startcore(trapframe_t *tf, uint32_t srcid, struct proc *CT(1) a0,
719                  trapframe_t *CT(1) a1, void *SNT a2)
720 #else
721 void __startcore(trapframe_t *tf, uint32_t srcid, void * a0, void * a1,
722                  void * a2)
723 #endif
724 {
725         uint32_t coreid = core_id();
726         struct proc *p_to_run = (struct proc *CT(1))a0;
727         trapframe_t local_tf;
728         trapframe_t *tf_to_pop = (trapframe_t *CT(1))a1;
729
730         printk("[kernel] Startcore on physical core %d\n", coreid);
731         assert(p_to_run);
732         // TODO: handle silly state (HSS)
733         if (!tf_to_pop) {
734                 tf_to_pop = &local_tf;
735                 memset(tf_to_pop, 0, sizeof(*tf_to_pop));
736                 proc_init_trapframe(tf_to_pop);
737                 // Note the init_tf sets tf_to_pop->tf_esp = USTACKTOP;
738                 proc_set_tfcoreid(tf_to_pop, (uint32_t)a2);
739                 proc_set_program_counter(tf_to_pop, p_to_run->env_entry);
740         }
741         proc_startcore(p_to_run, tf_to_pop);
742 }
743
744 /* Stop running whatever context is on this core and to 'idle'.  Note this
745  * leaves no trace of what was running. This "leaves the process's context. */
746 void abandon_core(void)
747 {
748         /* If we are currently running an address space on our core, we need a known
749          * good pgdir before releasing the old one.  This is currently the major
750          * practical implication of the kernel caring about a processes existence
751          * (the inc and decref).  This decref corresponds to the incref in
752          * proc_startcore (though it's not the only one). */
753         if (current) {
754                 lcr3(boot_cr3);
755                 proc_decref(current);
756                 set_cpu_curenv(NULL);
757         }
758         smp_idle();
759 }
760 /* Active message handler to clean up the core when a process is dying.
761  * Note this leaves no trace of what was running.
762  * It's okay if death comes to a core that's already idling and has no current.
763  * It could happen if a process decref'd before proc_startcore could incref. */
764 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
765              void *SNT a2)
766 {
767         abandon_core();
768 }
769
770 void print_idlecoremap(void)
771 {
772         spin_lock(&idle_lock);
773         printk("There are %d idle cores.\n", num_idlecores);
774         for (int i = 0; i < num_idlecores; i++)
775                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
776         spin_unlock(&idle_lock);
777 }
778
779 void print_proc_info(pid_t pid)
780 {
781         int j = 0;
782         struct proc *p = 0;
783         envid2env(pid, &p, 0);
784         // not concerned with a race on the state...
785         if ((!p) || (p->state == ENV_FREE)) {
786                 printk("Bad PID.\n");
787                 return;
788         }
789         spinlock_debug(&p->proc_lock);
790         spin_lock_irqsave(&p->proc_lock);
791         printk("struct proc: %p\n", p);
792         printk("PID: %d\n", p->env_id);
793         printk("PPID: %d\n", p->env_parent_id);
794         printk("State: 0x%08x\n", p->state);
795         printk("Runs: %d\n", p->env_runs);
796         printk("Refcnt: %d\n", p->env_refcnt);
797         printk("Flags: 0x%08x\n", p->env_flags);
798         printk("CR3(phys): 0x%08x\n", p->env_cr3);
799         printk("Num Vcores: %d\n", p->num_vcores);
800         printk("Vcoremap:\n");
801         for (int i = 0; i < p->num_vcores; i++) {
802                 j = get_busy_vcoreid(p, j);
803                 printk("\tVcore %d: Pcore %d\n", j, p->vcoremap[j]);
804                 j++;
805         }
806         printk("Resources:\n");
807         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
808                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
809                        p->resources[i].amt_wanted, p->resources[i].amt_granted);
810         printk("Vcore 0's Last Trapframe:\n");
811         print_trapframe(&p->env_tf);
812         spin_unlock_irqsave(&p->proc_lock);
813 }