_M procs start up at _start/hart_entry for vcore0
[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                                 /* others should be zeroed after a previous use too. */
421                                 // TODO: remove me
422                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
423                                         assert(!p->procinfo->vcoremap[i].tf_to_run);
424                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
425                                         send_kernel_message(p->procinfo->vcoremap[i].pcoreid,
426                                                             (void *)__startcore, (void *)p, 0, 0,
427                                                             KMSG_ROUTINE);
428                         } else {
429                                 warn("Tried to proc_run() an _M with no vcores!");
430                         }
431                         /* Unlock and decref/wait for the IPI if one is pending.  This will
432                          * eat the reference if we aren't returning. 
433                          *
434                          * There a subtle race avoidance here.  __proc_startcore can handle
435                          * a death message, but we can't have the startcore come after the
436                          * death message.  Otherwise, it would look like a new process.  So
437                          * we hold the lock til after we send our message, which prevents a
438                          * possible death message.
439                          * - Likewise, we need interrupts to be disabled, in case one of the
440                          *   messages was for us, and reenable them after letting go of the
441                          *   lock.  This is done by spin_lock_irqsave, so be careful if you
442                          *   change this.
443                          * - Note there is no guarantee this core's interrupts were on, so
444                          *   it may not get the message for a while... */
445                         __proc_unlock_ipi_pending(p, self_ipi_pending);
446                         break;
447                 default:
448                         spin_unlock_irqsave(&p->proc_lock);
449                         panic("Invalid process state %p in proc_run()!!", p->state);
450         }
451 }
452
453 /* Actually runs the given context (trapframe) of process p on the core this
454  * code executes on.  This is called directly by __startcore, which needs to
455  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
456  * 
457  * A note on refcnting: this function will not return, and your proc reference
458  * will end up stored in current.  This will make no changes to p's refcnt, so
459  * do your accounting such that there is only the +1 for current.  This means if
460  * it is already in current (like in the trap return path), don't up it.  If
461  * it's already in current and you have another reference (like pid2proc or from
462  * an IPI), then down it (which is what happens in __startcore()).  If it's not
463  * in current and you have one reference, like proc_run(non_current_p), then
464  * also do nothing.  The refcnt for your *p will count for the reference stored
465  * in current. */
466 static void __proc_startcore(struct proc *p, trapframe_t *tf)
467 {
468         assert(!irq_is_enabled());
469         /* If the process wasn't here, then we need to load its address space. */
470         if (p != current) {
471                 /* Do not incref here.  We were given the reference to current,
472                  * pre-upped. */
473                 lcr3(p->env_cr3);
474                 /* This is "leaving the process context" of the previous proc.  The
475                  * previous lcr3 unloaded the previous proc's context.  This should
476                  * rarely happen, since we usually proactively leave process context,
477                  * but is the fallback. */
478                 if (current)
479                         proc_decref(current, 1);
480                 set_current_proc(p);
481         }
482         /* need to load our silly state, preferably somewhere other than here so we
483          * can avoid the case where the context was just running here.  it's not
484          * sufficient to do it in the "new process" if-block above (could be things
485          * like page faults that cause us to keep the same process, but want a
486          * different context.
487          * for now, we load this silly state here. (TODO) (HSS)
488          * We also need this to be per trapframe, and not per process...
489          */
490         env_pop_ancillary_state(p);
491         env_pop_tf(tf);
492 }
493
494 /* Restarts the given context (trapframe) of process p on the core this code
495  * executes on.  Calls an internal function to do the work.
496  * 
497  * In case there are pending routine messages, like __death, __preempt, or
498  * __notify, we need to run them.  Alternatively, if there are any, we could
499  * self_ipi, and run the messages immediately after popping back to userspace,
500  * but that would have crappy overhead.
501  *
502  * Refcnting: this will not return, and it assumes that you've accounted for
503  * your reference as if it was the ref for "current" (which is what happens when
504  * returning from local traps and such. */
505 void proc_restartcore(struct proc *p, trapframe_t *tf)
506 {
507         /* Need ints disabled when we return from processing (race) */
508         disable_irq();
509         process_routine_kmsg();
510         __proc_startcore(p, tf);
511 }
512
513 /*
514  * Destroys the given process.  This may be called from another process, a light
515  * kernel thread (no real process context), asynchronously/cross-core, or from
516  * the process on its own core.
517  *
518  * Here's the way process death works:
519  * 0. grab the lock (protects state transition and core map)
520  * 1. set state to dying.  that keeps the kernel from doing anything for the
521  * process (like proc_running it).
522  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
523  * 3. IPI to clean up those cores (decref, etc).
524  * 4. Unlock
525  * 5. Clean up your core, if applicable
526  * (Last core/kernel thread to decref cleans up and deallocates resources.)
527  *
528  * Note that some cores can be processing async calls, but will eventually
529  * decref.  Should think about this more, like some sort of callback/revocation.
530  *
531  * This will eat your reference if it won't return.  Note that this function
532  * needs to change anyways when we make __death more like __preempt.  (TODO) */
533 void proc_destroy(struct proc *p)
534 {
535         bool self_ipi_pending = FALSE;
536         spin_lock_irqsave(&p->proc_lock);
537
538         /* TODO: (DEATH) look at this again when we sort the __death IPI */
539         if (current == p)
540                 self_ipi_pending = TRUE;
541
542         switch (p->state) {
543                 case PROC_DYING: // someone else killed this already.
544                         __proc_unlock_ipi_pending(p, self_ipi_pending);
545                         return;
546                 case PROC_RUNNABLE_M:
547                         /* Need to reclaim any cores this proc might have, even though it's
548                          * not running yet. */
549                         __proc_take_allcores(p, NULL, NULL, NULL, NULL);
550                         // fallthrough
551                 case PROC_RUNNABLE_S:
552                         // Think about other lists, like WAITING, or better ways to do this
553                         deschedule_proc(p);
554                         break;
555                 case PROC_RUNNING_S:
556                         #if 0
557                         // here's how to do it manually
558                         if (current == p) {
559                                 lcr3(boot_cr3);
560                                 proc_decref(p, 1); // this decref is for the cr3
561                                 current = NULL;
562                         }
563                         #endif
564                         send_kernel_message(p->procinfo->vcoremap[0].pcoreid, __death,
565                                            (void *SNT)0, (void *SNT)0, (void *SNT)0,
566                                            KMSG_ROUTINE);
567                         __seq_start_write(&p->procinfo->coremap_seqctr);
568                         // TODO: might need to sort num_vcores too later (VC#)
569                         /* vcore is unmapped on the receive side */
570                         __seq_end_write(&p->procinfo->coremap_seqctr);
571                         #if 0
572                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
573                          * managed by the idlecoremap.  so don't do this yet. */
574                         put_idle_core(p->procinfo->vcoremap[0].pcoreid);
575                         #endif
576                         break;
577                 case PROC_RUNNING_M:
578                         /* Send the DEATH message to every core running this process, and
579                          * deallocate the cores.
580                          * The rule is that the vcoremap is set before proc_run, and reset
581                          * within proc_destroy */
582                         __proc_take_allcores(p, __death, (void *SNT)0, (void *SNT)0,
583                                              (void *SNT)0);
584                         break;
585                 default:
586                         panic("Weird state(%s) in %s()", procstate2str(p->state),
587                               __FUNCTION__);
588         }
589         __proc_set_state(p, PROC_DYING);
590         /* this decref is for the process in general */
591         p->env_refcnt--; // TODO (REF)
592         //proc_decref(p, 1);
593
594         /* Unlock and possible decref and wait.  A death IPI should be on its way,
595          * either from the RUNNING_S one, or from proc_take_cores with a __death.
596          * in general, interrupts should be on when you call proc_destroy locally,
597          * but currently aren't for all things (like traphandlers). */
598         __proc_unlock_ipi_pending(p, self_ipi_pending);
599         return;
600 }
601
602 /* Helper function.  Starting from prev, it will find the next free vcoreid,
603  * which is the next vcore that is not valid.
604  * You better hold the lock before calling this. */
605 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev)
606 {
607         uint32_t i;
608         for (i = prev; i < MAX_NUM_CPUS; i++)
609                 if (!p->procinfo->vcoremap[i].valid)
610                         break;
611         if (i + 1 >= MAX_NUM_CPUS)
612                 warn("At the end of the vcorelist.  Might want to check that out.");
613         return i;
614 }
615
616 /* Helper function.  Starting from prev, it will find the next busy vcoreid,
617  * which is the next vcore that is valid.
618  * You better hold the lock before calling this. */
619 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev)
620 {
621         uint32_t i;
622         for (i = prev; i < MAX_NUM_CPUS; i++)
623                 if (p->procinfo->vcoremap[i].valid)
624                         break;
625         if (i + 1 >= MAX_NUM_CPUS)
626                 warn("At the end of the vcorelist.  Might want to check that out.");
627         return i;
628 }
629
630 /* Helper function.  Is the given pcore a mapped vcore?  Hold the lock before
631  * calling. */
632 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
633 {
634         return p->procinfo->pcoremap[pcoreid].valid;
635 }
636
637 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
638  * You better hold the lock before calling this.  Panics on failure. */
639 static uint32_t get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
640 {
641         assert(is_mapped_vcore(p, pcoreid));
642         return p->procinfo->pcoremap[pcoreid].vcoreid;
643 }
644
645 /* Yields the calling core.  Must be called locally (not async) for now.
646  * - If RUNNING_S, you just give up your time slice and will eventually return.
647  * - If RUNNING_M, you give up the current vcore (which never returns), and
648  *   adjust the amount of cores wanted/granted.
649  * - If you have only one vcore, you switch to RUNNABLE_M.  When you run again,
650  *   you'll have one guaranteed core, starting from the entry point.
651  *
652  * - RES_CORES amt_wanted will be the amount running after taking away the
653  *   yielder, unless there are none left, in which case it will be 1.
654  *
655  * This does not return (abandon_core()), so it will eat your reference.  */
656 void proc_yield(struct proc *SAFE p)
657 {
658         spin_lock_irqsave(&p->proc_lock);
659         switch (p->state) {
660                 case (PROC_RUNNING_S):
661                         p->env_tf= *current_tf;
662                         env_push_ancillary_state(p);
663                         __proc_set_state(p, PROC_RUNNABLE_S);
664                         schedule_proc(p);
665                         break;
666                 case (PROC_RUNNING_M):
667                         __seq_start_write(&p->procinfo->coremap_seqctr);
668                         // give up core
669                         __unmap_vcore(p, get_vcoreid(p, core_id()));
670                         p->resources[RES_CORES].amt_granted = --(p->procinfo->num_vcores);
671                         p->resources[RES_CORES].amt_wanted = p->procinfo->num_vcores;
672                         __seq_end_write(&p->procinfo->coremap_seqctr);
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->procinfo->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(%s) in %s()", procstate2str(p->state),
686                               __FUNCTION__);
687         }
688         spin_unlock_irqsave(&p->proc_lock);
689         proc_decref(p, 1);
690         /* Clean up the core and idle.  For mgmt cores, they will ultimately call
691          * manager, which will call schedule() and will repick the yielding proc. */
692         abandon_core();
693 }
694
695 /* If you expect to notify yourself, cleanup state and process_routine_kmsg() */
696 void do_notify(struct proc *p, uint32_t vcoreid, unsigned int notif,
697                struct notif_event *ne)
698 {
699         assert(notif < MAX_NR_NOTIF);
700         if (ne)
701                 assert(notif == ne->ne_type);
702
703         struct notif_method *nm = &p->procdata->notif_methods[notif];
704         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
705
706         /* enqueue notif message or toggle bits */
707         if (ne && nm->flags & NOTIF_MSG) {
708                 if (bcq_enqueue(&vcpd->notif_evts, ne, NR_PERCORE_EVENTS, 4)) {
709                         atomic_inc((atomic_t)&vcpd->event_overflows); // careful here
710                         SET_BITMASK_BIT_ATOMIC(vcpd->notif_bmask, notif);
711                 }
712         } else {
713                 SET_BITMASK_BIT_ATOMIC(vcpd->notif_bmask, notif);
714         }
715
716         /* Active notification */
717         /* TODO: Currently, there is a race for notif_pending, and multiple senders
718          * can send an IPI.  Worst thing is that the process gets interrupted
719          * briefly and the kernel immediately returns back once it realizes notifs
720          * are masked.  To fix it, we'll need atomic_swapb() (right answer), or not
721          * use a bool. (wrong answer). */
722         if (nm->flags & NOTIF_IPI && vcpd->notif_enabled && !vcpd->notif_pending) {
723                 vcpd->notif_pending = TRUE;
724                 spin_lock_irqsave(&p->proc_lock);
725                         if ((p->state & PROC_RUNNING_M) && // TODO: (VC#) (_S state)
726                                       (p->procinfo->vcoremap[vcoreid].valid)) {
727                                 printk("[kernel] sending notif to vcore %d\n", vcoreid);
728                                 send_kernel_message(p->procinfo->vcoremap[vcoreid].pcoreid,
729                                                     __notify, p, 0, 0, KMSG_ROUTINE);
730                         } else { // TODO: think about this, fallback, etc
731                                 warn("Vcore unmapped, not receiving an active notif");
732                         }
733                 spin_unlock_irqsave(&p->proc_lock);
734         }
735 }
736
737 /* Sends notification number notif to proc p.  Meant for generic notifications /
738  * reference implementation.  do_notify does the real work.  This one mostly
739  * just determines where the notif should be sent, other checks, etc.
740  * Specifically, it handles the parameters of notif_methods.  If you happen to
741  * notify yourself, make sure you process routine kmsgs. */
742 void proc_notify(struct proc *p, unsigned int notif, struct notif_event *ne)
743 {
744         assert(notif < MAX_NR_NOTIF); // notifs start at 0
745         struct notif_method *nm = &p->procdata->notif_methods[notif];
746         struct notif_event local_ne;
747         
748         /* Caller can opt to not send an NE, in which case we use the notif */
749         if (!ne) {
750                 ne = &local_ne;
751                 ne->ne_type = notif;
752         }
753
754         if (!(nm->flags & NOTIF_WANTED))
755                 return;
756         do_notify(p, nm->vcoreid, ne->ne_type, ne);
757 }
758
759 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
760  * out). */
761 uint32_t proc_get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
762 {
763         uint32_t vcoreid;
764         // TODO: the code currently doesn't track the vcoreid properly for _S
765         spin_lock_irqsave(&p->proc_lock);
766         switch (p->state) {
767                 case PROC_RUNNING_S:
768                         spin_unlock_irqsave(&p->proc_lock);
769                         return 0; // TODO: here's the ugly part
770                 case PROC_RUNNING_M:
771                         vcoreid = get_vcoreid(p, pcoreid);
772                         spin_unlock_irqsave(&p->proc_lock);
773                         return vcoreid;
774                 default:
775                         spin_unlock_irqsave(&p->proc_lock);
776                         panic("Weird state(%s) in %s()", procstate2str(p->state),
777                               __FUNCTION__);
778         }
779 }
780
781 /* Gives process p the additional num cores listed in pcorelist.  You must be
782  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
783  * startup your new cores at the entry point with their virtual IDs.  If you're
784  * RUNNABLE_M, you should call proc_run after this so that the process can start
785  * to use its cores.
786  *
787  * If you're *_S, make sure your core0's TF is set (which is done when coming in
788  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
789  * Then call proc_run().
790  *
791  * The reason I didn't bring the _S cases from core_request over here is so we
792  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
793  * this is called from another core, and to avoid the need_to_idle business.
794  * The other way would be to have this function have the side effect of changing
795  * state, and finding another way to do the need_to_idle.
796  *
797  * The returned bool signals whether or not a stack-crushing IPI will come in
798  * once you unlock after this function.
799  *
800  * WARNING: You must hold the proc_lock before calling this! */
801 bool __proc_give_cores(struct proc *SAFE p, uint32_t *pcorelist, size_t num)
802 { TRUSTEDBLOCK
803         bool self_ipi_pending = FALSE;
804         uint32_t free_vcoreid = 0;
805         switch (p->state) {
806                 case (PROC_RUNNABLE_S):
807                 case (PROC_RUNNING_S):
808                         panic("Don't give cores to a process in a *_S state!\n");
809                         break;
810                 case (PROC_DYING):
811                         panic("Attempted to give cores to a DYING process.\n");
812                         break;
813                 case (PROC_RUNNABLE_M):
814                         // set up vcoremap.  list should be empty, but could be called
815                         // multiple times before proc_running (someone changed their mind?)
816                         if (p->procinfo->num_vcores) {
817                                 printk("[kernel] Yaaaaaarrrrr!  Giving extra cores, are we?\n");
818                                 // debugging: if we aren't packed, then there's a problem
819                                 // somewhere, like someone forgot to take vcores after
820                                 // preempting.
821                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
822                                         assert(p->procinfo->vcoremap[i].valid);
823                         }
824                         // add new items to the vcoremap
825                         __seq_start_write(&p->procinfo->coremap_seqctr);
826                         for (int i = 0; i < num; i++) {
827                                 // find the next free slot, which should be the next one
828                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
829                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
830                                        pcorelist[i]);
831                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
832                                 p->procinfo->num_vcores++;
833                         }
834                         __seq_end_write(&p->procinfo->coremap_seqctr);
835                         break;
836                 case (PROC_RUNNING_M):
837                         /* Up the refcnt, since num cores are going to start using this
838                          * process and have it loaded in their 'current'. */
839                         // TODO: (REF) use proc_incref once we have atomics
840                         p->env_refcnt += num;
841                         __seq_start_write(&p->procinfo->coremap_seqctr);
842                         for (int i = 0; i < num; i++) {
843                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
844                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
845                                        pcorelist[i]);
846                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
847                                 p->procinfo->num_vcores++;
848                                 /* should be a fresh core */
849                                 assert(!p->procinfo->vcoremap[i].tf_to_run);
850                                 send_kernel_message(pcorelist[i], __startcore, p, 0, 0,
851                                                     KMSG_ROUTINE);
852                                 if (pcorelist[i] == core_id())
853                                         self_ipi_pending = TRUE;
854                         }
855                         __seq_end_write(&p->procinfo->coremap_seqctr);
856                         break;
857                 default:
858                         panic("Weird state(%s) in %s()", procstate2str(p->state),
859                               __FUNCTION__);
860         }
861         return self_ipi_pending;
862 }
863
864 /* Makes process p's coremap look like pcorelist (add, remove, etc).  Caller
865  * needs to know what cores are free after this call (removed, failed, etc).
866  * This info will be returned via corelist and *num.  This will send message to
867  * any cores that are getting removed.
868  *
869  * Before implementing this, we should probably think about when this will be
870  * used.  Implies preempting for the message.  The more that I think about this,
871  * the less I like it.  For now, don't use this, and think hard before
872  * implementing it.
873  *
874  * WARNING: You must hold the proc_lock before calling this! */
875 bool __proc_set_allcores(struct proc *SAFE p, uint32_t *pcorelist,
876                          size_t *num, amr_t message,TV(a0t) arg0,
877                          TV(a1t) arg1, TV(a2t) arg2)
878 {
879         panic("Set all cores not implemented.\n");
880 }
881
882 /* Takes from process p the num cores listed in pcorelist, using the given
883  * message for the kernel message (__death, __preempt, etc).  Like the others
884  * in this function group, bool signals whether or not an IPI is pending.
885  *
886  * WARNING: You must hold the proc_lock before calling this! */
887 bool __proc_take_cores(struct proc *SAFE p, uint32_t *pcorelist,
888                        size_t num, amr_t message, TV(a0t) arg0,
889                        TV(a1t) arg1, TV(a2t) arg2)
890 { TRUSTEDBLOCK
891         uint32_t vcoreid, pcoreid;
892         bool self_ipi_pending = FALSE;
893         switch (p->state) {
894                 case (PROC_RUNNABLE_M):
895                         assert(!message);
896                         break;
897                 case (PROC_RUNNING_M):
898                         assert(message);
899                         break;
900                 default:
901                         panic("Weird state(%s) in %s()", procstate2str(p->state),
902                               __FUNCTION__);
903         }
904         spin_lock(&idle_lock);
905         assert((num <= p->procinfo->num_vcores) &&
906                (num_idlecores + num <= num_cpus));
907         spin_unlock(&idle_lock);
908         __seq_start_write(&p->procinfo->coremap_seqctr);
909         for (int i = 0; i < num; i++) {
910                 vcoreid = get_vcoreid(p, pcorelist[i]);
911                 // while ugly, this is done to facilitate merging with take_all_cores
912                 pcoreid = p->procinfo->vcoremap[vcoreid].pcoreid;
913                 assert(pcoreid == pcorelist[i]);
914                 if (message) {
915                         if (pcoreid == core_id())
916                                 self_ipi_pending = TRUE;
917                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
918                                             KMSG_ROUTINE);
919                 } else {
920                         /* if there was a msg, the vcore is unmapped on the receive side.
921                          * o/w, we need to do it here. */
922                         __unmap_vcore(p, vcoreid);
923                 }
924                 // give the pcore back to the idlecoremap
925                 put_idle_core(pcoreid);
926         }
927         p->procinfo->num_vcores -= num;
928         __seq_end_write(&p->procinfo->coremap_seqctr);
929         p->resources[RES_CORES].amt_granted -= num;
930         return self_ipi_pending;
931 }
932
933 /* Takes all cores from a process, which must be in an _M state.  Cores are
934  * placed back in the idlecoremap.  If there's a message, such as __death or
935  * __preempt, it will be sent to the cores.  The bool signals whether or not an
936  * IPI is coming in once you unlock.
937  *
938  * WARNING: You must hold the proc_lock before calling this! */
939 bool __proc_take_allcores(struct proc *SAFE p, amr_t message,
940                           TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
941 {
942         uint32_t active_vcoreid = 0, pcoreid;
943         bool self_ipi_pending = FALSE;
944         switch (p->state) {
945                 case (PROC_RUNNABLE_M):
946                         assert(!message);
947                         break;
948                 case (PROC_RUNNING_M):
949                         assert(message);
950                         break;
951                 default:
952                         panic("Weird state(%s) in %s()", procstate2str(p->state),
953                               __FUNCTION__);
954         }
955         spin_lock(&idle_lock);
956         assert(num_idlecores + p->procinfo->num_vcores <= num_cpus); // sanity
957         spin_unlock(&idle_lock);
958         __seq_start_write(&p->procinfo->coremap_seqctr);
959         for (int i = 0; i < p->procinfo->num_vcores; i++) {
960                 // find next active vcore
961                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
962                 pcoreid = p->procinfo->vcoremap[active_vcoreid].pcoreid;
963                 if (message) {
964                         if (pcoreid == core_id())
965                                 self_ipi_pending = TRUE;
966                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
967                                             KMSG_ROUTINE);
968                 } else {
969                         /* if there was a msg, the vcore is unmapped on the receive side.
970                          * o/w, we need to do it here. */
971                         __unmap_vcore(p, active_vcoreid);
972                 }
973                 // give the pcore back to the idlecoremap
974                 put_idle_core(pcoreid);
975                 active_vcoreid++; // for the next loop, skip the one we just used
976         }
977         p->procinfo->num_vcores = 0;
978         __seq_end_write(&p->procinfo->coremap_seqctr);
979         p->resources[RES_CORES].amt_granted = 0;
980         return self_ipi_pending;
981 }
982
983 /* Helper, to be used when unlocking after calling the above functions that
984  * might cause an IPI to be sent.  There should already be a kmsg waiting for
985  * us, since when we checked state to see a message was coming, the message had
986  * already been sent before unlocking.  Note we do not need interrupts enabled
987  * for this to work (you can receive a message before its IPI by polling).
988  *
989  * TODO: consider inlining this, so __FUNCTION__ works (will require effort in
990  * core_request(). */
991 void __proc_unlock_ipi_pending(struct proc *p, bool ipi_pending)
992 {
993         if (ipi_pending) {
994                 p->env_refcnt--; // TODO: (REF) (atomics)
995                 spin_unlock_irqsave(&p->proc_lock);
996                 process_routine_kmsg();
997                 panic("stack-killing kmsg not found in %s!!!", __FUNCTION__);
998         } else {
999                 spin_unlock_irqsave(&p->proc_lock);
1000         }
1001 }
1002
1003 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
1004  * calling. */
1005 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
1006 {
1007         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
1008         p->procinfo->vcoremap[vcoreid].valid = TRUE;
1009         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
1010         p->procinfo->pcoremap[pcoreid].valid = TRUE;
1011 }
1012
1013 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
1014  * calling. */
1015 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
1016 {
1017         p->procinfo->vcoremap[vcoreid].valid = FALSE;
1018         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid = FALSE;
1019 }
1020
1021 /* This takes a referenced process and ups the refcnt by count.  If the refcnt
1022  * was already 0, then someone has a bug, so panic.  Check out the Documentation
1023  * for brutal details about refcnting.
1024  *
1025  * Implementation aside, the important thing is that we atomically increment
1026  * only if it wasn't already 0.  If it was 0, panic.
1027  *
1028  * TODO: (REF) change to use CAS / atomics. */
1029 void proc_incref(struct proc *p, size_t count)
1030 {
1031         spin_lock_irqsave(&p->proc_lock);
1032         if (p->env_refcnt)
1033                 p->env_refcnt += count;
1034         else
1035                 panic("Tried to incref a proc with no existing refernces!");
1036         spin_unlock_irqsave(&p->proc_lock);
1037 }
1038
1039 /* When the kernel is done with a process, it decrements its reference count.
1040  * When the count hits 0, no one is using it and it should be freed.  "Last one
1041  * out" actually finalizes the death of the process.  This is tightly coupled
1042  * with the previous function (incref)
1043  *
1044  * TODO: (REF) change to use CAS.  Note that when we do so, we may be holding
1045  * the process lock when calling __proc_free(). */
1046 void proc_decref(struct proc *p, size_t count)
1047 {
1048         spin_lock_irqsave(&p->proc_lock);
1049         p->env_refcnt -= count;
1050         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
1051         spin_unlock_irqsave(&p->proc_lock);
1052         // if we hit 0, no one else will increment and we can check outside the lock
1053         if (!refcnt)
1054                 __proc_free(p);
1055         if (refcnt < 0)
1056                 panic("Too many decrefs!");
1057 }
1058
1059 /* Kernel message handler to start a process's context on this core.  Tightly
1060  * coupled with proc_run().  Interrupts are disabled. */
1061 void __startcore(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1062 {
1063         uint32_t pcoreid = core_id(), vcoreid;
1064         struct proc *p_to_run = (struct proc *CT(1))a0;
1065         struct trapframe local_tf, *tf_to_pop;
1066         struct preempt_data *vcpd;
1067
1068         assert(p_to_run);
1069         vcoreid = get_vcoreid(p_to_run, pcoreid);
1070         tf_to_pop = p_to_run->procinfo->vcoremap[vcoreid].tf_to_run;
1071         printd("[kernel] startcore on physical core %d for process %d's vcore %d\n",
1072                pcoreid, p_to_run->pid, vcoreid);
1073         // TODO: handle silly state (HSS)
1074         if (!tf_to_pop) {
1075                 tf_to_pop = &local_tf;
1076                 memset(tf_to_pop, 0, sizeof(*tf_to_pop));
1077                 proc_init_trapframe(tf_to_pop, vcoreid, p_to_run->env_entry,
1078                                     p_to_run->procdata->stack_pointers[vcoreid]);
1079                 /* Disable/mask active notifications for fresh vcores */
1080                 vcpd = &p_to_run->procdata->vcore_preempt_data[vcoreid];
1081                 vcpd->notif_enabled = FALSE;
1082         } else {
1083                 /* Don't want to accidentally reuse this tf (saves on a for loop in
1084                  * proc_run, though we check there to be safe for now). */
1085                 p_to_run->procinfo->vcoremap[vcoreid].tf_to_run = 0;
1086         }
1087         /* the sender of the amsg increfed, thinking we weren't running current. */
1088         if (p_to_run == current)
1089                 proc_decref(p_to_run, 1);
1090         __proc_startcore(p_to_run, tf_to_pop);
1091 }
1092
1093 /* Bail out if it's the wrong process, or if they no longer want a notif */
1094 // TODO: think about what TF this is: make sure it's the user one, and not a
1095 // kernel one (was it interrupted, or proc_kmsgs())
1096 void __notify(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1097 {
1098         struct user_trapframe local_tf;
1099         struct preempt_data *vcpd;
1100         uint32_t vcoreid;
1101         struct proc *p = (struct proc*)a0;
1102
1103         if (p != current)
1104                 return;
1105         // TODO: think about locking here.  document why we don't need this
1106         vcoreid = p->procinfo->pcoremap[core_id()].vcoreid;
1107         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1108
1109         printd("received active notification for proc %d's vcore %d on pcore %d\n",
1110                p->procinfo->pid, vcoreid, core_id());
1111
1112         /* sort signals.  notifs are now masked, like an interrupt gate */
1113         if (!vcpd->notif_enabled)
1114                 return;
1115         vcpd->notif_enabled = FALSE;
1116         vcpd->notif_pending = FALSE; // no longer pending - it made it here
1117         
1118         /* save the old tf in the notify slot, build and pop a new one.  Note that
1119          * silly state isn't our business for a notification. */        
1120         // TODO: this is assuming the struct user_tf is the same as a regular TF
1121         vcpd->notif_tf = *tf;
1122         memset(&local_tf, 0, sizeof(local_tf));
1123         proc_init_trapframe(&local_tf, vcoreid, p->env_entry,
1124                             p->procdata->stack_pointers[vcoreid]);
1125         __proc_startcore(p, &local_tf);
1126
1127 }
1128
1129 /* Stop running whatever context is on this core, load a known-good cr3, and
1130  * 'idle'.  Note this leaves no trace of what was running. This "leaves the
1131  * process's context. */
1132 void abandon_core(void)
1133 {
1134         if (current)
1135                 __abandon_core();
1136         smp_idle();
1137 }
1138
1139 /* Kernel message handler to clean up the core when a process is dying.
1140  * Note this leaves no trace of what was running.
1141  * It's okay if death comes to a core that's already idling and has no current.
1142  * It could happen if a process decref'd before __proc_startcore could incref. */
1143 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
1144              void *SNT a2)
1145 {
1146         uint32_t coreid = core_id();
1147         if (current) {
1148                 printd("[kernel] death on physical core %d for process %d's vcore %d\n",
1149                        coreid, current->pid, get_vcoreid(current, coreid));
1150                 __unmap_vcore(current, coreid);
1151         }
1152         abandon_core();
1153 }
1154
1155 void print_idlecoremap(void)
1156 {
1157         spin_lock(&idle_lock);
1158         printk("There are %d idle cores.\n", num_idlecores);
1159         for (int i = 0; i < num_idlecores; i++)
1160                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
1161         spin_unlock(&idle_lock);
1162 }
1163
1164 void print_allpids(void)
1165 {
1166         spin_lock(&pid_hash_lock);
1167         if (hashtable_count(pid_hash)) {
1168                 hashtable_itr_t *phtable_i = hashtable_iterator(pid_hash);
1169                 printk("PID      STATE    \n");
1170                 printk("------------------\n");
1171                 do {
1172                         struct proc *p = hashtable_iterator_value(phtable_i);
1173                         printk("%8d %s\n", hashtable_iterator_key(phtable_i),
1174                                p ? procstate2str(p->state) : "(null)");
1175                 } while (hashtable_iterator_advance(phtable_i));
1176         }
1177         spin_unlock(&pid_hash_lock);
1178 }
1179
1180 void print_proc_info(pid_t pid)
1181 {
1182         int j = 0;
1183         struct proc *p = pid2proc(pid);
1184         // not concerned with a race on the state...
1185         if (!p) {
1186                 printk("Bad PID.\n");
1187                 return;
1188         }
1189         spinlock_debug(&p->proc_lock);
1190         spin_lock_irqsave(&p->proc_lock);
1191         printk("struct proc: %p\n", p);
1192         printk("PID: %d\n", p->pid);
1193         printk("PPID: %d\n", p->ppid);
1194         printk("State: 0x%08x\n", p->state);
1195         printk("Refcnt: %d\n", p->env_refcnt - 1); // don't report our ref
1196         printk("Flags: 0x%08x\n", p->env_flags);
1197         printk("CR3(phys): 0x%08x\n", p->env_cr3);
1198         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
1199         printk("Vcoremap:\n");
1200         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1201                 j = get_busy_vcoreid(p, j);
1202                 printk("\tVcore %d: Pcore %d\n", j, p->procinfo->vcoremap[j].pcoreid);
1203                 j++;
1204         }
1205         printk("Resources:\n");
1206         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
1207                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
1208                        p->resources[i].amt_wanted, p->resources[i].amt_granted);
1209         printk("Vcore 0's Last Trapframe:\n");
1210         print_trapframe(&p->env_tf);
1211         spin_unlock_irqsave(&p->proc_lock);
1212         proc_decref(p, 1); /* decref for the pid2proc reference */
1213 }