Resource request calls and core request handling
[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 = 0;
27 struct proc_list proc_runnablelist = TAILQ_HEAD_INITIALIZER(proc_runnablelist);
28 spinlock_t runnablelist_lock = 0;
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 = 0;
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                         // we may need the pcoremap entry to mark it as a RUNNING_S core, or
142                         // else update it here. (TODO) (PCORE)
143                         p->num_vcores = 0;
144                         p->vcoremap[0] = core_id();
145                         spin_unlock_irqsave(&p->proc_lock);
146                         // This normally doesn't return, but might error out in the future.
147                         proc_startcore(p, &p->env_tf);
148                         break;
149                 case (PROC_RUNNABLE_M):
150                         proc_set_state(p, PROC_RUNNING_M);
151                         /* vcoremap[i] holds the coreid of the physical core allocated to
152                          * this process.  It is set outside proc_run.  For the active
153                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
154                         if (p->num_vcores) {
155                                 // TODO: handle silly state (HSS)
156                                 // set virtual core 0 to run the main context
157 #ifdef __IVY__
158                                 send_active_msg_sync(p->vcoremap[0], __startcore, p,
159                                                      &p->env_tf, (void *SNT)0);
160 #else
161                                 send_active_msg_sync(p->vcoremap[0], (void *)__startcore,
162                                                      (void *)p, (void *)&p->env_tf, 0);
163 #endif
164                                 /* handle the others.  note the sync message will spin until
165                                  * there is a free active message slot, which could lock up the
166                                  * system.  think about this. (TODO)(AMDL) */
167                                 for (int i = 1; i < p->num_vcores; i++)
168 #ifdef __IVY__
169                                         send_active_msg_sync(p->vcoremap[i], __startcore,
170                                                              p, (trapframe_t *CT(1))NULL, (void *SNT)i);
171 #else
172                                         send_active_msg_sync(p->vcoremap[i], (void *)__startcore,
173                                                              (void *)p, (void *)0, (void *)i);
174 #endif
175                         }
176                         /* There a subtle (attempted) race avoidance here.  proc_startcore
177                          * can handle a death message, but we can't have the startcore come
178                          * after the death message.  Otherwise, it would look like a new
179                          * process.  So we hold the lock to make sure our message went out
180                          * before a possible death message.
181                          * - Likewise, we need interrupts to be disabled, in case one of the
182                          *   messages was for us, and reenable them after letting go of the
183                          *   lock.  This is done by spin_lock_irqsave, so be careful if you
184                          *   change this.
185                          * - This can also be done far more intelligently / efficiently,
186                          *   like skipping in case it's busy and coming back later.
187                          * - Note there is no guarantee this core's interrupts were on, so
188                          *   it may not get the message for a while... */
189                         spin_unlock_irqsave(&p->proc_lock);
190                         break;
191                 default:
192                         spin_unlock_irqsave(&p->proc_lock);
193                         panic("Invalid process state in proc_run()!!");
194         }
195 }
196
197 /*
198  * Runs the given context (trapframe) of process p on the core this code
199  * executes on.  The refcnt tracks how many cores have "an interest" in this
200  * process, which so far just means it uses the process's page table.  See the
201  * massive comments around the incref function
202  *
203  * Given we are RUNNING_*, an IPI for death or preemption could come in:
204  * 1. death attempt (IPI to kill whatever is on your core):
205  *              we don't need to worry about protecting the stack, since we're
206  *              abandoning ship - just need to get a good cr3 and decref current, which
207  *              the death handler will do.
208  *              If a death IPI comes in, we immediately stop this function and will
209  *              never come back.
210  * 2. preempt attempt (IPI to package state and maybe run something else):
211  *              - if a preempt attempt comes in while we're in the kernel, it'll
212  *              just set a flag.  we could attempt to bundle the kernel state
213  *              and rerun it later, but it's really messy (and possibly given
214  *              back to userspace).  we'll disable ints, check this flag, and if
215  *              so, handle the preemption using the same funcs as the normal
216  *              preemption handler.  nonblocking kernel calls will just slow
217  *              down the preemption while they work.  blocking kernel calls will
218  *              need to package their state properly anyway.
219  *
220  * TODO: in general, think about when we no longer need the stack, in case we
221  * are preempted and expected to run again from somewhere else.  we can't
222  * expect to have the kernel stack around anymore.  the nice thing about being
223  * at this point is that we are just about ready to give up the stack anyways.
224  *
225  * I think we need to make it such that the kernel in "process context" never
226  * gets removed from the core (displaced from its stack) without going through
227  * some "bundling" code.
228  */
229 void proc_startcore(struct proc *p, trapframe_t *tf) {
230         // it's possible to be DYING, but it's a rare race.
231         //if (p->state & (PROC_RUNNING_S | PROC_RUNNING_M))
232         //      printk("dying before (re)startcore on core %d\n", core_id());
233
234         // sucks to have ints disabled when doing env_decref and possibly freeing
235         disable_irq();
236         if (per_cpu_info[core_id()].preempt_pending) {
237                 // TODO: handle preemption
238                 // the functions will need to consider deal with current like down below
239                 panic("Preemption not supported!");
240         }
241         /* If the process wasn't here, then we need to load its address space. */
242         if (p != current) {
243                 if (proc_incref(p)) {
244                         // getting here would mean someone tried killing this while we tried
245                         // to start one of it's contexts (from scratch, o/w we had it's CR3
246                         // loaded already)
247                         // if this happens, a no-op death-IPI ought to be on its way...  we can
248                         // just smp_idle()
249                         smp_idle();
250                 }
251                 lcr3(p->env_cr3);
252                 // we unloaded the old cr3, so decref it (if it exists)
253                 // TODO: Consider moving this to wherever we really "mean to leave the
254                 // process's context".
255                 if (current)
256                         proc_decref(current);
257                 set_cpu_curenv(p);
258         }
259         /* need to load our silly state, preferably somewhere other than here so we
260          * can avoid the case where the context was just running here.  it's not
261          * sufficient to do it in the "new process" if-block above (could be things
262          * like page faults that cause us to keep the same process, but want a
263          * different context.
264          * for now, we load this silly state here. (TODO) (HSS)
265          * We also need this to be per trapframe, and not per process...
266          */
267         env_pop_ancillary_state(p);
268         env_pop_tf(tf);
269 }
270
271 /*
272  * Destroys the given process.  This may be called from another process, a light
273  * kernel thread (no real process context), asynchronously/cross-core, or from
274  * the process on its own core.
275  *
276  * Here's the way process death works:
277  * 0. grab the lock (protects state transition and core map)
278  * 1. set state to dying.  that keeps the kernel from doing anything for the
279  * process (like proc_running it).
280  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
281  * 3. IPI to clean up those cores (decref, etc).
282  * 4. Unlock
283  * 5. Clean up your core, if applicable
284  * (Last core/kernel thread to decref cleans up and deallocates resources.)
285  *
286  * Note that some cores can be processing async calls, but will eventually
287  * decref.  Should think about this more.
288  */
289 void proc_destroy(struct proc *p)
290 {
291         // Note this code relies on this lock disabling interrupts, similar to
292         // proc_run.
293         uint32_t corelist[MAX_NUM_CPUS];
294         size_t num_cores_freed;
295         spin_lock_irqsave(&p->proc_lock);
296         switch (p->state) {
297                 case PROC_DYING:
298                         return; // someone else killed this already.
299                 case PROC_RUNNABLE_M:
300                         /* Need to reclaim any cores this proc might have, even though it's
301                          * not running yet. */
302                         proc_take_allcores(p, 0);
303                         // fallthrough
304                 case PROC_RUNNABLE_S:
305                         // Think about other lists, like WAITING, or better ways to do this
306                         deschedule_proc(p);
307                         break;
308                 case PROC_RUNNING_S:
309                         #if 0
310                         // here's how to do it manually
311                         if (current == p) {
312                                 lcr3(boot_cr3);
313                                 proc_decref(p); // this decref is for the cr3
314                                 current = NULL;
315                         }
316                         #endif
317                         send_active_msg_sync(p->vcoremap[0], __death, (void *SNT)0,
318                                              (void *SNT)0, (void *SNT)0);
319                         #if 0
320                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
321                          * managed by the idlecoremap.  so don't do this yet. */
322                         spin_lock(&idle_lock);
323                         idlecoremap[num_idlecores++] = p->vcoremap[0];
324                         spin_unlock(&idle_lock);
325                         #endif
326                         break;
327                 case PROC_RUNNING_M:
328                         /* Send the DEATH message to every core running this process, and
329                          * deallocate the cores.
330                          * The rule is that the vcoremap is set before proc_run, and reset
331                          * within proc_destroy */
332
333                                 send_active_msg_sync(p->vcoremap[i], __death, (void *SNT)0,
334                                                      (void *SNT)0, (void *SNT)0);
335
336                         proc_take_allcores(p, __death);
337                         break;
338                 default:
339                         // TODO: getting here if it's already dead and free (ENV_FREE).
340                         // Need to sort reusing process structures and having pointers to
341                         // them floating around the system.
342                         panic("Weird state(0x%08x) in proc_destroy", p->state);
343         }
344         proc_set_state(p, PROC_DYING);
345
346         atomic_dec(&num_envs);
347         /* TODO: (REF) dirty hack.  decref currently uses a lock, but needs to use
348          * CAS instead (another lock would be slightly less ghetto).  but we need to
349          * decref before releasing the lock, since that could enable interrupts,
350          * which would have us receive the DEATH IPI if this was called locally by
351          * the target process. */
352         //proc_decref(p); // this decref is for the process in general
353         p->env_refcnt--;
354         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
355
356         /* After unlocking, we can receive a DEATH IPI and clean up */
357         spin_unlock_irqsave(&p->proc_lock);
358
359         // coupled with the refcnt-- above, from decref.  if this happened,
360         // proc_destroy was called "remotely", and with no one else refcnting
361         if (!refcnt)
362                 env_free(p);
363
364         /* If we were running the process, we should have received an IPI by now.
365          * If not, odds are interrupts are disabled, which shouldn't happen while
366          * servicing syscalls. */
367         if (current == p) {
368                 /* a death IPI should be on its way, either from the RUNNING_S one, or
369                  * from proc_take_cores with a __death.  in general, interrupts should
370                  * be on when you call proc_destroy locally, but currently aren't for
371                  * all things (like traphandlers).  since we're dying anyway, it seems
372                  * reasonable to turn on interrupts.  note this means all non-proc
373                  * management interrupt handlers must return (which they need to do
374                  * anyway), so that we get back to this point.  Eventually, we can
375                  * remove the enable_irq.  think about this (TODO) */
376                 enable_irq();
377                 udelay(1000000);
378                 panic("Waiting too long for an IPI in proc_destroy()!");
379         }
380         return;
381 }
382
383 /* Helper function.  Starting from prev, it will find the next free vcoreid,
384  * which is the next slot with a -1 in it.
385  * You better hold the lock before calling this. */
386 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev)
387 {
388         uint32_t i;
389         for (i = prev; i < MAX_NUM_CPUS; i++)
390                 if (p->vcoremap[i] == -1)
391                         break;
392         if (i + 1 >= MAX_NUM_CPUS)
393                 warn("At the end of the vcorelist.  Might want to check that out.");
394         return i;
395 }
396
397 /* Helper function.  Starting from prev, it will find the next busy vcoreid,
398  * which is the next slot with something other than a -1 in it.
399  * You better hold the lock before calling this. */
400 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev)
401 {
402         uint32_t i;
403         for (i = prev; i < MAX_NUM_CPUS; i++)
404                 if (p->vcoremap[i] != -1)
405                         break;
406         if (i + 1 >= MAX_NUM_CPUS)
407                 warn("At the end of the vcorelist.  Might want to check that out.");
408         return i;
409 }
410
411 /* Helper function.  Find the vcoreid for a given physical core id.
412  * You better hold the lock before calling this. */
413 static uint32_t get_vcoreid(struct proc *SAFE p, int32_t pcoreid)
414 {
415         uint32_t i;
416         for (i = 0; i < MAX_NUM_CPUS; i++)
417                 if (p->vcoremap[i] == pcoreid)
418                         break;
419         if (i + 1 >= MAX_NUM_CPUS)
420                 warn("At the end of the vcorelist.  Might want to check that out.");
421         return i;
422 }
423
424 /* Gives process p the additional num cores listed in corelist.  You must be
425  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
426  * startup your new cores at the entry point with their virtual IDs.  If you're
427  * RUNNABLE_M, you should call proc_run after this so that the process can start
428  * to use its cores.
429  *
430  * If you're *_S, make sure your core0's TF is set (which is done when coming in
431  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
432  * Then call proc_run().
433  *
434  * The reason I didn't bring the _S cases from core_request over here is so we
435  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
436  * this is called from another core, and to avoid the need_to_idle business.
437  * The other way would be to have this function have the side effect of changing
438  * state, and finding another way to do the need_to_idle.
439  *
440  * In the event of an error, corelist will include all the cores that were *NOT*
441  * given to the process (cores that are still free).  Practically, this will be
442  * all of them, since it seems like an all or nothing deal right now.
443  *
444  * WARNING: You must hold the proc_lock before calling this!*/
445 error_t proc_give_cores(struct proc *SAFE p, uint32_t corelist[], size_t *num)
446 {
447         uint32_t free_vcoreid = 0;
448         switch (p->state) {
449                 case (PROC_RUNNABLE_S):
450                 case (PROC_RUNNING_S):
451                         panic("Don't give cores to a process in a *_S state!\n");
452                         return -EINVAL;
453                         break;
454                 case (PROC_DYING):
455                         // just FYI, for debugging
456                         printk("[kernel] attempted to give cores to a DYING process.\n");
457                         return -EFAIL;
458                         break;
459                 case (PROC_RUNNABLE_M):
460                         // set up vcoremap.  list should be empty, but could be called
461                         // multiple times before proc_running (someone changed their mind?)
462                         if (p->num_vcores) {
463                                 printk("[kernel] Yaaaaaarrrrr!  Giving extra cores, are we?\n");
464                                 // debugging: if we aren't packed, then there's a problem
465                                 // somewhere, like someone forgot to take vcores after
466                                 // preempting.
467                                 for (int i = 0; i < p->num_vcores; i++)
468                                         assert(p->vcoremap[i]);
469                         }
470                         // add new items to the vcoremap
471                         for (int i = 0; i < *num; i++) {
472                                 // find the next free slot, which should be the next one
473                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
474                                 printd("setting vcore %d to pcore %d\n", free_vcoreid, corelist[i]);
475                                 p->vcoremap[free_vcoreid] = corelist[i];
476                                 p->num_vcores++;
477                         }
478                         break;
479                 case (PROC_RUNNING_M):
480                         for (int i = 0; i < *num; i++) {
481                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
482                                 printd("setting vcore %d to pcore %d\n", free_vcoreid, corelist[i]);
483                                 p->vcoremap[free_vcoreid] = corelist[i];
484                                 p->num_vcores++;
485                                 // TODO: careful of active message deadlock (AMDL)
486                                 assert(corelist[i] != core_id()); // sanity
487                                 send_active_msg_sync(corelist[i], __startcore, (uint32_t)p,
488                                                      0, free_vcoreid);
489                         }
490                         break;
491                 default:
492                         panic("Weird proc state %d in proc_give_cores()!\n", p->state);
493         }
494         return ESUCCESS;
495 }
496
497 /* Makes process p's coremap look like corelist (add, remove, etc).  Caller
498  * needs to know what cores are free after this call (removed, failed, etc).
499  * This info will be returned via corelist and *num.  This will send message to
500  * any cores that are getting removed.
501  *
502  * Before implementing this, we should probably think about when this will be
503  * used.  Implies preempting for the message.
504  *
505  * WARNING: You must hold the proc_lock before calling this!*/
506 error_t proc_set_allcores(struct proc *SAFE p, uint32_t corelist[], size_t *num,
507                           amr_t message)
508 {
509         panic("Set all cores not implemented.\n");
510 }
511
512 /* Takes from process p the num cores listed in corelist.  In the event of an
513  * error, corelist will contain the list of cores that are free, and num will
514  * contain how many items are in corelist.  This isn't implemented yet, but
515  * might be necessary later.  Or not, and we'll never do it.
516  *
517  * TODO: think about taking vcore0.  probably are issues...
518  *
519  * WARNING: You must hold the proc_lock before calling this!*/
520 error_t proc_take_cores(struct proc *SAFE p, uint32_t corelist[], size_t *num,
521                         amr_t message)
522 {
523         uint32_t vcoreid;
524         switch (p->state) {
525                 case (PROC_RUNNABLE_M):
526                         assert(!message);
527                         break;
528                 case (PROC_RUNNING_M):
529                         assert(message);
530                         break;
531                 default:
532                         panic("Weird state %d in proc_take_cores()!\n", p->state);
533         }
534         spin_lock(&idle_lock);
535         assert((*num <= p->num_vcores) && (num_idlecores + *num <= num_cpus));
536         for (int i = 0; i < *num; i++) {
537                 vcoreid = get_vcoreid(p, corelist[i]);
538                 assert(p->vcoremap[vcoreid] == corelist[i]);
539                 if (message)
540                         // TODO: careful of active message deadlock (AMDL)
541                         send_active_msg_sync(corelist[i], message, 0, 0, 0);
542                 // give the pcore back to the idlecoremap
543                 idlecoremap[num_idlecores++] = corelist[i];
544                 p->vcoremap[vcoreid] = -1;
545         }
546         spin_unlock(&idle_lock);
547         p->num_vcores -= *num;
548         return 0;
549 }
550
551 /* Takes all cores from a process, which must be in an _M state.  Cores are
552  * placed back in the idlecoremap.  If there's a message, such as __death or
553  * __preempt, it will be sent to the cores.
554  *
555  * WARNING: You must hold the proc_lock before calling this! */
556 error_t proc_take_allcores(struct proc *SAFE p, amr_t message)
557 {
558         uint32_t active_vcoreid = 0;
559         switch (p->state) {
560                 case (PROC_RUNNABLE_M):
561                         assert(!message);
562                         break;
563                 case (PROC_RUNNING_M):
564                         assert(message);
565                         break;
566                 default:
567                         panic("Weird state %d in proc_take_allcores()!\n", p->state);
568         }
569         spin_lock(&idle_lock);
570         assert(num_idlecores + p->num_vcores <= num_cpus); // sanity
571         for (int i = 0; i < p->num_vcores; i++) {
572                 // find next active vcore
573                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
574                 if (message)
575                         // TODO: careful of active message deadlock (AMDL)
576                         send_active_msg_sync(p->vcoremap[active_vcoreid], message,
577                                              (void *SNT)0, (void *SNT)0, (void *SNT)0);
578                 // give the pcore back to the idlecoremap
579                 idlecoremap[num_idlecores++] = p->vcoremap[active_vcoreid];
580                 p->vcoremap[active_vcoreid] = -1;
581         }
582         spin_unlock(&idle_lock);
583         p->num_vcores = 0;
584         return 0;
585 }
586
587 /*
588  * The process refcnt is the number of places the process 'exists' in the
589  * system.  Creation counts as 1.  Having your page tables loaded somewhere
590  * (lcr3) counts as another 1.  A non-RUNNING_* process should have refcnt at
591  * least 1.  If the kernel is on another core and in a processes address space
592  * (like processing its backring), that counts as another 1.
593  *
594  * Note that the actual loading and unloading of cr3 is up to the caller, since
595  * that's not the only use for this (and decoupling is more flexible).
596  *
597  * The refcnt should always be greater than 0 for processes that aren't dying.
598  * When refcnt is 0, the process is dying and should not allow any more increfs.
599  * A process can be dying with a refcnt greater than 0, since it could be
600  * waiting for other cores to "get the message" to die, or a kernel core can be
601  * finishing work in the processes's address space.
602  *
603  * Implementation aside, the important thing is that we atomically increment
604  * only if it wasn't already 0.  If it was 0, then we shouldn't be attaching to
605  * the process, so we return an error, which should be handled however is
606  * appropriate.  We currently use spinlocks, but some sort of clever atomics
607  * would work too.
608  *
609  * Also, no one should ever update the refcnt outside of these functions.
610  * Eventually, we'll have Ivy support for this. (TODO)
611  *
612  * TODO: (REF) change to use CAS.
613  */
614 error_t proc_incref(struct proc *p)
615 {
616         error_t retval = 0;
617         spin_lock_irqsave(&p->proc_lock);
618         if (p->env_refcnt)
619                 p->env_refcnt++;
620         else
621                 retval = -EBADENV;
622         spin_unlock_irqsave(&p->proc_lock);
623         return retval;
624 }
625
626 /*
627  * When the kernel is done with a process, it decrements its reference count.
628  * When the count hits 0, no one is using it and it should be freed.
629  * "Last one out" actually finalizes the death of the process.  This is tightly
630  * coupled with the previous function (incref)
631  * Be sure to load a different cr3 before calling this!
632  *
633  * TODO: (REF) change to use CAS.  Note that when we do so, we may be holding
634  * the process lock when calling env_free().
635  */
636 void proc_decref(struct proc *p)
637 {
638         spin_lock_irqsave(&p->proc_lock);
639         p->env_refcnt--;
640         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
641         spin_unlock_irqsave(&p->proc_lock);
642         // if we hit 0, no one else will increment and we can check outside the lock
643         if (!refcnt)
644                 env_free(p);
645 }
646
647 /* Active message handler to start a process's context on this core.  Tightly
648  * coupled with proc_run() */
649 #ifdef __IVY__
650 void __startcore(trapframe_t *tf, uint32_t srcid, struct proc *CT(1) a0,
651                  trapframe_t *CT(1) a1, void *SNT a2)
652 #else
653 void __startcore(trapframe_t *tf, uint32_t srcid, void * a0, void * a1,
654                  void * a2)
655 #endif
656 {
657         uint32_t coreid = core_id();
658         struct proc *p_to_run = (struct proc *CT(1))a0;
659         trapframe_t local_tf;
660         trapframe_t *tf_to_pop = (trapframe_t *CT(1))a1;
661
662         printk("[kernel] Startcore on physical core %d\n", coreid);
663         assert(p_to_run);
664         // TODO: handle silly state (HSS)
665         if (!tf_to_pop) {
666                 tf_to_pop = &local_tf;
667                 memset(tf_to_pop, 0, sizeof(*tf_to_pop));
668                 proc_init_trapframe(tf_to_pop);
669                 // Note the init_tf sets tf_to_pop->tf_esp = USTACKTOP;
670                 proc_set_tfcoreid(tf_to_pop, (uint32_t)a2);
671                 proc_set_program_counter(tf_to_pop, p_to_run->env_entry);
672         }
673         proc_startcore(p_to_run, tf_to_pop);
674 }
675
676 /* Active message handler to stop running whatever context is on this core and
677  * to idle.  Note this leaves no trace of what was running.
678  * It's okay if death comes to a core that's already idling and has no current.
679  * It could happen if a process decref'd before proc_startcore could incref. */
680 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
681              void *SNT a2)
682 {
683         /* If we are currently running an address space on our core, we need a known
684          * good pgdir before releasing the old one.  This is currently the major
685          * practical implication of the kernel caring about a processes existence
686          * (the inc and decref).  This decref corresponds to the incref in
687          * proc_startcore (though it's not the only one). */
688         if (current) {
689                 lcr3(boot_cr3);
690                 proc_decref(current);
691                 set_cpu_curenv(NULL);
692         }
693         smp_idle();
694 }
695
696 void print_idlecoremap(void)
697 {
698         spin_lock(&idle_lock);
699         printk("There are %d idle cores.\n", num_idlecores);
700         for (int i = 0; i < num_idlecores; i++)
701                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
702         spin_unlock(&idle_lock);
703 }