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