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