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