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