Manually spin_unlock_irqsave and a cleaner destroy
[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 <arch/bitmask.h>
13 #include <process.h>
14 #include <atomic.h>
15 #include <smp.h>
16 #include <pmap.h>
17 #include <trap.h>
18 #include <schedule.h>
19 #include <manager.h>
20 #include <stdio.h>
21 #include <assert.h>
22 #include <timing.h>
23 #include <hashtable.h>
24 #include <slab.h>
25 #include <sys/queue.h>
26
27 /* Process Lists */
28 struct proc_list proc_runnablelist = TAILQ_HEAD_INITIALIZER(proc_runnablelist);
29 spinlock_t runnablelist_lock = SPINLOCK_INITIALIZER;
30 struct kmem_cache *proc_cache;
31
32 /* Tracks which cores are idle, similar to the vcoremap.  Each value is the
33  * physical coreid of an unallocated core. */
34 spinlock_t idle_lock = SPINLOCK_INITIALIZER;
35 uint32_t LCKD(&idle_lock) (RO idlecoremap)[MAX_NUM_CPUS];
36 uint32_t LCKD(&idle_lock) num_idlecores = 0;
37
38 /* Helper function to return a core to the idlemap.  It causes some more lock
39  * acquisitions (like in a for loop), but it's a little easier.  Plus, one day
40  * we might be able to do this without locks (for the putting). */
41 static void put_idle_core(uint32_t coreid)
42 {
43         spin_lock(&idle_lock);
44         idlecoremap[num_idlecores++] = coreid;
45         spin_unlock(&idle_lock);
46 }
47
48 /* PID management. */
49 #define PID_MAX 32767 // goes from 0 to 32767, with 0 reserved
50 static DECL_BITMASK(pid_bmask, PID_MAX + 1);
51 spinlock_t pid_bmask_lock = SPINLOCK_INITIALIZER;
52 struct hashtable *pid_hash;
53 spinlock_t pid_hash_lock; // initialized in proc_init
54
55 /* Finds the next free entry (zero) entry in the pid_bitmask.  Set means busy.
56  * PID 0 is reserved (in proc_init).  A return value of 0 is a failure (and
57  * you'll also see a warning, for now).  Consider doing this with atomics. */
58 static pid_t get_free_pid(void)
59 {
60         static pid_t next_free_pid = 1;
61         pid_t my_pid = 0;
62
63         spin_lock(&pid_bmask_lock);
64         // atomically (can lock for now, then change to atomic_and_return
65         FOR_CIRC_BUFFER(next_free_pid, PID_MAX + 1, i) {
66                 // always points to the next to test
67                 next_free_pid = (next_free_pid + 1) % (PID_MAX + 1);
68                 if (!GET_BITMASK_BIT(pid_bmask, i)) {
69                         SET_BITMASK_BIT(pid_bmask, i);
70                         my_pid = i;
71                         break;
72                 }
73         }
74         spin_unlock(&pid_bmask_lock);
75         if (!my_pid)
76                 warn("Shazbot!  Unable to find a PID!  You need to deal with this!\n");
77         return my_pid;
78 }
79
80 /* Return a pid to the pid bitmask */
81 static void put_free_pid(pid_t pid)
82 {
83         spin_lock(&pid_bmask_lock);
84         CLR_BITMASK_BIT(pid_bmask, pid);
85         spin_unlock(&pid_bmask_lock);
86 }
87
88 /* While this could be done with just an assignment, this gives us the
89  * opportunity to check for bad transitions.  Might compile these out later, so
90  * we shouldn't rely on them for sanity checking from userspace.  */
91 int __proc_set_state(struct proc *p, uint32_t state)
92 {
93         uint32_t curstate = p->state;
94         /* Valid transitions:
95          * C   -> RBS
96          * RBS -> RGS
97          * RGS -> RBS
98          * RGS -> W
99          * W   -> RBS
100          * RGS -> RBM
101          * RBM -> RGM
102          * RGM -> RBM
103          * RGM -> RBS
104          * RGS -> D
105          * RGM -> D
106          *
107          * These ought to be implemented later (allowed, not thought through yet).
108          * RBS -> D
109          * RBM -> D
110          *
111          * This isn't allowed yet, should be later.  Is definitely causable.
112          * C   -> D
113          */
114         #if 1 // some sort of correctness flag
115         switch (curstate) {
116                 case PROC_CREATED:
117                         if (state != PROC_RUNNABLE_S)
118                                 panic("Invalid State Transition! PROC_CREATED to %d", state);
119                         break;
120                 case PROC_RUNNABLE_S:
121                         if (!(state & (PROC_RUNNING_S | PROC_DYING)))
122                                 panic("Invalid State Transition! PROC_RUNNABLE_S to %d", state);
123                         break;
124                 case PROC_RUNNING_S:
125                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
126                                        PROC_DYING)))
127                                 panic("Invalid State Transition! PROC_RUNNING_S to %d", state);
128                         break;
129                 case PROC_WAITING:
130                         if (state != PROC_RUNNABLE_S)
131                                 panic("Invalid State Transition! PROC_WAITING to %d", state);
132                         break;
133                 case PROC_DYING:
134                         if (state != PROC_CREATED) // when it is reused (TODO)
135                                 panic("Invalid State Transition! PROC_DYING to %d", state);
136                         break;
137                 case PROC_RUNNABLE_M:
138                         if (!(state & (PROC_RUNNING_M | PROC_DYING)))
139                                 panic("Invalid State Transition! PROC_RUNNABLE_M to %d", state);
140                         break;
141                 case PROC_RUNNING_M:
142                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_DYING)))
143                                 panic("Invalid State Transition! PROC_RUNNING_M to %d", state);
144                         break;
145         }
146         #endif
147         p->state = state;
148         return 0;
149 }
150
151 /* Returns a pointer to the proc with the given pid, or 0 if there is none */
152 /* TODO: handle refcnting */
153 struct proc *pid2proc(pid_t pid)
154 {
155         spin_lock(&pid_hash_lock);
156         struct proc *p = hashtable_search(pid_hash, (void*)pid);
157         spin_unlock(&pid_hash_lock);
158         return p;
159 }
160
161 /* Performs any intialization related to processes, such as create the proc
162  * cache, prep the scheduler, etc.  When this returns, we should be ready to use
163  * any process related function. */
164 void proc_init(void)
165 {
166         proc_cache = kmem_cache_create("proc", sizeof(struct proc),
167                      MAX(HW_CACHE_ALIGN, __alignof__(struct proc)), 0, 0, 0);
168         /* Init PID mask and hash.  pid 0 is reserved. */
169         SET_BITMASK_BIT(pid_bmask, 0);
170         spinlock_init(&pid_hash_lock);
171         spin_lock(&pid_hash_lock);
172         pid_hash = create_hashtable(100, __generic_hash, __generic_eq);
173         spin_unlock(&pid_hash_lock);
174         schedule_init();
175         /* Init idle cores.  core 0 is not idle, all others are (for now) */
176         spin_lock(&idle_lock);
177         num_idlecores = num_cpus - 1;
178         for (int i = 0; i < num_idlecores; i++)
179                 idlecoremap[i] = i + 1;
180         spin_unlock(&idle_lock);
181         atomic_init(&num_envs, 0);
182 }
183
184 /* Allocates and initializes a process, with the given parent.  Currently
185  * writes the *p into **pp, and returns 0 on success, < 0 for an error.
186  * Errors include:
187  *  - ENOFREEPID if it can't get a PID
188  *  - ENOMEM on memory exhaustion */
189 static error_t proc_alloc(struct proc *SAFE*SAFE pp, pid_t parent_id)
190 {
191         error_t r;
192         struct proc *p;
193
194         if (!(p = kmem_cache_alloc(proc_cache, 0)))
195                 return -ENOMEM;
196
197     { INITSTRUCT(*p)
198
199         /* Initialize the address space */
200         if ((r = env_setup_vm(p)) < 0) {
201                 kmem_cache_free(proc_cache, p);
202                 return r;
203         }
204
205         /* Get a pid, then store a reference in the pid_hash */
206         if (!(p->pid = get_free_pid())) {
207                 kmem_cache_free(proc_cache, p);
208                 return -ENOFREEPID;
209         }
210         spin_lock(&pid_hash_lock);
211         hashtable_insert(pid_hash, (void*)p->pid, p);
212         spin_unlock(&pid_hash_lock);
213
214         /* Set the basic status variables. */
215     spinlock_init(&p->proc_lock);
216         p->ppid = parent_id;
217         __proc_set_state(p, PROC_CREATED);
218         p->env_refcnt = 1;
219         p->env_flags = 0;
220         p->env_entry = 0; // cheating.  this really gets set in load_icode
221         p->num_vcores = 0;
222         memset(&p->vcoremap, -1, sizeof(p->vcoremap));
223         memset(&p->resources, 0, sizeof(p->resources));
224         memset(&p->env_ancillary_state, 0, sizeof(p->env_ancillary_state));
225         memset(&p->env_tf, 0, sizeof(p->env_tf));
226         proc_init_trapframe(&p->env_tf);
227
228         /* Initialize the contents of the e->env_procinfo structure */
229         p->env_procinfo->pid = p->pid;
230         /* Initialize the contents of the e->env_procdata structure */
231
232         /* Initialize the generic syscall ring buffer */
233         SHARED_RING_INIT(&p->env_procdata->syscallring);
234         /* Initialize the backend of the syscall ring buffer */
235         BACK_RING_INIT(&p->syscallbackring,
236                        &p->env_procdata->syscallring,
237                        SYSCALLRINGSIZE);
238
239         /* Initialize the generic sysevent ring buffer */
240         SHARED_RING_INIT(&p->env_procdata->syseventring);
241         /* Initialize the frontend of the sysevent ring buffer */
242         FRONT_RING_INIT(&p->syseventfrontring,
243                         &p->env_procdata->syseventring,
244                         SYSEVENTRINGSIZE);
245         *pp = p;
246         atomic_inc(&num_envs);
247
248         printk("[%08x] new process %08x\n", current ? current->pid : 0, p->pid);
249         } // INIT_STRUCT
250         return 0;
251 }
252
253 /* Creates a process from the specified binary, which is of size size.
254  * Currently, the binary must be a contiguous block of memory, which needs to
255  * change.  On any failure, it just panics, which ought to be sorted. */
256 struct proc *proc_create(uint8_t *binary, size_t size)
257 {
258         struct proc *p;
259         error_t r;
260         pid_t curid;
261
262         curid = (current ? current->pid : 0);
263         if ((r = proc_alloc(&p, curid)) < 0)
264                 panic("proc_create: %e", r); // one of 3 quaint usages of %e.
265         load_icode(p, binary, size);
266         return p;
267 }
268
269 /* This is called by proc_decref, once the last reference to the process is
270  * gone.  Don't call this otherwise (it will panic).  It will clean up the
271  * address space and deallocate any other used memory. */
272 static void __proc_free(struct proc *p)
273 {
274         physaddr_t pa;
275
276         printk("[PID %d] freeing proc: %d\n", current ? current->pid : 0, p->pid);
277         // All parts of the kernel should have decref'd before __proc_free is called
278         assert(p->env_refcnt == 0);
279
280         // Flush all mapped pages in the user portion of the address space
281         env_user_mem_free(p);
282
283         // free the page directory
284         pa = p->env_cr3;
285         p->env_pgdir = 0;
286         p->env_cr3 = 0;
287         page_decref(pa2page(pa));
288
289         /* between when someone grabs the *proc (from pid), til they use it, it
290          * could be killed and/or deallocated.  lots of our protections come from
291          * the state, which needs to be dereferenced, and isn't protected from this.
292          *
293          * (TODO) rule: when you get a *proc, you up the refcnt.  need to down it
294          * when you are done.  if you fail, someone else is deallocating it.  you
295          * shouldn't have dereferenced it (it may be 'gone' already), so there is a
296          * slight race, but if you do this check quickly, it's *probably* not an
297          * issue.  so do it with interrupts off.  pid2proc will handle that, but you
298          * need to decref still
299          * - getting the pointer from current is a refcnt'd source.  when current is
300          *   set, the refcnt is up anyway (for protecting the page tables), so just
301          *   use it normally.
302          * - if you pass the pointer (via amsg, etc), the code that uses it should
303          *   up its refcnt or otherwise deal with the issue (which startcore should
304          *   do), though this might need to change. (freed and realloc before the
305          *   message arrives).  perhaps up the refcnt in advance, and down it if it
306          *   was unnecessary (TODO).
307          * - if the pointer is stored somewhere (like in an IO continuation), the
308          *   refcnt needs to stay up.
309          * - can check for DYING too, though some situations may want to grab a
310          *   dying proc's *
311          * - i am not concerned with pointing to a new proc with that same PID, the
312          *   concern is with referencing kernel memory.
313          * Might move this to proc_destroy.  depends if we want parents to wait().
314          */
315         /* Remove self from the pid hash, return PID.  Note the reversed order. */
316         spin_lock(&pid_hash_lock);
317         if (!hashtable_remove(pid_hash, (void*)p->pid))
318                 panic("Proc not in the pid table in %s", __FUNCTION__);
319         spin_unlock(&pid_hash_lock);
320         put_free_pid(p->pid);
321         atomic_dec(&num_envs);
322
323         /* Dealloc the struct proc */
324         kmem_cache_free(proc_cache, p);
325 }
326
327 /* Whether or not actor can control target.  Note we currently don't need
328  * locking for this. TODO: think about that, esp wrt proc's dying. */
329 bool proc_controls(struct proc *actor, struct proc *target)
330 {
331         return ((actor == target) || (target->ppid == actor->pid));
332 }
333
334 /* Dispatches a process to run, either on the current core in the case of a
335  * RUNNABLE_S, or on its partition in the case of a RUNNABLE_M.  This should
336  * never be called to "restart" a core.  This expects that the "instructions"
337  * for which core(s) to run this on will be in the vcoremap, which needs to be
338  * set externally.
339  *
340  * When a process goes from RUNNABLE_M to RUNNING_M, its vcoremap will be
341  * "packed" (no holes in the vcore->pcore mapping), vcore0 will continue to run
342  * it's old core0 context, and the other cores will come in at the entry point.
343  * Including in the case of preemption.  */
344 void proc_run(struct proc *p)
345 {
346         spin_lock_irqsave(&p->proc_lock);
347         switch (p->state) {
348                 case (PROC_DYING):
349                         spin_unlock_irqsave(&p->proc_lock);
350                         printk("Process %d not starting due to async death\n", p->pid);
351                         // There should be no core cleanup to do (like decref).
352                         assert(current != p);
353                         // if we're a worker core, smp_idle, o/w return
354                         if (!management_core())
355                                 smp_idle(); // this never returns
356                         return;
357                 case (PROC_RUNNABLE_S):
358                         __proc_set_state(p, PROC_RUNNING_S);
359                         /* We will want to know where this process is running, even if it is
360                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
361                          * Also, this is the signal used in trap.c to know to save the tf in
362                          * env_tf.
363                          * We may need the pcoremap entry to mark it as a RUNNING_S core, or
364                          * else update it here. (TODO) (PCORE) */
365                         p->num_vcores = 0;
366                         p->vcoremap[0] = core_id();
367                         spin_unlock_irqsave(&p->proc_lock);
368                         // This normally doesn't return, but might error out in the future.
369                         proc_startcore(p, &p->env_tf);
370                         break;
371                 case (PROC_RUNNABLE_M):
372                         __proc_set_state(p, PROC_RUNNING_M);
373                         /* vcoremap[i] holds the coreid of the physical core allocated to
374                          * this process.  It is set outside proc_run.  For the active
375                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
376                         if (p->num_vcores) {
377                                 int i = 0;
378                                 // TODO: handle silly state (HSS)
379                                 // set virtual core 0 to run the main context on transition
380                                 if (p->env_flags & PROC_TRANSITION_TO_M) {
381                                         p->env_flags &= !PROC_TRANSITION_TO_M;
382 #ifdef __IVY__
383                                         send_active_message(p->vcoremap[0], __startcore, p,
384                                                             &p->env_tf, (void *SNT)0);
385 #else
386                                         send_active_message(p->vcoremap[0], (void *)__startcore,
387                                                             (void *)p, (void *)&p->env_tf, 0);
388 #endif
389                                         i = 1; // start at vcore1 in the loop below
390                                 }
391                                 /* handle the others. */
392                                 for (/* i set above */; i < p->num_vcores; i++)
393 #ifdef __IVY__
394                                         send_active_message(p->vcoremap[i], __startcore,
395                                                             p, (trapframe_t *CT(1))NULL, (void *SNT)i);
396 #else
397                                         send_active_message(p->vcoremap[i], (void *)__startcore,
398                                                             (void *)p, (void *)0, (void *)i);
399 #endif
400                         }
401                         /* There a subtle (attempted) race avoidance here.  proc_startcore
402                          * can handle a death message, but we can't have the startcore come
403                          * after the death message.  Otherwise, it would look like a new
404                          * process.  So we hold the lock to make sure our message went out
405                          * before a possible death message.
406                          * - Likewise, we need interrupts to be disabled, in case one of the
407                          *   messages was for us, and reenable them after letting go of the
408                          *   lock.  This is done by spin_lock_irqsave, so be careful if you
409                          *   change this.
410                          * - This can also be done far more intelligently / efficiently,
411                          *   like skipping in case it's busy and coming back later.
412                          * - Note there is no guarantee this core's interrupts were on, so
413                          *   it may not get the message for a while... */
414                         spin_unlock_irqsave(&p->proc_lock);
415                         break;
416                 default:
417                         spin_unlock_irqsave(&p->proc_lock);
418                         panic("Invalid process state %p in proc_run()!!", p->state);
419         }
420 }
421
422 /*
423  * Runs the given context (trapframe) of process p on the core this code
424  * executes on.  The refcnt tracks how many cores have "an interest" in this
425  * process, which so far just means it uses the process's page table.  See the
426  * massive comments around the incref function
427  *
428  * Given we are RUNNING_*, an IPI for death or preemption could come in:
429  * 1. death attempt (IPI to kill whatever is on your core):
430  *              we don't need to worry about protecting the stack, since we're
431  *              abandoning ship - just need to get a good cr3 and decref current, which
432  *              the death handler will do.
433  *              If a death IPI comes in, we immediately stop this function and will
434  *              never come back.
435  * 2. preempt attempt (IPI to package state and maybe run something else):
436  *              - if a preempt attempt comes in while we're in the kernel, it'll
437  *              just set a flag.  we could attempt to bundle the kernel state
438  *              and rerun it later, but it's really messy (and possibly given
439  *              back to userspace).  we'll disable ints, check this flag, and if
440  *              so, handle the preemption using the same funcs as the normal
441  *              preemption handler.  nonblocking kernel calls will just slow
442  *              down the preemption while they work.  blocking kernel calls will
443  *              need to package their state properly anyway.
444  *
445  * TODO: in general, think about when we no longer need the stack, in case we
446  * are preempted and expected to run again from somewhere else.  we can't
447  * expect to have the kernel stack around anymore.  the nice thing about being
448  * at this point is that we are just about ready to give up the stack anyways.
449  *
450  * I think we need to make it such that the kernel in "process context" never
451  * gets removed from the core (displaced from its stack) without going through
452  * some "bundling" code.
453  */
454 void proc_startcore(struct proc *p, trapframe_t *tf) {
455         // it's possible to be DYING, but it's a rare race.
456         //if (p->state & (PROC_RUNNING_S | PROC_RUNNING_M))
457         //      printk("dying before (re)startcore on core %d\n", core_id());
458         // sucks to have ints disabled when doing env_decref and possibly freeing
459         disable_irq();
460         if (per_cpu_info[core_id()].preempt_pending) {
461                 // TODO: handle preemption
462                 // the functions will need to consider deal with current like down below
463                 panic("Preemption not supported!");
464         }
465         /* If the process wasn't here, then we need to load its address space. */
466         if (p != current) {
467                 if (proc_incref(p)) {
468                         // getting here would mean someone tried killing this while we tried
469                         // to start one of it's contexts (from scratch, o/w we had it's CR3
470                         // loaded already)
471                         // if this happens, a no-op death-IPI ought to be on its way...  we can
472                         // just smp_idle()
473                         smp_idle();
474                 }
475                 lcr3(p->env_cr3);
476                 // we unloaded the old cr3, so decref it (if it exists)
477                 // TODO: Consider moving this to wherever we really "mean to leave the
478                 // process's context".  abandon_core() does this.
479                 if (current)
480                         proc_decref(current);
481                 set_current_proc(p);
482         }
483         /* need to load our silly state, preferably somewhere other than here so we
484          * can avoid the case where the context was just running here.  it's not
485          * sufficient to do it in the "new process" if-block above (could be things
486          * like page faults that cause us to keep the same process, but want a
487          * different context.
488          * for now, we load this silly state here. (TODO) (HSS)
489          * We also need this to be per trapframe, and not per process...
490          */
491         env_pop_ancillary_state(p);
492         env_pop_tf(tf);
493 }
494
495 /* Helper function, helps with receiving local death IPIs, for the cases when
496  * this core is running the process.  We should received an IPI shortly.  If
497  * not, odds are interrupts are disabled, which shouldn't happen while servicing
498  * syscalls. */
499 static void check_for_local_death(struct proc *p)
500 {
501         if (current == p) {
502                 /* a death IPI should be on its way, either from the RUNNING_S one, or
503                  * from proc_take_cores with a __death.  in general, interrupts should
504                  * be on when you call proc_destroy locally, but currently aren't for
505                  * all things (like traphandlers).  since we're dying anyway, it seems
506                  * reasonable to turn on interrupts.  note this means all non-proc
507                  * management interrupt handlers must return (which they need to do
508                  * anyway), so that we get back to this point.  Eventually, we can
509                  * remove the enable_irq.  think about this (TODO) */
510                 enable_irq();
511                 udelay(1000000);
512                 panic("Waiting too long on core %d for an IPI in proc_destroy()!",
513                       core_id());
514         }
515 }
516
517 /*
518  * Destroys the given process.  This may be called from another process, a light
519  * kernel thread (no real process context), asynchronously/cross-core, or from
520  * the process on its own core.
521  *
522  * Here's the way process death works:
523  * 0. grab the lock (protects state transition and core map)
524  * 1. set state to dying.  that keeps the kernel from doing anything for the
525  * process (like proc_running it).
526  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
527  * 3. IPI to clean up those cores (decref, etc).
528  * 4. Unlock
529  * 5. Clean up your core, if applicable
530  * (Last core/kernel thread to decref cleans up and deallocates resources.)
531  *
532  * Note that some cores can be processing async calls, but will eventually
533  * decref.  Should think about this more.
534  */
535 void proc_destroy(struct proc *p)
536 {
537         // Note this code relies on this lock disabling interrupts, similar to
538         // proc_run.
539         uint32_t corelist[MAX_NUM_CPUS];
540         size_t num_cores_freed;
541         spin_lock_irqsave(&p->proc_lock);
542         switch (p->state) {
543                 case PROC_DYING: // someone else killed this already.
544                         spin_unlock_irqsave(&p->proc_lock);
545                         check_for_local_death(p); // IPI may be on it's way.
546                         return;
547                 case PROC_RUNNABLE_M:
548                         /* Need to reclaim any cores this proc might have, even though it's
549                          * not running yet. */
550                         __proc_take_allcores(p, NULL, NULL, NULL, NULL);
551                         // fallthrough
552                 case PROC_RUNNABLE_S:
553                         // Think about other lists, like WAITING, or better ways to do this
554                         deschedule_proc(p);
555                         break;
556                 case PROC_RUNNING_S:
557                         #if 0
558                         // here's how to do it manually
559                         if (current == p) {
560                                 lcr3(boot_cr3);
561                                 proc_decref(p); // this decref is for the cr3
562                                 current = NULL;
563                         }
564                         #endif
565                         send_active_message(p->vcoremap[0], __death, (void *SNT)0,
566                                             (void *SNT)0, (void *SNT)0);
567                         #if 0
568                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
569                          * managed by the idlecoremap.  so don't do this yet. */
570                         put_idle_core(p->vcoremap[0]);
571                         #endif
572                         break;
573                 case PROC_RUNNING_M:
574                         /* Send the DEATH message to every core running this process, and
575                          * deallocate the cores.
576                          * The rule is that the vcoremap is set before proc_run, and reset
577                          * within proc_destroy */
578                         __proc_take_allcores(p, __death, (void *SNT)0, (void *SNT)0,
579                                              (void *SNT)0);
580                         break;
581                 default:
582                         panic("Weird state(0x%08x) in proc_destroy", p->state);
583         }
584         __proc_set_state(p, PROC_DYING);
585
586         /* Leave interrupts turned off, but unlock.  Store whether or not we should
587          * reenable interrupts down below.  We're manually doing the unlock_irqsave,
588          * since we need to make sure we finish this function before turning
589          * interrupts back on (in case a death/abandon_core comes in). */
590         bool irq_en = spin_lock_irq_enabled(&p->proc_lock);
591         spin_unlock(&p->proc_lock);
592
593         proc_decref(p); // this decref is for the process in general
594         
595         /* Reenable interrupts if we should have from the spin_unlock_irqsave.  We
596          * should almost always be reenabling.  Once we reenable, we can receive a
597          * death IPI (if applicable) and never return. */
598         if (irq_en)
599                 enable_irq();
600
601         /* if our core is part of process p, then check/wait for the death IPI. */
602         check_for_local_death(p);
603         return;
604 }
605
606 /* Helper function.  Starting from prev, it will find the next free vcoreid,
607  * which is the next slot with a -1 in it.
608  * You better hold the lock before calling this. */
609 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev)
610 {
611         uint32_t i;
612         for (i = prev; i < MAX_NUM_CPUS; i++)
613                 if (p->vcoremap[i] == -1)
614                         break;
615         if (i + 1 >= MAX_NUM_CPUS)
616                 warn("At the end of the vcorelist.  Might want to check that out.");
617         return i;
618 }
619
620 /* Helper function.  Starting from prev, it will find the next busy vcoreid,
621  * which is the next slot with something other than a -1 in it.
622  * You better hold the lock before calling this. */
623 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev)
624 {
625         uint32_t i;
626         for (i = prev; i < MAX_NUM_CPUS; i++)
627                 if (p->vcoremap[i] != -1)
628                         break;
629         if (i + 1 >= MAX_NUM_CPUS)
630                 warn("At the end of the vcorelist.  Might want to check that out.");
631         return i;
632 }
633
634 /* Helper function.  Find the vcoreid for a given physical core id.
635  * You better hold the lock before calling this.  If we use some sort of
636  * pcoremap, we can avoid this linear search. */
637 static uint32_t get_vcoreid(struct proc *SAFE p, int32_t pcoreid)
638 {
639         uint32_t i;
640         for (i = 0; i < MAX_NUM_CPUS; i++)
641                 if (p->vcoremap[i] == pcoreid)
642                         break;
643         if (i + 1 >= MAX_NUM_CPUS)
644                 warn("At the end of the vcorelist.  Might want to check that out.");
645         return i;
646 }
647
648 /* Yields the calling core.  Must be called locally (not async) for now.
649  * - If RUNNING_S, you just give up your time slice and will eventually return.
650  * - If RUNNING_M, you give up the current vcore (which never returns), and
651  *   adjust the amount of cores wanted/granted.
652  * - If you have only one vcore, you switch to RUNNABLE_M.  When you run again,
653  *   you'll have one guaranteed core, starting from the entry point.
654  *
655  * - RES_CORES amt_wanted will be the amount running after taking away the
656  *   yielder, unless there are none left, in which case it will be 1.
657  */
658 void proc_yield(struct proc *SAFE p)
659 {
660         spin_lock_irqsave(&p->proc_lock);
661         switch (p->state) {
662                 case (PROC_RUNNING_S):
663                         p->env_tf= *current_tf;
664                         env_push_ancillary_state(p);
665                         __proc_set_state(p, PROC_RUNNABLE_S);
666                         schedule_proc(p);
667                         break;
668                 case (PROC_RUNNING_M):
669                         p->resources[RES_CORES].amt_granted = --(p->num_vcores);
670                         p->resources[RES_CORES].amt_wanted = p->num_vcores;
671                         // give up core
672                         p->vcoremap[get_vcoreid(p, core_id())] = -1;
673                         // add to idle list
674                         put_idle_core(core_id());
675                         // last vcore?  then we really want 1, and to yield the gang
676                         if (p->num_vcores == 0) {
677                                 // might replace this with m_yield, if we have it directly
678                                 p->resources[RES_CORES].amt_wanted = 1;
679                                 __proc_set_state(p, PROC_RUNNABLE_M);
680                                 schedule_proc(p);
681                         }
682                         break;
683                 default:
684                         // there are races that can lead to this (async death, preempt, etc)
685                         panic("Weird state(0x%08x) in proc_yield", p->state);
686         }
687         spin_unlock_irqsave(&p->proc_lock);
688         // clean up the core and idle.  for mgmt cores, they will ultimately call
689         // manager, which will call schedule(), which will repick the yielding proc.
690         abandon_core();
691 }
692
693 /* Gives process p the additional num cores listed in corelist.  You must be
694  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
695  * startup your new cores at the entry point with their virtual IDs.  If you're
696  * RUNNABLE_M, you should call proc_run after this so that the process can start
697  * to use its cores.
698  *
699  * If you're *_S, make sure your core0's TF is set (which is done when coming in
700  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
701  * Then call proc_run().
702  *
703  * The reason I didn't bring the _S cases from core_request over here is so we
704  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
705  * this is called from another core, and to avoid the need_to_idle business.
706  * The other way would be to have this function have the side effect of changing
707  * state, and finding another way to do the need_to_idle.
708  *
709  * In the event of an error, corelist will include all the cores that were *NOT*
710  * given to the process (cores that are still free).  Practically, this will be
711  * all of them, since it seems like an all or nothing deal right now.
712  *
713  * WARNING: You must hold the proc_lock before calling this!*/
714
715 // zra: If corelist has *num elements, then it would be best if the value is
716 // passed instead of a pointer to it. If in the future some way will be needed
717 // to return the number of cores, then it might be best to use a separate
718 // parameter for that.
719 error_t __proc_give_cores(struct proc *SAFE p, uint32_t corelist[], size_t *num)
720 { TRUSTEDBLOCK
721         uint32_t free_vcoreid = 0;
722         switch (p->state) {
723                 case (PROC_RUNNABLE_S):
724                 case (PROC_RUNNING_S):
725                         panic("Don't give cores to a process in a *_S state!\n");
726                         return -EINVAL;
727                         break;
728                 case (PROC_DYING):
729                         // just FYI, for debugging
730                         printk("[kernel] attempted to give cores to a DYING process.\n");
731                         return -EFAIL;
732                         break;
733                 case (PROC_RUNNABLE_M):
734                         // set up vcoremap.  list should be empty, but could be called
735                         // multiple times before proc_running (someone changed their mind?)
736                         if (p->num_vcores) {
737                                 printk("[kernel] Yaaaaaarrrrr!  Giving extra cores, are we?\n");
738                                 // debugging: if we aren't packed, then there's a problem
739                                 // somewhere, like someone forgot to take vcores after
740                                 // preempting.
741                                 for (int i = 0; i < p->num_vcores; i++)
742                                         assert(p->vcoremap[i]);
743                         }
744                         // add new items to the vcoremap
745                         for (int i = 0; i < *num; i++) {
746                                 // find the next free slot, which should be the next one
747                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
748                                 printd("setting vcore %d to pcore %d\n", free_vcoreid, corelist[i]);
749                                 p->vcoremap[free_vcoreid] = corelist[i];
750                                 p->num_vcores++;
751                         }
752                         break;
753                 case (PROC_RUNNING_M):
754                         for (int i = 0; i < *num; i++) {
755                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
756                                 printd("setting vcore %d to pcore %d\n", free_vcoreid, corelist[i]);
757                                 p->vcoremap[free_vcoreid] = corelist[i];
758                                 p->num_vcores++;
759                                 assert(corelist[i] != core_id()); // sanity
760                                 send_active_message(corelist[i], __startcore, p,
761                                                      (struct Trapframe *)0,
762                                                      (void*SNT)free_vcoreid);
763                         }
764                         break;
765                 default:
766                         panic("Weird proc state %d in proc_give_cores()!\n", p->state);
767         }
768         return ESUCCESS;
769 }
770
771 /* Makes process p's coremap look like corelist (add, remove, etc).  Caller
772  * needs to know what cores are free after this call (removed, failed, etc).
773  * This info will be returned via corelist and *num.  This will send message to
774  * any cores that are getting removed.
775  *
776  * Before implementing this, we should probably think about when this will be
777  * used.  Implies preempting for the message.
778  *
779  * WARNING: You must hold the proc_lock before calling this!*/
780 error_t __proc_set_allcores(struct proc *SAFE p, uint32_t corelist[],
781                             size_t *num, amr_t message,TV(a0t) arg0,
782                             TV(a1t) arg1, TV(a2t) arg2)
783 {
784         panic("Set all cores not implemented.\n");
785 }
786
787 /* Takes from process p the num cores listed in corelist.  In the event of an
788  * error, corelist will contain the list of cores that are free, and num will
789  * contain how many items are in corelist.  This isn't implemented yet, but
790  * might be necessary later.  Or not, and we'll never do it.
791  *
792  * WARNING: You must hold the proc_lock before calling this!*/
793 error_t __proc_take_cores(struct proc *SAFE p, uint32_t corelist[],
794                           size_t *num, amr_t message, TV(a0t) arg0,
795                           TV(a1t) arg1, TV(a2t) arg2)
796 { TRUSTEDBLOCK
797         uint32_t vcoreid;
798         switch (p->state) {
799                 case (PROC_RUNNABLE_M):
800                         assert(!message);
801                         break;
802                 case (PROC_RUNNING_M):
803                         assert(message);
804                         break;
805                 default:
806                         panic("Weird state %d in proc_take_cores()!\n", p->state);
807         }
808         spin_lock(&idle_lock);
809         assert((*num <= p->num_vcores) && (num_idlecores + *num <= num_cpus));
810         spin_unlock(&idle_lock);
811         for (int i = 0; i < *num; i++) {
812                 vcoreid = get_vcoreid(p, corelist[i]);
813                 assert(p->vcoremap[vcoreid] == corelist[i]);
814                 if (message)
815                         send_active_message(corelist[i], message, arg0, arg1, arg2);
816                 // give the pcore back to the idlecoremap
817                 put_idle_core(corelist[i]);
818                 p->vcoremap[vcoreid] = -1;
819         }
820         p->num_vcores -= *num;
821         p->resources[RES_CORES].amt_granted -= *num;
822         return 0;
823 }
824
825 /* Takes all cores from a process, which must be in an _M state.  Cores are
826  * placed back in the idlecoremap.  If there's a message, such as __death or
827  * __preempt, it will be sent to the cores.
828  *
829  * WARNING: You must hold the proc_lock before calling this! */
830 error_t __proc_take_allcores(struct proc *SAFE p, amr_t message,
831                              TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
832 {
833         uint32_t active_vcoreid = 0;
834         switch (p->state) {
835                 case (PROC_RUNNABLE_M):
836                         assert(!message);
837                         break;
838                 case (PROC_RUNNING_M):
839                         assert(message);
840                         break;
841                 default:
842                         panic("Weird state %d in proc_take_allcores()!\n", p->state);
843         }
844         spin_lock(&idle_lock);
845         assert(num_idlecores + p->num_vcores <= num_cpus); // sanity
846         spin_unlock(&idle_lock);
847         for (int i = 0; i < p->num_vcores; i++) {
848                 // find next active vcore
849                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
850                 if (message)
851                         send_active_message(p->vcoremap[active_vcoreid], message,
852                                              arg0, arg1, arg2);
853                 // give the pcore back to the idlecoremap
854                 put_idle_core(p->vcoremap[active_vcoreid]);
855                 p->vcoremap[active_vcoreid] = -1;
856         }
857         p->num_vcores = 0;
858         p->resources[RES_CORES].amt_granted = 0;
859         return 0;
860 }
861
862 /*
863  * The process refcnt is the number of places the process 'exists' in the
864  * system.  Creation counts as 1.  Having your page tables loaded somewhere
865  * (lcr3) counts as another 1.  A non-RUNNING_* process should have refcnt at
866  * least 1.  If the kernel is on another core and in a processes address space
867  * (like processing its backring), that counts as another 1.
868  *
869  * Note that the actual loading and unloading of cr3 is up to the caller, since
870  * that's not the only use for this (and decoupling is more flexible).
871  *
872  * The refcnt should always be greater than 0 for processes that aren't dying.
873  * When refcnt is 0, the process is dying and should not allow any more increfs.
874  * A process can be dying with a refcnt greater than 0, since it could be
875  * waiting for other cores to "get the message" to die, or a kernel core can be
876  * finishing work in the processes's address space.
877  *
878  * Implementation aside, the important thing is that we atomically increment
879  * only if it wasn't already 0.  If it was 0, then we shouldn't be attaching to
880  * the process, so we return an error, which should be handled however is
881  * appropriate.  We currently use spinlocks, but some sort of clever atomics
882  * would work too.
883  *
884  * Also, no one should ever update the refcnt outside of these functions.
885  * Eventually, we'll have Ivy support for this. (TODO)
886  *
887  * TODO: (REF) change to use CAS.
888  */
889 error_t proc_incref(struct proc *p)
890 {
891         error_t retval = 0;
892         spin_lock_irqsave(&p->proc_lock);
893         if (p->env_refcnt)
894                 p->env_refcnt++;
895         else
896                 retval = -EBADPROC;
897         spin_unlock_irqsave(&p->proc_lock);
898         return retval;
899 }
900
901 /*
902  * When the kernel is done with a process, it decrements its reference count.
903  * When the count hits 0, no one is using it and it should be freed.
904  * "Last one out" actually finalizes the death of the process.  This is tightly
905  * coupled with the previous function (incref)
906  * Be sure to load a different cr3 before calling this!
907  *
908  * TODO: (REF) change to use CAS.  Note that when we do so, we may be holding
909  * the process lock when calling __proc_free().
910  */
911 void proc_decref(struct proc *p)
912 {
913         spin_lock_irqsave(&p->proc_lock);
914         p->env_refcnt--;
915         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
916         spin_unlock_irqsave(&p->proc_lock);
917         // if we hit 0, no one else will increment and we can check outside the lock
918         if (!refcnt)
919                 __proc_free(p);
920 }
921
922 /* Active message handler to start a process's context on this core.  Tightly
923  * coupled with proc_run() */
924 #ifdef __IVY__
925 void __startcore(trapframe_t *tf, uint32_t srcid, struct proc *CT(1) a0,
926                  trapframe_t *CT(1) a1, void *SNT a2)
927 #else
928 void __startcore(trapframe_t *tf, uint32_t srcid, void * a0, void * a1,
929                  void * a2)
930 #endif
931 {
932         uint32_t coreid = core_id();
933         struct proc *p_to_run = (struct proc *CT(1))a0;
934         trapframe_t local_tf;
935         trapframe_t *tf_to_pop = (trapframe_t *CT(1))a1;
936
937         printk("[kernel] Startcore on physical core %d\n", coreid);
938         assert(p_to_run);
939         // TODO: handle silly state (HSS)
940         if (!tf_to_pop) {
941                 tf_to_pop = &local_tf;
942                 memset(tf_to_pop, 0, sizeof(*tf_to_pop));
943                 proc_init_trapframe(tf_to_pop);
944                 // Note the init_tf sets tf_to_pop->tf_esp = USTACKTOP;
945                 proc_set_tfcoreid(tf_to_pop, (uint32_t)a2);
946                 proc_set_program_counter(tf_to_pop, p_to_run->env_entry);
947         }
948         proc_startcore(p_to_run, tf_to_pop);
949 }
950
951 /* Stop running whatever context is on this core and to 'idle'.  Note this
952  * leaves no trace of what was running. This "leaves the process's context. */
953 void abandon_core(void)
954 {
955         /* If we are currently running an address space on our core, we need a known
956          * good pgdir before releasing the old one.  This is currently the major
957          * practical implication of the kernel caring about a processes existence
958          * (the inc and decref).  This decref corresponds to the incref in
959          * proc_startcore (though it's not the only one). */
960         if (current) {
961                 lcr3(boot_cr3);
962                 proc_decref(current);
963                 set_current_proc(NULL);
964         }
965         smp_idle();
966 }
967
968 /* Active message handler to clean up the core when a process is dying.
969  * Note this leaves no trace of what was running.
970  * It's okay if death comes to a core that's already idling and has no current.
971  * It could happen if a process decref'd before proc_startcore could incref. */
972 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
973              void *SNT a2)
974 {
975         abandon_core();
976 }
977
978 void print_idlecoremap(void)
979 {
980         spin_lock(&idle_lock);
981         printk("There are %d idle cores.\n", num_idlecores);
982         for (int i = 0; i < num_idlecores; i++)
983                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
984         spin_unlock(&idle_lock);
985 }
986
987 void print_allpids(void)
988 {
989         spin_lock(&pid_hash_lock);
990         if (hashtable_count(pid_hash)) {
991                 hashtable_itr_t *phtable_i = hashtable_iterator(pid_hash);
992                 do {
993                         printk("PID: %d\n", hashtable_iterator_key(phtable_i));
994                 } while (hashtable_iterator_advance(phtable_i));
995         }
996         spin_unlock(&pid_hash_lock);
997 }
998
999 void print_proc_info(pid_t pid)
1000 {
1001         int j = 0;
1002         struct proc *p = pid2proc(pid);
1003         // not concerned with a race on the state...
1004         if (!p) {
1005                 printk("Bad PID.\n");
1006                 return;
1007         }
1008         spinlock_debug(&p->proc_lock);
1009         spin_lock_irqsave(&p->proc_lock);
1010         printk("struct proc: %p\n", p);
1011         printk("PID: %d\n", p->pid);
1012         printk("PPID: %d\n", p->ppid);
1013         printk("State: 0x%08x\n", p->state);
1014         printk("Refcnt: %d\n", p->env_refcnt);
1015         printk("Flags: 0x%08x\n", p->env_flags);
1016         printk("CR3(phys): 0x%08x\n", p->env_cr3);
1017         printk("Num Vcores: %d\n", p->num_vcores);
1018         printk("Vcoremap:\n");
1019         for (int i = 0; i < p->num_vcores; i++) {
1020                 j = get_busy_vcoreid(p, j);
1021                 printk("\tVcore %d: Pcore %d\n", j, p->vcoremap[j]);
1022                 j++;
1023         }
1024         printk("Resources:\n");
1025         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
1026                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
1027                        p->resources[i].amt_wanted, p->resources[i].amt_granted);
1028         printk("Vcore 0's Last Trapframe:\n");
1029         print_trapframe(&p->env_tf);
1030         spin_unlock_irqsave(&p->proc_lock);
1031 }