Fixed smp_percpu_init() on sparc; added asserts
[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 <ros/bcq.h>
12 #include <arch/arch.h>
13 #include <arch/bitmask.h>
14 #include <process.h>
15 #include <atomic.h>
16 #include <smp.h>
17 #include <pmap.h>
18 #include <trap.h>
19 #include <schedule.h>
20 #include <manager.h>
21 #include <stdio.h>
22 #include <assert.h>
23 #include <timing.h>
24 #include <hashtable.h>
25 #include <slab.h>
26 #include <sys/queue.h>
27 #include <frontend.h>
28 #include <monitor.h>
29
30 /* Process Lists */
31 struct proc_list proc_runnablelist = TAILQ_HEAD_INITIALIZER(proc_runnablelist);
32 spinlock_t runnablelist_lock = SPINLOCK_INITIALIZER;
33 struct kmem_cache *proc_cache;
34
35 /* Tracks which cores are idle, similar to the vcoremap.  Each value is the
36  * physical coreid of an unallocated core. */
37 spinlock_t idle_lock = SPINLOCK_INITIALIZER;
38 uint32_t LCKD(&idle_lock) (RO idlecoremap)[MAX_NUM_CPUS];
39 uint32_t LCKD(&idle_lock) num_idlecores = 0;
40
41 /* Helper function to return a core to the idlemap.  It causes some more lock
42  * acquisitions (like in a for loop), but it's a little easier.  Plus, one day
43  * we might be able to do this without locks (for the putting). */
44 static void put_idle_core(uint32_t coreid)
45 {
46         spin_lock(&idle_lock);
47         idlecoremap[num_idlecores++] = coreid;
48         spin_unlock(&idle_lock);
49 }
50
51 /* Other helpers, implemented later. */
52 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev);
53 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev);
54 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid);
55 static uint32_t get_vcoreid(struct proc *SAFE p, uint32_t pcoreid);
56
57 /* PID management. */
58 #define PID_MAX 32767 // goes from 0 to 32767, with 0 reserved
59 static DECL_BITMASK(pid_bmask, PID_MAX + 1);
60 spinlock_t pid_bmask_lock = SPINLOCK_INITIALIZER;
61 struct hashtable *pid_hash;
62 spinlock_t pid_hash_lock; // initialized in proc_init
63
64 /* Finds the next free entry (zero) entry in the pid_bitmask.  Set means busy.
65  * PID 0 is reserved (in proc_init).  A return value of 0 is a failure (and
66  * you'll also see a warning, for now).  Consider doing this with atomics. */
67 static pid_t get_free_pid(void)
68 {
69         static pid_t next_free_pid = 1;
70         pid_t my_pid = 0;
71
72         spin_lock(&pid_bmask_lock);
73         // atomically (can lock for now, then change to atomic_and_return
74         FOR_CIRC_BUFFER(next_free_pid, PID_MAX + 1, i) {
75                 // always points to the next to test
76                 next_free_pid = (next_free_pid + 1) % (PID_MAX + 1);
77                 if (!GET_BITMASK_BIT(pid_bmask, i)) {
78                         SET_BITMASK_BIT(pid_bmask, i);
79                         my_pid = i;
80                         break;
81                 }
82         }
83         spin_unlock(&pid_bmask_lock);
84         if (!my_pid)
85                 warn("Shazbot!  Unable to find a PID!  You need to deal with this!\n");
86         return my_pid;
87 }
88
89 /* Return a pid to the pid bitmask */
90 static void put_free_pid(pid_t pid)
91 {
92         spin_lock(&pid_bmask_lock);
93         CLR_BITMASK_BIT(pid_bmask, pid);
94         spin_unlock(&pid_bmask_lock);
95 }
96
97 /* While this could be done with just an assignment, this gives us the
98  * opportunity to check for bad transitions.  Might compile these out later, so
99  * we shouldn't rely on them for sanity checking from userspace.  */
100 int __proc_set_state(struct proc *p, uint32_t state)
101 {
102         uint32_t curstate = p->state;
103         /* Valid transitions:
104          * C   -> RBS
105          * RBS -> RGS
106          * RGS -> RBS
107          * RGS -> W
108          * W   -> RBS
109          * RGS -> RBM
110          * RBM -> RGM
111          * RGM -> RBM
112          * RGM -> RBS
113          * RGS -> D
114          * RGM -> D
115          *
116          * These ought to be implemented later (allowed, not thought through yet).
117          * RBS -> D
118          * RBM -> D
119          *
120          * This isn't allowed yet, should be later.  Is definitely causable.
121          * C   -> D
122          */
123         #if 1 // some sort of correctness flag
124         switch (curstate) {
125                 case PROC_CREATED:
126                         if (state != PROC_RUNNABLE_S)
127                                 panic("Invalid State Transition! PROC_CREATED to %d", state);
128                         break;
129                 case PROC_RUNNABLE_S:
130                         if (!(state & (PROC_RUNNING_S | PROC_DYING)))
131                                 panic("Invalid State Transition! PROC_RUNNABLE_S to %d", state);
132                         break;
133                 case PROC_RUNNING_S:
134                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
135                                        PROC_DYING)))
136                                 panic("Invalid State Transition! PROC_RUNNING_S to %d", state);
137                         break;
138                 case PROC_WAITING:
139                         if (state != PROC_RUNNABLE_S)
140                                 panic("Invalid State Transition! PROC_WAITING to %d", state);
141                         break;
142                 case PROC_DYING:
143                         if (state != PROC_CREATED) // when it is reused (TODO)
144                                 panic("Invalid State Transition! PROC_DYING to %d", state);
145                         break;
146                 case PROC_RUNNABLE_M:
147                         if (!(state & (PROC_RUNNING_M | PROC_DYING)))
148                                 panic("Invalid State Transition! PROC_RUNNABLE_M to %d", state);
149                         break;
150                 case PROC_RUNNING_M:
151                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_DYING)))
152                                 panic("Invalid State Transition! PROC_RUNNING_M to %d", state);
153                         break;
154         }
155         #endif
156         p->state = state;
157         return 0;
158 }
159
160 /* Returns a pointer to the proc with the given pid, or 0 if there is none */
161 struct proc *pid2proc(pid_t pid)
162 {
163         spin_lock(&pid_hash_lock);
164         struct proc *p = hashtable_search(pid_hash, (void*)pid);
165         spin_unlock(&pid_hash_lock);
166         /* if the refcnt was 0, decref and return 0 (we failed). (TODO) */
167         if (p)
168                 proc_incref(p, 1); // TODO:(REF) to do this all atomically and not panic
169         return p;
170 }
171
172 /* Performs any initialization related to processes, such as create the proc
173  * cache, prep the scheduler, etc.  When this returns, we should be ready to use
174  * any process related function. */
175 void proc_init(void)
176 {
177         proc_cache = kmem_cache_create("proc", sizeof(struct proc),
178                      MAX(HW_CACHE_ALIGN, __alignof__(struct proc)), 0, 0, 0);
179         /* Init PID mask and hash.  pid 0 is reserved. */
180         SET_BITMASK_BIT(pid_bmask, 0);
181         spinlock_init(&pid_hash_lock);
182         spin_lock(&pid_hash_lock);
183         pid_hash = create_hashtable(100, __generic_hash, __generic_eq);
184         spin_unlock(&pid_hash_lock);
185         schedule_init();
186         /* Init idle cores. Core 0 is the management core. */
187         spin_lock(&idle_lock);
188         int reserved_cores = 1;
189         #ifdef __CONFIG_NETWORKING__
190         reserved_cores++; // Next core is dedicated to the NIC
191         assert(num_cpus >= reserved_cores);
192         #endif
193         #ifdef __CONFIG_APPSERVER__
194         #ifdef __CONFIG_DEDICATED_MONITOR__
195         reserved_cores++; // Next core dedicated to running the kernel monitor
196         assert(num_cpus >= reserved_cores);
197         // Need to subtract 1 from the reserved_cores # to get the cores index
198         send_kernel_message(reserved_cores-1, (amr_t)monitor, 0,0,0, KMSG_ROUTINE);
199         #endif
200         #endif
201         num_idlecores = num_cpus - reserved_cores;
202         for (int i = 0; i < num_idlecores; i++)
203                 idlecoremap[i] = i + reserved_cores;
204         spin_unlock(&idle_lock);
205         atomic_init(&num_envs, 0);
206 }
207
208 void
209 proc_init_procinfo(struct proc* p)
210 {
211         memset(&p->procinfo->vcoremap, 0, sizeof(p->procinfo->vcoremap));
212         memset(&p->procinfo->pcoremap, 0, sizeof(p->procinfo->pcoremap));
213         p->procinfo->num_vcores = 0;
214         p->procinfo->coremap_seqctr = SEQCTR_INITIALIZER;
215         // TODO: change these too
216         p->procinfo->pid = p->pid;
217         p->procinfo->ppid = p->ppid;
218         p->procinfo->tsc_freq = system_timing.tsc_freq;
219         // TODO: maybe do something smarter here
220         p->procinfo->max_harts = MAX(1,num_cpus-1);
221 }
222
223 /* Allocates and initializes a process, with the given parent.  Currently
224  * writes the *p into **pp, and returns 0 on success, < 0 for an error.
225  * Errors include:
226  *  - ENOFREEPID if it can't get a PID
227  *  - ENOMEM on memory exhaustion */
228 static error_t proc_alloc(struct proc *SAFE*SAFE pp, pid_t parent_id)
229 {
230         error_t r;
231         struct proc *p;
232
233         if (!(p = kmem_cache_alloc(proc_cache, 0)))
234                 return -ENOMEM;
235
236         { INITSTRUCT(*p)
237
238         // Setup the default map of where to get cache colors from
239         p->cache_colors_map = global_cache_colors_map;
240         p->next_cache_color = 0;
241
242         /* Initialize the address space */
243         if ((r = env_setup_vm(p)) < 0) {
244                 kmem_cache_free(proc_cache, p);
245                 return r;
246         }
247
248         /* Get a pid, then store a reference in the pid_hash */
249         if (!(p->pid = get_free_pid())) {
250                 kmem_cache_free(proc_cache, p);
251                 return -ENOFREEPID;
252         }
253         spin_lock(&pid_hash_lock);
254         hashtable_insert(pid_hash, (void*)p->pid, p);
255         spin_unlock(&pid_hash_lock);
256
257         /* Set the basic status variables. */
258         spinlock_init(&p->proc_lock);
259         p->exitcode = 0;
260         p->ppid = parent_id;
261         p->state = PROC_CREATED; // shouldn't go through state machine for init
262         p->env_refcnt = 2; // one for the object, one for the ref we pass back
263         p->env_flags = 0;
264         p->env_entry = 0; // cheating.  this really gets set in load_icode
265         p->procinfo->heap_bottom = (void*)UTEXT;
266         p->heap_top = (void*)UTEXT;
267         memset(&p->resources, 0, sizeof(p->resources));
268         memset(&p->env_ancillary_state, 0, sizeof(p->env_ancillary_state));
269         memset(&p->env_tf, 0, sizeof(p->env_tf));
270
271         /* Initialize the contents of the e->procinfo structure */
272         proc_init_procinfo(p);
273         /* Initialize the contents of the e->procdata structure */
274
275         /* Initialize the generic syscall ring buffer */
276         SHARED_RING_INIT(&p->procdata->syscallring);
277         /* Initialize the backend of the syscall ring buffer */
278         BACK_RING_INIT(&p->syscallbackring,
279                        &p->procdata->syscallring,
280                        SYSCALLRINGSIZE);
281
282         /* Initialize the generic sysevent ring buffer */
283         SHARED_RING_INIT(&p->procdata->syseventring);
284         /* Initialize the frontend of the sysevent ring buffer */
285         FRONT_RING_INIT(&p->syseventfrontring,
286                         &p->procdata->syseventring,
287                         SYSEVENTRINGSIZE);
288         *pp = p;
289         atomic_inc(&num_envs);
290
291         frontend_proc_init(p);
292
293         printd("[%08x] new process %08x\n", current ? current->pid : 0, p->pid);
294         } // INIT_STRUCT
295         return 0;
296 }
297
298 /* Creates a process from the specified binary, which is of size size.
299  * Currently, the binary must be a contiguous block of memory, which needs to
300  * change.  On any failure, it just panics, which ought to be sorted. */
301 struct proc *proc_create(uint8_t *binary, size_t size)
302 {
303         struct proc *p;
304         error_t r;
305         pid_t curid;
306
307         curid = (current ? current->pid : 0);
308         if ((r = proc_alloc(&p, curid)) < 0)
309                 panic("proc_create: %e", r); // one of 3 quaint usages of %e.
310         if(binary != NULL)
311                 env_load_icode(p, NULL, binary, size);
312         return p;
313 }
314
315 /* This is called by proc_decref, once the last reference to the process is
316  * gone.  Don't call this otherwise (it will panic).  It will clean up the
317  * address space and deallocate any other used memory. */
318 static void __proc_free(struct proc *p)
319 {
320         physaddr_t pa;
321
322         printd("[PID %d] freeing proc: %d\n", current ? current->pid : 0, p->pid);
323         // All parts of the kernel should have decref'd before __proc_free is called
324         assert(p->env_refcnt == 0);
325
326         frontend_proc_free(p);
327
328         // Free any colors allocated to this process
329         if(p->cache_colors_map != global_cache_colors_map) {
330                 for(int i=0; i<llc_cache->num_colors; i++)
331                         cache_color_free(llc_cache, p->cache_colors_map);
332                 cache_colors_map_free(p->cache_colors_map);
333         }
334
335         // Flush all mapped pages in the user portion of the address space
336         env_user_mem_free(p, 0, UVPT);
337         /* These need to be free again, since they were allocated with a refcnt. */
338         free_cont_pages(p->procinfo, LOG2_UP(PROCINFO_NUM_PAGES));
339         free_cont_pages(p->procdata, LOG2_UP(PROCDATA_NUM_PAGES));
340
341         env_pagetable_free(p);
342         p->env_pgdir = 0;
343         p->env_cr3 = 0;
344
345         /* Remove self from the pid hash, return PID.  Note the reversed order. */
346         spin_lock(&pid_hash_lock);
347         if (!hashtable_remove(pid_hash, (void*)p->pid))
348                 panic("Proc not in the pid table in %s", __FUNCTION__);
349         spin_unlock(&pid_hash_lock);
350         put_free_pid(p->pid);
351         atomic_dec(&num_envs);
352
353         /* Dealloc the struct proc */
354         kmem_cache_free(proc_cache, p);
355 }
356
357 /* Whether or not actor can control target.  Note we currently don't need
358  * locking for this. TODO: think about that, esp wrt proc's dying. */
359 bool proc_controls(struct proc *actor, struct proc *target)
360 {
361         return ((actor == target) || (target->ppid == actor->pid));
362 }
363
364 /* Dispatches a process to run, either on the current core in the case of a
365  * RUNNABLE_S, or on its partition in the case of a RUNNABLE_M.  This should
366  * never be called to "restart" a core.  This expects that the "instructions"
367  * for which core(s) to run this on will be in the vcoremap, which needs to be
368  * set externally.
369  *
370  * When a process goes from RUNNABLE_M to RUNNING_M, its vcoremap will be
371  * "packed" (no holes in the vcore->pcore mapping), vcore0 will continue to run
372  * it's old core0 context, and the other cores will come in at the entry point.
373  * Including in the case of preemption.
374  *
375  * This won't return if the current core is going to be one of the processes
376  * cores (either for _S mode or for _M if it's in the vcoremap).  proc_run will
377  * eat your reference if it does not return. */
378 void proc_run(struct proc *p)
379 {
380         bool self_ipi_pending = FALSE;
381         spin_lock_irqsave(&p->proc_lock);
382         switch (p->state) {
383                 case (PROC_DYING):
384                         spin_unlock_irqsave(&p->proc_lock);
385                         printk("Process %d not starting due to async death\n", p->pid);
386                         // if we're a worker core, smp_idle, o/w return
387                         if (!management_core())
388                                 smp_idle(); // this never returns
389                         return;
390                 case (PROC_RUNNABLE_S):
391                         assert(current != p);
392                         __proc_set_state(p, PROC_RUNNING_S);
393                         /* We will want to know where this process is running, even if it is
394                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
395                          * Also, this is the signal used in trap.c to know to save the tf in
396                          * env_tf. */
397                         __seq_start_write(&p->procinfo->coremap_seqctr);
398                         p->procinfo->num_vcores = 0;
399                         __map_vcore(p, 0, core_id()); // sort of.  this needs work.
400                         __seq_end_write(&p->procinfo->coremap_seqctr);
401                         p->env_refcnt++; // TODO: (REF) use incref
402                         p->procinfo->vcoremap[0].tf_to_run = &p->env_tf;
403                         send_kernel_message(core_id(), __startcore, p, 0, 0, KMSG_ROUTINE);
404                         __proc_unlock_ipi_pending(p, TRUE);
405                         break;
406                 case (PROC_RUNNABLE_M):
407                         /* vcoremap[i] holds the coreid of the physical core allocated to
408                          * this process.  It is set outside proc_run.  For the kernel
409                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
410                         if (p->procinfo->num_vcores) {
411                                 __proc_set_state(p, PROC_RUNNING_M);
412                                 /* Up the refcnt, since num_vcores are going to start using this
413                                  * process and have it loaded in their 'current'. */
414                                 p->env_refcnt += p->procinfo->num_vcores; // TODO: (REF) use incref
415                                 /* If the core we are running on is in the vcoremap, we will get
416                                  * an IPI (once we reenable interrupts) and never return. */
417                                 if (is_mapped_vcore(p, core_id()))
418                                         self_ipi_pending = TRUE;
419                                 // TODO: handle silly state (HSS)
420                                 // set virtual core 0 to run the main context on transition
421                                 if (p->env_flags & PROC_TRANSITION_TO_M) {
422                                         p->env_flags &= !PROC_TRANSITION_TO_M;
423                                         p->procinfo->vcoremap[0].tf_to_run = &p->env_tf;
424                                 } else {
425                                         assert(!p->procinfo->vcoremap[0].tf_to_run);
426                                 }
427                                 /* others should be zeroed after a previous use too. */
428                                 for (int i = 1; i < p->procinfo->num_vcores; i++)
429                                         assert(!p->procinfo->vcoremap[i].tf_to_run);
430                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
431                                         send_kernel_message(p->procinfo->vcoremap[i].pcoreid,
432                                                             (void *)__startcore, (void *)p, 0, 0,
433                                                             KMSG_ROUTINE);
434                         } else {
435                                 warn("Tried to proc_run() an _M with no vcores!");
436                         }
437                         /* Unlock and decref/wait for the IPI if one is pending.  This will
438                          * eat the reference if we aren't returning. 
439                          *
440                          * There a subtle race avoidance here.  __proc_startcore can handle
441                          * a death message, but we can't have the startcore come after the
442                          * death message.  Otherwise, it would look like a new process.  So
443                          * we hold the lock til after we send our message, which prevents a
444                          * possible death message.
445                          * - Likewise, we need interrupts to be disabled, in case one of the
446                          *   messages was for us, and reenable them after letting go of the
447                          *   lock.  This is done by spin_lock_irqsave, so be careful if you
448                          *   change this.
449                          * - Note there is no guarantee this core's interrupts were on, so
450                          *   it may not get the message for a while... */
451                         __proc_unlock_ipi_pending(p, self_ipi_pending);
452                         break;
453                 default:
454                         spin_unlock_irqsave(&p->proc_lock);
455                         panic("Invalid process state %p in proc_run()!!", p->state);
456         }
457 }
458
459 /* Actually runs the given context (trapframe) of process p on the core this
460  * code executes on.  This is called directly by __startcore, which needs to
461  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
462  * 
463  * A note on refcnting: this function will not return, and your proc reference
464  * will end up stored in current.  This will make no changes to p's refcnt, so
465  * do your accounting such that there is only the +1 for current.  This means if
466  * it is already in current (like in the trap return path), don't up it.  If
467  * it's already in current and you have another reference (like pid2proc or from
468  * an IPI), then down it (which is what happens in __startcore()).  If it's not
469  * in current and you have one reference, like proc_run(non_current_p), then
470  * also do nothing.  The refcnt for your *p will count for the reference stored
471  * in current. */
472 static void __proc_startcore(struct proc *p, trapframe_t *tf)
473 {
474         assert(!irq_is_enabled());
475         /* If the process wasn't here, then we need to load its address space. */
476         if (p != current) {
477                 /* Do not incref here.  We were given the reference to current,
478                  * pre-upped. */
479                 lcr3(p->env_cr3);
480                 /* This is "leaving the process context" of the previous proc.  The
481                  * previous lcr3 unloaded the previous proc's context.  This should
482                  * rarely happen, since we usually proactively leave process context,
483                  * but is the fallback. */
484                 if (current)
485                         proc_decref(current, 1);
486                 set_current_proc(p);
487         }
488         /* need to load our silly state, preferably somewhere other than here so we
489          * can avoid the case where the context was just running here.  it's not
490          * sufficient to do it in the "new process" if-block above (could be things
491          * like page faults that cause us to keep the same process, but want a
492          * different context.
493          * for now, we load this silly state here. (TODO) (HSS)
494          * We also need this to be per trapframe, and not per process...
495          */
496         env_pop_ancillary_state(p);
497         env_pop_tf(tf);
498 }
499
500 /* Restarts the given context (trapframe) of process p on the core this code
501  * executes on.  Calls an internal function to do the work.
502  * 
503  * In case there are pending routine messages, like __death, __preempt, or
504  * __notify, we need to run them.  Alternatively, if there are any, we could
505  * self_ipi, and run the messages immediately after popping back to userspace,
506  * but that would have crappy overhead.
507  *
508  * Refcnting: this will not return, and it assumes that you've accounted for
509  * your reference as if it was the ref for "current" (which is what happens when
510  * returning from local traps and such. */
511 void proc_restartcore(struct proc *p, trapframe_t *tf)
512 {
513         /* Need ints disabled when we return from processing (race) */
514         disable_irq();
515         process_routine_kmsg();
516         __proc_startcore(p, tf);
517 }
518
519 /*
520  * Destroys the given process.  This may be called from another process, a light
521  * kernel thread (no real process context), asynchronously/cross-core, or from
522  * the process on its own core.
523  *
524  * Here's the way process death works:
525  * 0. grab the lock (protects state transition and core map)
526  * 1. set state to dying.  that keeps the kernel from doing anything for the
527  * process (like proc_running it).
528  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
529  * 3. IPI to clean up those cores (decref, etc).
530  * 4. Unlock
531  * 5. Clean up your core, if applicable
532  * (Last core/kernel thread to decref cleans up and deallocates resources.)
533  *
534  * Note that some cores can be processing async calls, but will eventually
535  * decref.  Should think about this more, like some sort of callback/revocation.
536  *
537  * This will eat your reference if it won't return.  Note that this function
538  * needs to change anyways when we make __death more like __preempt.  (TODO) */
539 void proc_destroy(struct proc *p)
540 {
541         bool self_ipi_pending = FALSE;
542         spin_lock_irqsave(&p->proc_lock);
543
544         /* TODO: (DEATH) look at this again when we sort the __death IPI */
545         if (current == p)
546                 self_ipi_pending = TRUE;
547
548         switch (p->state) {
549                 case PROC_DYING: // someone else killed this already.
550                         __proc_unlock_ipi_pending(p, self_ipi_pending);
551                         return;
552                 case PROC_RUNNABLE_M:
553                         /* Need to reclaim any cores this proc might have, even though it's
554                          * not running yet. */
555                         __proc_take_allcores(p, NULL, NULL, NULL, NULL);
556                         // fallthrough
557                 case PROC_RUNNABLE_S:
558                         // Think about other lists, like WAITING, or better ways to do this
559                         deschedule_proc(p);
560                         break;
561                 case PROC_RUNNING_S:
562                         #if 0
563                         // here's how to do it manually
564                         if (current == p) {
565                                 lcr3(boot_cr3);
566                                 proc_decref(p, 1); // this decref is for the cr3
567                                 current = NULL;
568                         }
569                         #endif
570                         send_kernel_message(p->procinfo->vcoremap[0].pcoreid, __death,
571                                            (void *SNT)0, (void *SNT)0, (void *SNT)0,
572                                            KMSG_ROUTINE);
573                         __seq_start_write(&p->procinfo->coremap_seqctr);
574                         // TODO: might need to sort num_vcores too later (VC#)
575                         /* vcore is unmapped on the receive side */
576                         __seq_end_write(&p->procinfo->coremap_seqctr);
577                         #if 0
578                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
579                          * managed by the idlecoremap.  so don't do this yet. */
580                         put_idle_core(p->procinfo->vcoremap[0].pcoreid);
581                         #endif
582                         break;
583                 case PROC_RUNNING_M:
584                         /* Send the DEATH message to every core running this process, and
585                          * deallocate the cores.
586                          * The rule is that the vcoremap is set before proc_run, and reset
587                          * within proc_destroy */
588                         __proc_take_allcores(p, __death, (void *SNT)0, (void *SNT)0,
589                                              (void *SNT)0);
590                         break;
591                 default:
592                         panic("Weird state(%s) in %s()", procstate2str(p->state),
593                               __FUNCTION__);
594         }
595         __proc_set_state(p, PROC_DYING);
596         /* this decref is for the process in general */
597         p->env_refcnt--; // TODO (REF)
598         //proc_decref(p, 1);
599
600         /* Unlock and possible decref and wait.  A death IPI should be on its way,
601          * either from the RUNNING_S one, or from proc_take_cores with a __death.
602          * in general, interrupts should be on when you call proc_destroy locally,
603          * but currently aren't for all things (like traphandlers). */
604         __proc_unlock_ipi_pending(p, self_ipi_pending);
605         return;
606 }
607
608 /* Helper function.  Starting from prev, it will find the next free vcoreid,
609  * which is the next vcore that is not valid.
610  * You better hold the lock before calling this. */
611 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev)
612 {
613         uint32_t i;
614         for (i = prev; i < MAX_NUM_CPUS; i++)
615                 if (!p->procinfo->vcoremap[i].valid)
616                         break;
617         if (i + 1 >= MAX_NUM_CPUS)
618                 warn("At the end of the vcorelist.  Might want to check that out.");
619         return i;
620 }
621
622 /* Helper function.  Starting from prev, it will find the next busy vcoreid,
623  * which is the next vcore that is valid.
624  * You better hold the lock before calling this. */
625 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev)
626 {
627         uint32_t i;
628         for (i = prev; i < MAX_NUM_CPUS; i++)
629                 if (p->procinfo->vcoremap[i].valid)
630                         break;
631         if (i + 1 >= MAX_NUM_CPUS)
632                 warn("At the end of the vcorelist.  Might want to check that out.");
633         return i;
634 }
635
636 /* Helper function.  Is the given pcore a mapped vcore?  Hold the lock before
637  * calling. */
638 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
639 {
640         return p->procinfo->pcoremap[pcoreid].valid;
641 }
642
643 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
644  * You better hold the lock before calling this.  Panics on failure. */
645 static uint32_t get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
646 {
647         assert(is_mapped_vcore(p, pcoreid));
648         return p->procinfo->pcoremap[pcoreid].vcoreid;
649 }
650
651 /* Yields the calling core.  Must be called locally (not async) for now.
652  * - If RUNNING_S, you just give up your time slice and will eventually return.
653  * - If RUNNING_M, you give up the current vcore (which never returns), and
654  *   adjust the amount of cores wanted/granted.
655  * - If you have only one vcore, you switch to RUNNABLE_M.  When you run again,
656  *   you'll have one guaranteed core, starting from the entry point.
657  *
658  * - RES_CORES amt_wanted will be the amount running after taking away the
659  *   yielder, unless there are none left, in which case it will be 1.
660  *
661  * This does not return (abandon_core()), so it will eat your reference.  */
662 void proc_yield(struct proc *SAFE p)
663 {
664         spin_lock_irqsave(&p->proc_lock);
665         switch (p->state) {
666                 case (PROC_RUNNING_S):
667                         p->env_tf= *current_tf;
668                         env_push_ancillary_state(p);
669                         __proc_set_state(p, PROC_RUNNABLE_S);
670                         schedule_proc(p);
671                         break;
672                 case (PROC_RUNNING_M):
673                         __seq_start_write(&p->procinfo->coremap_seqctr);
674                         // give up core
675                         __unmap_vcore(p, get_vcoreid(p, core_id()));
676                         p->resources[RES_CORES].amt_granted = --(p->procinfo->num_vcores);
677                         p->resources[RES_CORES].amt_wanted = p->procinfo->num_vcores;
678                         __seq_end_write(&p->procinfo->coremap_seqctr);
679                         // add to idle list
680                         put_idle_core(core_id());
681                         // last vcore?  then we really want 1, and to yield the gang
682                         if (p->procinfo->num_vcores == 0) {
683                                 // might replace this with m_yield, if we have it directly
684                                 p->resources[RES_CORES].amt_wanted = 1;
685                                 __proc_set_state(p, PROC_RUNNABLE_M);
686                                 schedule_proc(p);
687                         }
688                         break;
689                 default:
690                         // there are races that can lead to this (async death, preempt, etc)
691                         panic("Weird state(%s) in %s()", procstate2str(p->state),
692                               __FUNCTION__);
693         }
694         spin_unlock_irqsave(&p->proc_lock);
695         proc_decref(p, 1);
696         /* Clean up the core and idle.  For mgmt cores, they will ultimately call
697          * manager, which will call schedule() and will repick the yielding proc. */
698         abandon_core();
699 }
700
701 /* If you expect to notify yourself, cleanup state and process_routine_kmsg() */
702 void do_notify(struct proc *p, uint32_t vcoreid, unsigned int notif,
703                struct notif_event *ne)
704 {
705         assert(notif < MAX_NR_NOTIF);
706         if (ne)
707                 assert(notif == ne->ne_type);
708
709         struct notif_method *nm = &p->procdata->notif_methods[notif];
710         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
711
712         /* enqueue notif message or toggle bits */
713         if (ne && nm->flags & NOTIF_MSG) {
714                 if (bcq_enqueue(&vcpd->notif_evts, ne, NR_PERCORE_EVENTS, 4)) {
715                         atomic_inc((atomic_t)&vcpd->event_overflows); // careful here
716                         SET_BITMASK_BIT_ATOMIC(vcpd->notif_bmask, notif);
717                 }
718         } else {
719                 SET_BITMASK_BIT_ATOMIC(vcpd->notif_bmask, notif);
720         }
721
722         /* Active notification */
723         /* TODO: Currently, there is a race for notif_pending, and multiple senders
724          * can send an IPI.  Worst thing is that the process gets interrupted
725          * briefly and the kernel immediately returns back once it realizes notifs
726          * are masked.  To fix it, we'll need atomic_swapb() (right answer), or not
727          * use a bool. (wrong answer). */
728         if (nm->flags & NOTIF_IPI && vcpd->notif_enabled && !vcpd->notif_pending) {
729                 vcpd->notif_pending = TRUE;
730                 spin_lock_irqsave(&p->proc_lock);
731                         if ((p->state & PROC_RUNNING_M) && // TODO: (VC#) (_S state)
732                                       (p->procinfo->vcoremap[vcoreid].valid)) {
733                                 printk("[kernel] sending notif to vcore %d\n", vcoreid);
734                                 send_kernel_message(p->procinfo->vcoremap[vcoreid].pcoreid,
735                                                     __notify, p, 0, 0, KMSG_ROUTINE);
736                         } else { // TODO: think about this, fallback, etc
737                                 warn("Vcore unmapped, not receiving an active notif");
738                         }
739                 spin_unlock_irqsave(&p->proc_lock);
740         }
741 }
742
743 /* Sends notification number notif to proc p.  Meant for generic notifications /
744  * reference implementation.  do_notify does the real work.  This one mostly
745  * just determines where the notif should be sent, other checks, etc.
746  * Specifically, it handles the parameters of notif_methods.  If you happen to
747  * notify yourself, make sure you process routine kmsgs. */
748 void proc_notify(struct proc *p, unsigned int notif, struct notif_event *ne)
749 {
750         assert(notif < MAX_NR_NOTIF); // notifs start at 0
751         struct notif_method *nm = &p->procdata->notif_methods[notif];
752         struct notif_event local_ne;
753         
754         /* Caller can opt to not send an NE, in which case we use the notif */
755         if (!ne) {
756                 ne = &local_ne;
757                 ne->ne_type = notif;
758         }
759
760         if (!(nm->flags & NOTIF_WANTED))
761                 return;
762         do_notify(p, nm->vcoreid, ne->ne_type, ne);
763 }
764
765 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
766  * out). */
767 uint32_t proc_get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
768 {
769         uint32_t vcoreid;
770         // TODO: the code currently doesn't track the vcoreid properly for _S
771         spin_lock_irqsave(&p->proc_lock);
772         switch (p->state) {
773                 case PROC_RUNNING_S:
774                         spin_unlock_irqsave(&p->proc_lock);
775                         return 0; // TODO: here's the ugly part
776                 case PROC_RUNNING_M:
777                         vcoreid = get_vcoreid(p, pcoreid);
778                         spin_unlock_irqsave(&p->proc_lock);
779                         return vcoreid;
780                 default:
781                         spin_unlock_irqsave(&p->proc_lock);
782                         panic("Weird state(%s) in %s()", procstate2str(p->state),
783                               __FUNCTION__);
784         }
785 }
786
787 /* Gives process p the additional num cores listed in pcorelist.  You must be
788  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
789  * startup your new cores at the entry point with their virtual IDs.  If you're
790  * RUNNABLE_M, you should call proc_run after this so that the process can start
791  * to use its cores.
792  *
793  * If you're *_S, make sure your core0's TF is set (which is done when coming in
794  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
795  * Then call proc_run().
796  *
797  * The reason I didn't bring the _S cases from core_request over here is so we
798  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
799  * this is called from another core, and to avoid the need_to_idle business.
800  * The other way would be to have this function have the side effect of changing
801  * state, and finding another way to do the need_to_idle.
802  *
803  * The returned bool signals whether or not a stack-crushing IPI will come in
804  * once you unlock after this function.
805  *
806  * WARNING: You must hold the proc_lock before calling this! */
807 bool __proc_give_cores(struct proc *SAFE p, uint32_t *pcorelist, size_t num)
808 { TRUSTEDBLOCK
809         bool self_ipi_pending = FALSE;
810         uint32_t free_vcoreid = 0;
811         switch (p->state) {
812                 case (PROC_RUNNABLE_S):
813                 case (PROC_RUNNING_S):
814                         panic("Don't give cores to a process in a *_S state!\n");
815                         break;
816                 case (PROC_DYING):
817                         panic("Attempted to give cores to a DYING process.\n");
818                         break;
819                 case (PROC_RUNNABLE_M):
820                         // set up vcoremap.  list should be empty, but could be called
821                         // multiple times before proc_running (someone changed their mind?)
822                         if (p->procinfo->num_vcores) {
823                                 printk("[kernel] Yaaaaaarrrrr!  Giving extra cores, are we?\n");
824                                 // debugging: if we aren't packed, then there's a problem
825                                 // somewhere, like someone forgot to take vcores after
826                                 // preempting.
827                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
828                                         assert(p->procinfo->vcoremap[i].valid);
829                         }
830                         // add new items to the vcoremap
831                         __seq_start_write(&p->procinfo->coremap_seqctr);
832                         for (int i = 0; i < num; i++) {
833                                 // find the next free slot, which should be the next one
834                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
835                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
836                                        pcorelist[i]);
837                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
838                                 p->procinfo->num_vcores++;
839                         }
840                         __seq_end_write(&p->procinfo->coremap_seqctr);
841                         break;
842                 case (PROC_RUNNING_M):
843                         /* Up the refcnt, since num cores are going to start using this
844                          * process and have it loaded in their 'current'. */
845                         // TODO: (REF) use proc_incref once we have atomics
846                         p->env_refcnt += num;
847                         __seq_start_write(&p->procinfo->coremap_seqctr);
848                         for (int i = 0; i < num; i++) {
849                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
850                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
851                                        pcorelist[i]);
852                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
853                                 p->procinfo->num_vcores++;
854                                 /* should be a fresh core */
855                                 assert(!p->procinfo->vcoremap[i].tf_to_run);
856                                 send_kernel_message(pcorelist[i], __startcore, p, 0, 0,
857                                                     KMSG_ROUTINE);
858                                 if (pcorelist[i] == core_id())
859                                         self_ipi_pending = TRUE;
860                         }
861                         __seq_end_write(&p->procinfo->coremap_seqctr);
862                         break;
863                 default:
864                         panic("Weird state(%s) in %s()", procstate2str(p->state),
865                               __FUNCTION__);
866         }
867         return self_ipi_pending;
868 }
869
870 /* Makes process p's coremap look like pcorelist (add, remove, etc).  Caller
871  * needs to know what cores are free after this call (removed, failed, etc).
872  * This info will be returned via corelist and *num.  This will send message to
873  * any cores that are getting removed.
874  *
875  * Before implementing this, we should probably think about when this will be
876  * used.  Implies preempting for the message.  The more that I think about this,
877  * the less I like it.  For now, don't use this, and think hard before
878  * implementing it.
879  *
880  * WARNING: You must hold the proc_lock before calling this! */
881 bool __proc_set_allcores(struct proc *SAFE p, uint32_t *pcorelist,
882                          size_t *num, amr_t message,TV(a0t) arg0,
883                          TV(a1t) arg1, TV(a2t) arg2)
884 {
885         panic("Set all cores not implemented.\n");
886 }
887
888 /* Takes from process p the num cores listed in pcorelist, using the given
889  * message for the kernel message (__death, __preempt, etc).  Like the others
890  * in this function group, bool signals whether or not an IPI is pending.
891  *
892  * WARNING: You must hold the proc_lock before calling this! */
893 bool __proc_take_cores(struct proc *SAFE p, uint32_t *pcorelist,
894                        size_t num, amr_t message, TV(a0t) arg0,
895                        TV(a1t) arg1, TV(a2t) arg2)
896 { TRUSTEDBLOCK
897         uint32_t vcoreid, pcoreid;
898         bool self_ipi_pending = FALSE;
899         switch (p->state) {
900                 case (PROC_RUNNABLE_M):
901                         assert(!message);
902                         break;
903                 case (PROC_RUNNING_M):
904                         assert(message);
905                         break;
906                 default:
907                         panic("Weird state(%s) in %s()", procstate2str(p->state),
908                               __FUNCTION__);
909         }
910         spin_lock(&idle_lock);
911         assert((num <= p->procinfo->num_vcores) &&
912                (num_idlecores + num <= num_cpus));
913         spin_unlock(&idle_lock);
914         __seq_start_write(&p->procinfo->coremap_seqctr);
915         for (int i = 0; i < num; i++) {
916                 vcoreid = get_vcoreid(p, pcorelist[i]);
917                 // while ugly, this is done to facilitate merging with take_all_cores
918                 pcoreid = p->procinfo->vcoremap[vcoreid].pcoreid;
919                 assert(pcoreid == pcorelist[i]);
920                 if (message) {
921                         if (pcoreid == core_id())
922                                 self_ipi_pending = TRUE;
923                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
924                                             KMSG_ROUTINE);
925                 } else {
926                         /* if there was a msg, the vcore is unmapped on the receive side.
927                          * o/w, we need to do it here. */
928                         __unmap_vcore(p, vcoreid);
929                 }
930                 // give the pcore back to the idlecoremap
931                 put_idle_core(pcoreid);
932         }
933         p->procinfo->num_vcores -= num;
934         __seq_end_write(&p->procinfo->coremap_seqctr);
935         p->resources[RES_CORES].amt_granted -= num;
936         return self_ipi_pending;
937 }
938
939 /* Takes all cores from a process, which must be in an _M state.  Cores are
940  * placed back in the idlecoremap.  If there's a message, such as __death or
941  * __preempt, it will be sent to the cores.  The bool signals whether or not an
942  * IPI is coming in once you unlock.
943  *
944  * WARNING: You must hold the proc_lock before calling this! */
945 bool __proc_take_allcores(struct proc *SAFE p, amr_t message,
946                           TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
947 {
948         uint32_t active_vcoreid = 0, pcoreid;
949         bool self_ipi_pending = FALSE;
950         switch (p->state) {
951                 case (PROC_RUNNABLE_M):
952                         assert(!message);
953                         break;
954                 case (PROC_RUNNING_M):
955                         assert(message);
956                         break;
957                 default:
958                         panic("Weird state(%s) in %s()", procstate2str(p->state),
959                               __FUNCTION__);
960         }
961         spin_lock(&idle_lock);
962         assert(num_idlecores + p->procinfo->num_vcores <= num_cpus); // sanity
963         spin_unlock(&idle_lock);
964         __seq_start_write(&p->procinfo->coremap_seqctr);
965         for (int i = 0; i < p->procinfo->num_vcores; i++) {
966                 // find next active vcore
967                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
968                 pcoreid = p->procinfo->vcoremap[active_vcoreid].pcoreid;
969                 if (message) {
970                         if (pcoreid == core_id())
971                                 self_ipi_pending = TRUE;
972                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
973                                             KMSG_ROUTINE);
974                 } else {
975                         /* if there was a msg, the vcore is unmapped on the receive side.
976                          * o/w, we need to do it here. */
977                         __unmap_vcore(p, active_vcoreid);
978                 }
979                 // give the pcore back to the idlecoremap
980                 put_idle_core(pcoreid);
981                 active_vcoreid++; // for the next loop, skip the one we just used
982         }
983         p->procinfo->num_vcores = 0;
984         __seq_end_write(&p->procinfo->coremap_seqctr);
985         p->resources[RES_CORES].amt_granted = 0;
986         return self_ipi_pending;
987 }
988
989 /* Helper, to be used when unlocking after calling the above functions that
990  * might cause an IPI to be sent.  There should already be a kmsg waiting for
991  * us, since when we checked state to see a message was coming, the message had
992  * already been sent before unlocking.  Note we do not need interrupts enabled
993  * for this to work (you can receive a message before its IPI by polling).
994  *
995  * TODO: consider inlining this, so __FUNCTION__ works (will require effort in
996  * core_request(). */
997 void __proc_unlock_ipi_pending(struct proc *p, bool ipi_pending)
998 {
999         if (ipi_pending) {
1000                 p->env_refcnt--; // TODO: (REF) (atomics)
1001                 spin_unlock_irqsave(&p->proc_lock);
1002                 process_routine_kmsg();
1003                 panic("stack-killing kmsg not found in %s!!!", __FUNCTION__);
1004         } else {
1005                 spin_unlock_irqsave(&p->proc_lock);
1006         }
1007 }
1008
1009 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
1010  * calling. */
1011 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
1012 {
1013         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
1014         p->procinfo->vcoremap[vcoreid].valid = TRUE;
1015         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
1016         p->procinfo->pcoremap[pcoreid].valid = TRUE;
1017 }
1018
1019 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
1020  * calling. */
1021 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
1022 {
1023         p->procinfo->vcoremap[vcoreid].valid = FALSE;
1024         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid = FALSE;
1025 }
1026
1027 /* This takes a referenced process and ups the refcnt by count.  If the refcnt
1028  * was already 0, then someone has a bug, so panic.  Check out the Documentation
1029  * for brutal details about refcnting.
1030  *
1031  * Implementation aside, the important thing is that we atomically increment
1032  * only if it wasn't already 0.  If it was 0, panic.
1033  *
1034  * TODO: (REF) change to use CAS / atomics. */
1035 void proc_incref(struct proc *p, size_t count)
1036 {
1037         spin_lock_irqsave(&p->proc_lock);
1038         if (p->env_refcnt)
1039                 p->env_refcnt += count;
1040         else
1041                 panic("Tried to incref a proc with no existing refernces!");
1042         spin_unlock_irqsave(&p->proc_lock);
1043 }
1044
1045 /* When the kernel is done with a process, it decrements its reference count.
1046  * When the count hits 0, no one is using it and it should be freed.  "Last one
1047  * out" actually finalizes the death of the process.  This is tightly coupled
1048  * with the previous function (incref)
1049  *
1050  * TODO: (REF) change to use CAS.  Note that when we do so, we may be holding
1051  * the process lock when calling __proc_free(). */
1052 void proc_decref(struct proc *p, size_t count)
1053 {
1054         spin_lock_irqsave(&p->proc_lock);
1055         p->env_refcnt -= count;
1056         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
1057         spin_unlock_irqsave(&p->proc_lock);
1058         // if we hit 0, no one else will increment and we can check outside the lock
1059         if (!refcnt)
1060                 __proc_free(p);
1061         if (refcnt < 0)
1062                 panic("Too many decrefs!");
1063 }
1064
1065 /* Kernel message handler to start a process's context on this core.  Tightly
1066  * coupled with proc_run().  Interrupts are disabled. */
1067 void __startcore(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1068 {
1069         uint32_t pcoreid = core_id(), vcoreid;
1070         struct proc *p_to_run = (struct proc *CT(1))a0;
1071         struct trapframe local_tf, *tf_to_pop;
1072         struct preempt_data *vcpd;
1073
1074         assert(p_to_run);
1075         vcoreid = get_vcoreid(p_to_run, pcoreid);
1076         tf_to_pop = p_to_run->procinfo->vcoremap[vcoreid].tf_to_run;
1077         printd("[kernel] startcore on physical core %d for process %d's vcore %d\n",
1078                pcoreid, p_to_run->pid, vcoreid);
1079         // TODO: handle silly state (HSS)
1080         if (!tf_to_pop) {
1081                 tf_to_pop = &local_tf;
1082                 memset(tf_to_pop, 0, sizeof(*tf_to_pop));
1083                 proc_init_trapframe(tf_to_pop, vcoreid, p_to_run->env_entry,
1084                                     p_to_run->procdata->stack_pointers[vcoreid]);
1085                 /* Disable/mask active notifications for fresh vcores */
1086                 vcpd = &p_to_run->procdata->vcore_preempt_data[vcoreid];
1087                 vcpd->notif_enabled = FALSE;
1088         } else {
1089                 /* Don't want to accidentally reuse this tf (saves on a for loop in
1090                  * proc_run, though we check there to be safe for now). */
1091                 p_to_run->procinfo->vcoremap[vcoreid].tf_to_run = 0;
1092         }
1093         /* the sender of the amsg increfed, thinking we weren't running current. */
1094         if (p_to_run == current)
1095                 proc_decref(p_to_run, 1);
1096         __proc_startcore(p_to_run, tf_to_pop);
1097 }
1098
1099 /* Bail out if it's the wrong process, or if they no longer want a notif */
1100 // TODO: think about what TF this is: make sure it's the user one, and not a
1101 // kernel one (was it interrupted, or proc_kmsgs())
1102 void __notify(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1103 {
1104         struct user_trapframe local_tf;
1105         struct preempt_data *vcpd;
1106         uint32_t vcoreid;
1107         struct proc *p = (struct proc*)a0;
1108
1109         if (p != current)
1110                 return;
1111         // TODO: think about locking here.  document why we don't need this
1112         vcoreid = p->procinfo->pcoremap[core_id()].vcoreid;
1113         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1114
1115         printd("received active notification for proc %d's vcore %d on pcore %d\n",
1116                p->procinfo->pid, vcoreid, core_id());
1117
1118         /* sort signals.  notifs are now masked, like an interrupt gate */
1119         if (!vcpd->notif_enabled)
1120                 return;
1121         vcpd->notif_enabled = FALSE;
1122         vcpd->notif_pending = FALSE; // no longer pending - it made it here
1123         
1124         /* save the old tf in the notify slot, build and pop a new one.  Note that
1125          * silly state isn't our business for a notification. */        
1126         // TODO: this is assuming the struct user_tf is the same as a regular TF
1127         vcpd->notif_tf = *tf;
1128         memset(&local_tf, 0, sizeof(local_tf));
1129         proc_init_trapframe(&local_tf, vcoreid, p->env_entry,
1130                             p->procdata->stack_pointers[vcoreid]);
1131         __proc_startcore(p, &local_tf);
1132
1133 }
1134
1135 /* Stop running whatever context is on this core, load a known-good cr3, and
1136  * 'idle'.  Note this leaves no trace of what was running. This "leaves the
1137  * process's context. */
1138 void abandon_core(void)
1139 {
1140         if (current)
1141                 __abandon_core();
1142         smp_idle();
1143 }
1144
1145 /* Kernel message handler to clean up the core when a process is dying.
1146  * Note this leaves no trace of what was running.
1147  * It's okay if death comes to a core that's already idling and has no current.
1148  * It could happen if a process decref'd before __proc_startcore could incref. */
1149 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
1150              void *SNT a2)
1151 {
1152         uint32_t coreid = core_id();
1153         if (current) {
1154                 printd("[kernel] death on physical core %d for process %d's vcore %d\n",
1155                        coreid, current->pid, get_vcoreid(current, coreid));
1156                 __unmap_vcore(current, coreid);
1157         }
1158         abandon_core();
1159 }
1160
1161 void print_idlecoremap(void)
1162 {
1163         spin_lock(&idle_lock);
1164         printk("There are %d idle cores.\n", num_idlecores);
1165         for (int i = 0; i < num_idlecores; i++)
1166                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
1167         spin_unlock(&idle_lock);
1168 }
1169
1170 void print_allpids(void)
1171 {
1172         spin_lock(&pid_hash_lock);
1173         if (hashtable_count(pid_hash)) {
1174                 hashtable_itr_t *phtable_i = hashtable_iterator(pid_hash);
1175                 printk("PID      STATE    \n");
1176                 printk("------------------\n");
1177                 do {
1178                         struct proc *p = hashtable_iterator_value(phtable_i);
1179                         printk("%8d %s\n", hashtable_iterator_key(phtable_i),
1180                                p ? procstate2str(p->state) : "(null)");
1181                 } while (hashtable_iterator_advance(phtable_i));
1182         }
1183         spin_unlock(&pid_hash_lock);
1184 }
1185
1186 void print_proc_info(pid_t pid)
1187 {
1188         int j = 0;
1189         struct proc *p = pid2proc(pid);
1190         // not concerned with a race on the state...
1191         if (!p) {
1192                 printk("Bad PID.\n");
1193                 return;
1194         }
1195         spinlock_debug(&p->proc_lock);
1196         spin_lock_irqsave(&p->proc_lock);
1197         printk("struct proc: %p\n", p);
1198         printk("PID: %d\n", p->pid);
1199         printk("PPID: %d\n", p->ppid);
1200         printk("State: 0x%08x\n", p->state);
1201         printk("Refcnt: %d\n", p->env_refcnt - 1); // don't report our ref
1202         printk("Flags: 0x%08x\n", p->env_flags);
1203         printk("CR3(phys): 0x%08x\n", p->env_cr3);
1204         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
1205         printk("Vcoremap:\n");
1206         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1207                 j = get_busy_vcoreid(p, j);
1208                 printk("\tVcore %d: Pcore %d\n", j, p->procinfo->vcoremap[j].pcoreid);
1209                 j++;
1210         }
1211         printk("Resources:\n");
1212         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
1213                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
1214                        p->resources[i].amt_wanted, p->resources[i].amt_granted);
1215         printk("Vcore 0's Last Trapframe:\n");
1216         print_trapframe(&p->env_tf);
1217         spin_unlock_irqsave(&p->proc_lock);
1218         proc_decref(p, 1); /* decref for the pid2proc reference */
1219 }