Support for preempting and yielding btwn two procs
[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 #include <resource.h>
30
31 /* Process Lists */
32 struct proc_list proc_runnablelist = TAILQ_HEAD_INITIALIZER(proc_runnablelist);
33 spinlock_t runnablelist_lock = SPINLOCK_INITIALIZER;
34 struct kmem_cache *proc_cache;
35
36 /* Tracks which cores are idle, similar to the vcoremap.  Each value is the
37  * physical coreid of an unallocated core. */
38 spinlock_t idle_lock = SPINLOCK_INITIALIZER;
39 uint32_t LCKD(&idle_lock) (RO idlecoremap)[MAX_NUM_CPUS];
40 uint32_t LCKD(&idle_lock) num_idlecores = 0;
41 uint32_t num_mgmtcores = 1;
42
43 /* Helper function to return a core to the idlemap.  It causes some more lock
44  * acquisitions (like in a for loop), but it's a little easier.  Plus, one day
45  * we might be able to do this without locks (for the putting). */
46 void put_idle_core(uint32_t coreid)
47 {
48         spin_lock(&idle_lock);
49 #ifdef __CONFIG_EXPER_TRADPROC__ /* often a good check, but hurts performance */
50         for (int i = 0; i < num_idlecores; i++)
51                 if (idlecoremap[i] == coreid)
52                         warn("Core %d added to the freelist twice!", coreid);
53 #endif /* __CONFIG_EXPER_TRADPROC__ */
54         idlecoremap[num_idlecores++] = coreid;
55         spin_unlock(&idle_lock);
56 }
57
58 /* Other helpers, implemented later. */
59 static void __proc_startcore(struct proc *p, trapframe_t *tf);
60 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev);
61 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev);
62 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid);
63 static uint32_t get_vcoreid(struct proc *SAFE p, uint32_t pcoreid);
64
65 /* PID management. */
66 #define PID_MAX 32767 // goes from 0 to 32767, with 0 reserved
67 static DECL_BITMASK(pid_bmask, PID_MAX + 1);
68 spinlock_t pid_bmask_lock = SPINLOCK_INITIALIZER;
69 struct hashtable *pid_hash;
70 spinlock_t pid_hash_lock; // initialized in proc_init
71
72 /* Finds the next free entry (zero) entry in the pid_bitmask.  Set means busy.
73  * PID 0 is reserved (in proc_init).  A return value of 0 is a failure (and
74  * you'll also see a warning, for now).  Consider doing this with atomics. */
75 static pid_t get_free_pid(void)
76 {
77         static pid_t next_free_pid = 1;
78         pid_t my_pid = 0;
79
80         spin_lock(&pid_bmask_lock);
81         // atomically (can lock for now, then change to atomic_and_return
82         FOR_CIRC_BUFFER(next_free_pid, PID_MAX + 1, i) {
83                 // always points to the next to test
84                 next_free_pid = (next_free_pid + 1) % (PID_MAX + 1);
85                 if (!GET_BITMASK_BIT(pid_bmask, i)) {
86                         SET_BITMASK_BIT(pid_bmask, i);
87                         my_pid = i;
88                         break;
89                 }
90         }
91         spin_unlock(&pid_bmask_lock);
92         if (!my_pid)
93                 warn("Shazbot!  Unable to find a PID!  You need to deal with this!\n");
94         return my_pid;
95 }
96
97 /* Return a pid to the pid bitmask */
98 static void put_free_pid(pid_t pid)
99 {
100         spin_lock(&pid_bmask_lock);
101         CLR_BITMASK_BIT(pid_bmask, pid);
102         spin_unlock(&pid_bmask_lock);
103 }
104
105 /* While this could be done with just an assignment, this gives us the
106  * opportunity to check for bad transitions.  Might compile these out later, so
107  * we shouldn't rely on them for sanity checking from userspace.  */
108 int __proc_set_state(struct proc *p, uint32_t state)
109 {
110         uint32_t curstate = p->state;
111         /* Valid transitions:
112          * C   -> RBS
113          * RBS -> RGS
114          * RGS -> RBS
115          * RGS -> W
116          * W   -> RBS
117          * RGS -> RBM
118          * RBM -> RGM
119          * RGM -> RBM
120          * RGM -> RBS
121          * RGS -> D
122          * RGM -> D
123          *
124          * These ought to be implemented later (allowed, not thought through yet).
125          * RBS -> D
126          * RBM -> D
127          *
128          * This isn't allowed yet, should be later.  Is definitely causable.
129          * C   -> D
130          */
131         #if 1 // some sort of correctness flag
132         switch (curstate) {
133                 case PROC_CREATED:
134                         if (state != PROC_RUNNABLE_S)
135                                 panic("Invalid State Transition! PROC_CREATED to %02x", state);
136                         break;
137                 case PROC_RUNNABLE_S:
138                         if (!(state & (PROC_RUNNING_S | PROC_DYING)))
139                                 panic("Invalid State Transition! PROC_RUNNABLE_S to %02x", state);
140                         break;
141                 case PROC_RUNNING_S:
142                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
143                                        PROC_DYING)))
144                                 panic("Invalid State Transition! PROC_RUNNING_S to %02x", state);
145                         break;
146                 case PROC_WAITING:
147                         if (state != PROC_RUNNABLE_S)
148                                 panic("Invalid State Transition! PROC_WAITING to %02x", state);
149                         break;
150                 case PROC_DYING:
151                         if (state != PROC_CREATED) // when it is reused (TODO)
152                                 panic("Invalid State Transition! PROC_DYING to %02x", state);
153                         break;
154                 case PROC_RUNNABLE_M:
155                         if (!(state & (PROC_RUNNING_M | PROC_DYING)))
156                                 panic("Invalid State Transition! PROC_RUNNABLE_M to %02x", state);
157                         break;
158                 case PROC_RUNNING_M:
159                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_DYING)))
160                                 panic("Invalid State Transition! PROC_RUNNING_M to %02x", state);
161                         break;
162         }
163         #endif
164         p->state = state;
165         return 0;
166 }
167
168 /* Returns a pointer to the proc with the given pid, or 0 if there is none */
169 struct proc *pid2proc(pid_t pid)
170 {
171         spin_lock(&pid_hash_lock);
172         struct proc *p = hashtable_search(pid_hash, (void*)pid);
173         spin_unlock(&pid_hash_lock);
174         /* if the refcnt was 0, decref and return 0 (we failed). (TODO) */
175         if (p)
176                 proc_incref(p, 1); // TODO:(REF) to do this all atomically and not panic
177         return p;
178 }
179
180 /* Performs any initialization related to processes, such as create the proc
181  * cache, prep the scheduler, etc.  When this returns, we should be ready to use
182  * any process related function. */
183 void proc_init(void)
184 {
185         proc_cache = kmem_cache_create("proc", sizeof(struct proc),
186                      MAX(HW_CACHE_ALIGN, __alignof__(struct proc)), 0, 0, 0);
187         /* Init PID mask and hash.  pid 0 is reserved. */
188         SET_BITMASK_BIT(pid_bmask, 0);
189         spinlock_init(&pid_hash_lock);
190         spin_lock(&pid_hash_lock);
191         pid_hash = create_hashtable(100, __generic_hash, __generic_eq);
192         spin_unlock(&pid_hash_lock);
193         schedule_init();
194         /* Init idle cores. Core 0 is the management core. */
195         spin_lock(&idle_lock);
196 #ifdef __CONFIG_DISABLE_SMT__
197         /* assumes core0 is the only management core (NIC and monitor functionality
198          * are run there too.  it just adds the odd cores to the idlecoremap */
199         assert(!(num_cpus % 2));
200         // TODO: consider checking x86 for machines that actually hyperthread
201         num_idlecores = num_cpus >> 1;
202         for (int i = 0; i < num_idlecores; i++)
203                 idlecoremap[i] = (i * 2) + 1;
204 #else
205         #ifdef __CONFIG_NETWORKING__
206         num_mgmtcores++; // Next core is dedicated to the NIC
207         assert(num_cpus >= num_mgmtcores);
208         #endif
209         #ifdef __CONFIG_APPSERVER__
210         #ifdef __CONFIG_DEDICATED_MONITOR__
211         num_mgmtcores++; // Next core dedicated to running the kernel monitor
212         assert(num_cpus >= num_mgmtcores);
213         // Need to subtract 1 from the num_mgmtcores # to get the cores index
214         send_kernel_message(num_mgmtcores-1, (amr_t)monitor, 0,0,0, KMSG_ROUTINE);
215         #endif
216         #endif
217         num_idlecores = num_cpus - num_mgmtcores;
218         for (int i = 0; i < num_idlecores; i++)
219                 idlecoremap[i] = i + num_mgmtcores;
220 #endif /* __CONFIG_DISABLE_SMT__ */
221         spin_unlock(&idle_lock);
222         atomic_init(&num_envs, 0);
223 }
224
225 void
226 proc_init_procinfo(struct proc* p)
227 {
228         memset(&p->procinfo->vcoremap, 0, sizeof(p->procinfo->vcoremap));
229         memset(&p->procinfo->pcoremap, 0, sizeof(p->procinfo->pcoremap));
230         p->procinfo->num_vcores = 0;
231         p->procinfo->coremap_seqctr = SEQCTR_INITIALIZER;
232         // TODO: change these too
233         p->procinfo->pid = p->pid;
234         p->procinfo->ppid = p->ppid;
235         p->procinfo->tsc_freq = system_timing.tsc_freq;
236         // TODO: maybe do something smarter here
237 #ifdef __CONFIG_DISABLE_SMT__
238         p->procinfo->max_vcores = num_cpus >> 1;
239 #else
240         p->procinfo->max_vcores = MAX(1,num_cpus-num_mgmtcores);
241 #endif /* __CONFIG_DISABLE_SMT__ */
242 }
243
244 #ifdef __CONFIG_EXPER_TRADPROC__
245 bool is_real_proc(struct proc *p)
246 {
247         // the real proc has no true proc pointer
248         return !p->true_proc;
249 }
250
251 /* Make a _S process to represent a vcore in a traditional threading/scheduling
252  * model.  Should be able to proc_run this once it's done.  Hold the parent's
253  * lock when you call this. */
254 int fake_proc_alloc(struct proc **pp, struct proc *parent, uint32_t vcoreid)
255 {
256         error_t r;
257         struct proc *p;
258
259         /* So we can call this anytime we want to run a vcore, including vcore0,
260          * which is the true_proc / parent.  Probably horribly broken. */
261         if (!vcoreid) {
262                 *pp = parent;
263                 return 0;
264         }
265
266         if (!(p = kmem_cache_alloc(proc_cache, 0)))
267                 return -ENOMEM;
268
269         spinlock_init(&p->proc_lock);
270         p->pid = parent->pid;
271         p->ppid = parent->ppid;
272         p->exitcode = 0;
273         p->state = PROC_RUNNING_M;
274         p->env_refcnt = 2;
275         p->env_entry = parent->env_entry;
276         p->cache_colors_map = parent->cache_colors_map;
277         p->next_cache_color = parent->next_cache_color;
278         p->heap_top = (void*)0xdeadbeef; // shouldn't use this.  poisoning.
279         p->env_pgdir = parent->env_pgdir;
280         p->env_cr3 = parent->env_cr3;
281         p->procinfo = parent->procinfo;
282         p->procdata = parent->procdata;
283         /* Don't use ARSCs, they aren't turned on */
284         // p->syscallbackring = not happening
285         p->true_proc = parent;
286         p->vcoreid = vcoreid;
287         /* map us to the true parent vcoremap */
288         assert(!parent->vcore_procs[vcoreid]);
289         parent->vcore_procs[vcoreid] = p;
290         parent->env_refcnt++;
291
292         memset(&p->env_ancillary_state, 0, sizeof(p->env_ancillary_state));
293         /* env_tf is 0'd in init_trapframe */
294         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
295         proc_init_trapframe(&p->env_tf, vcoreid, p->env_entry,
296                             vcpd->transition_stack);
297
298         *pp = p;
299         atomic_inc(&num_envs);
300
301         printd("[%08x] fake process %08x\n", current ? current->pid : 0, p->pid);
302         return 0;
303 }
304 #endif /* __CONFIG_EXPER_TRADPROC__ */
305
306 /* Allocates and initializes a process, with the given parent.  Currently
307  * writes the *p into **pp, and returns 0 on success, < 0 for an error.
308  * Errors include:
309  *  - ENOFREEPID if it can't get a PID
310  *  - ENOMEM on memory exhaustion */
311 static error_t proc_alloc(struct proc *SAFE*SAFE pp, pid_t parent_id)
312 {
313         error_t r;
314         struct proc *p;
315
316         if (!(p = kmem_cache_alloc(proc_cache, 0)))
317                 return -ENOMEM;
318
319         { INITSTRUCT(*p)
320
321         // Setup the default map of where to get cache colors from
322         p->cache_colors_map = global_cache_colors_map;
323         p->next_cache_color = 0;
324
325         /* Initialize the address space */
326         if ((r = env_setup_vm(p)) < 0) {
327                 kmem_cache_free(proc_cache, p);
328                 return r;
329         }
330
331         /* Get a pid, then store a reference in the pid_hash */
332         if (!(p->pid = get_free_pid())) {
333                 kmem_cache_free(proc_cache, p);
334                 return -ENOFREEPID;
335         }
336         spin_lock(&pid_hash_lock);
337         hashtable_insert(pid_hash, (void*)p->pid, p);
338         spin_unlock(&pid_hash_lock);
339
340         /* Set the basic status variables. */
341         spinlock_init(&p->proc_lock);
342         p->exitcode = 0;
343         p->ppid = parent_id;
344         p->state = PROC_CREATED; // shouldn't go through state machine for init
345         p->env_refcnt = 2; // one for the object, one for the ref we pass back
346         p->env_flags = 0;
347         p->env_entry = 0; // cheating.  this really gets set in load_icode
348         p->procinfo->heap_bottom = (void*)UTEXT;
349         p->heap_top = (void*)UTEXT;
350         memset(&p->resources, 0, sizeof(p->resources));
351         memset(&p->env_ancillary_state, 0, sizeof(p->env_ancillary_state));
352         memset(&p->env_tf, 0, sizeof(p->env_tf));
353
354         /* Initialize the contents of the e->procinfo structure */
355         proc_init_procinfo(p);
356         /* Initialize the contents of the e->procdata structure */
357
358         /* Initialize the generic syscall ring buffer */
359         SHARED_RING_INIT(&p->procdata->syscallring);
360         /* Initialize the backend of the syscall ring buffer */
361         BACK_RING_INIT(&p->syscallbackring,
362                        &p->procdata->syscallring,
363                        SYSCALLRINGSIZE);
364
365         /* Initialize the generic sysevent ring buffer */
366         SHARED_RING_INIT(&p->procdata->syseventring);
367         /* Initialize the frontend of the sysevent ring buffer */
368         FRONT_RING_INIT(&p->syseventfrontring,
369                         &p->procdata->syseventring,
370                         SYSEVENTRINGSIZE);
371         *pp = p;
372         atomic_inc(&num_envs);
373
374 #ifdef __CONFIG_EXPER_TRADPROC__
375         p->true_proc = 0;
376         p->vcoreid = 0;
377         memset(p->vcore_procs, 0, sizeof(p->vcore_procs));
378 #endif /* __CONFIG_EXPER_TRADPROC__ */
379
380         frontend_proc_init(p);
381
382         printd("[%08x] new process %08x\n", current ? current->pid : 0, p->pid);
383         } // INIT_STRUCT
384         return 0;
385 }
386
387 /* Creates a process from the specified binary, which is of size size.
388  * Currently, the binary must be a contiguous block of memory, which needs to
389  * change.  On any failure, it just panics, which ought to be sorted. */
390 struct proc *proc_create(uint8_t *binary, size_t size)
391 {
392         struct proc *p;
393         error_t r;
394         pid_t curid;
395
396         curid = (current ? current->pid : 0);
397         if ((r = proc_alloc(&p, curid)) < 0)
398                 panic("proc_create: %e", r); // one of 3 quaint usages of %e.
399         if(binary != NULL)
400                 env_load_icode(p, NULL, binary, size);
401         return p;
402 }
403
404 /* This is called by proc_decref, once the last reference to the process is
405  * gone.  Don't call this otherwise (it will panic).  It will clean up the
406  * address space and deallocate any other used memory. */
407 static void __proc_free(struct proc *p)
408 {
409         physaddr_t pa;
410
411         printd("[PID %d] freeing proc: %d\n", current ? current->pid : 0, p->pid);
412         // All parts of the kernel should have decref'd before __proc_free is called
413         assert(p->env_refcnt == 0);
414
415 #ifdef __CONFIG_EXPER_TRADPROC__
416         if (!is_real_proc(p)) {
417                 printd("Fake proc on core %d unmapping from parent\n", core_id());
418                 p->true_proc->vcore_procs[p->vcoreid] = 0; /* unmap self */
419                 proc_decref(p->true_proc, 1); // might deadlock
420                 kmem_cache_free(proc_cache, p);
421                 return;
422         } else {
423                 /* make sure the kids are dead before spinning */
424                 if (current && !is_real_proc(current)) {
425                         __abandon_core();
426                 }
427                 /* spin til my peeps are dead */
428                 for (int i = 0; i < MAX_NUM_CPUS; i++) {
429                         for (int j = 0; p->vcore_procs[i]; j++) {
430                                 cpu_relax();
431                                 if (j == 10000) {
432                                         printd("Core %d stalled while waiting on peep %d\n",
433                                                core_id(), i);
434                                         //send_kernel_message(p->procinfo->vcoremap[i].pcoreid,
435                                         //                    __death, 0, 0, 0, KMSG_ROUTINE);
436                                 }
437                         }
438                 }
439         }
440         assert(is_real_proc(p));
441         printd("Core %d really trying to free proc %d (%p)\n", core_id(), p->pid, p);
442 #endif /* __CONFIG_EXPER_TRADPROC__ */
443
444         frontend_proc_free(p);
445
446         // Free any colors allocated to this process
447         if(p->cache_colors_map != global_cache_colors_map) {
448                 for(int i=0; i<llc_cache->num_colors; i++)
449                         cache_color_free(llc_cache, p->cache_colors_map);
450                 cache_colors_map_free(p->cache_colors_map);
451         }
452
453         // Flush all mapped pages in the user portion of the address space
454         env_user_mem_free(p, 0, UVPT);
455         /* These need to be free again, since they were allocated with a refcnt. */
456         free_cont_pages(p->procinfo, LOG2_UP(PROCINFO_NUM_PAGES));
457         free_cont_pages(p->procdata, LOG2_UP(PROCDATA_NUM_PAGES));
458
459         env_pagetable_free(p);
460         p->env_pgdir = 0;
461         p->env_cr3 = 0;
462
463         /* Remove self from the pid hash, return PID.  Note the reversed order. */
464         spin_lock(&pid_hash_lock);
465         if (!hashtable_remove(pid_hash, (void*)p->pid))
466                 panic("Proc not in the pid table in %s", __FUNCTION__);
467         spin_unlock(&pid_hash_lock);
468         put_free_pid(p->pid);
469         atomic_dec(&num_envs);
470
471         /* Dealloc the struct proc */
472         kmem_cache_free(proc_cache, p);
473 }
474
475 /* Whether or not actor can control target.  Note we currently don't need
476  * locking for this. TODO: think about that, esp wrt proc's dying. */
477 bool proc_controls(struct proc *actor, struct proc *target)
478 {
479         return ((actor == target) || (target->ppid == actor->pid));
480 }
481
482 /* Dispatches a process to run, either on the current core in the case of a
483  * RUNNABLE_S, or on its partition in the case of a RUNNABLE_M.  This should
484  * never be called to "restart" a core.  This expects that the "instructions"
485  * for which core(s) to run this on will be in the vcoremap, which needs to be
486  * set externally.
487  *
488  * When a process goes from RUNNABLE_M to RUNNING_M, its vcoremap will be
489  * "packed" (no holes in the vcore->pcore mapping), vcore0 will continue to run
490  * it's old core0 context, and the other cores will come in at the entry point.
491  * Including in the case of preemption.
492  *
493  * This won't return if the current core is going to be one of the processes
494  * cores (either for _S mode or for _M if it's in the vcoremap).  proc_run will
495  * eat your reference if it does not return. */
496 void proc_run(struct proc *p)
497 {
498         bool self_ipi_pending = FALSE;
499         spin_lock(&p->proc_lock);
500
501 #ifdef __CONFIG_EXPER_TRADPROC__
502         /* this filth is so the state won't affect how it's run.  whenever we call
503          * proc_run, we think we are RUNNABLE_S.  prob issues with DYING. */
504         switch (p->state) {
505                 case (PROC_DYING):
506                         spin_unlock(&p->proc_lock);
507                         printk("Process %d not starting due to async death\n", p->pid);
508                         if (!management_core())
509                                 smp_idle(); // this never returns
510                         return;
511                 case (PROC_RUNNABLE_S):
512                         assert(current != p);
513                         __proc_set_state(p, PROC_RUNNING_S);
514                         __seq_start_write(&p->procinfo->coremap_seqctr);
515                         p->procinfo->num_vcores = 0;
516                         __map_vcore(p, p->vcoreid, core_id());
517                         __seq_end_write(&p->procinfo->coremap_seqctr);
518                         // fallthru
519                 case (PROC_RUNNING_M):
520                         if (p == current)
521                                 p->env_refcnt--; // TODO: (REF) use incref
522                         spin_unlock(&p->proc_lock);
523                         // TODO: HSS!!
524                         // restore fp state from the preempt slot?
525                         disable_irq();
526                         __proc_startcore(p, &p->env_tf);
527                         break;
528                 default:
529                         panic("Weird state(%s) in %s()", procstate2str(p->state),
530                               __FUNCTION__);
531         }
532         return;
533 #endif /* __CONFIG_EXPER_TRADPROC__ */
534
535         switch (p->state) {
536                 case (PROC_DYING):
537                         spin_unlock(&p->proc_lock);
538                         printk("Process %d not starting due to async death\n", p->pid);
539                         // if we're a worker core, smp_idle, o/w return
540                         if (!management_core())
541                                 smp_idle(); // this never returns
542                         return;
543                 case (PROC_RUNNABLE_S):
544                         assert(current != p);
545                         __proc_set_state(p, PROC_RUNNING_S);
546                         /* We will want to know where this process is running, even if it is
547                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
548                          * Also, this is the signal used in trap.c to know to save the tf in
549                          * env_tf. */
550                         __seq_start_write(&p->procinfo->coremap_seqctr);
551                         p->procinfo->num_vcores = 0;
552                         __map_vcore(p, 0, core_id()); // sort of.  this needs work.
553                         __seq_end_write(&p->procinfo->coremap_seqctr);
554                         /* __proc_startcore assumes the reference we give it is for current.
555                          * Decref if current is already properly set. */
556                         if (p == current)
557                                 p->env_refcnt--; // TODO: (REF) use incref
558                         /* We don't want to process routine messages here, since it's a bit
559                          * different than when we perform a syscall in this process's
560                          * context.  We want interrupts disabled so that if there was a
561                          * routine message on the way, we'll get the interrupt once we pop
562                          * back to userspace.  */
563                         spin_unlock(&p->proc_lock);
564                         disable_irq();
565                         __proc_startcore(p, &p->env_tf);
566                         break;
567                 case (PROC_RUNNABLE_M):
568                         /* vcoremap[i] holds the coreid of the physical core allocated to
569                          * this process.  It is set outside proc_run.  For the kernel
570                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
571                         if (p->procinfo->num_vcores) {
572                                 __proc_set_state(p, PROC_RUNNING_M);
573                                 /* Up the refcnt, since num_vcores are going to start using this
574                                  * process and have it loaded in their 'current'. */
575                                 p->env_refcnt += p->procinfo->num_vcores; // TODO: (REF) use incref
576                                 /* If the core we are running on is in the vcoremap, we will get
577                                  * an IPI (once we reenable interrupts) and never return. */
578                                 if (is_mapped_vcore(p, core_id()))
579                                         self_ipi_pending = TRUE;
580                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
581                                         send_kernel_message(p->procinfo->vcoremap[i].pcoreid,
582                                                             (void *)__startcore, (void *)p, 0, 0,
583                                                             KMSG_ROUTINE);
584                         } else {
585                                 warn("Tried to proc_run() an _M with no vcores!");
586                         }
587                         /* Unlock and decref/wait for the IPI if one is pending.  This will
588                          * eat the reference if we aren't returning.
589                          *
590                          * There a subtle race avoidance here.  __proc_startcore can handle
591                          * a death message, but we can't have the startcore come after the
592                          * death message.  Otherwise, it would look like a new process.  So
593                          * we hold the lock til after we send our message, which prevents a
594                          * possible death message.
595                          * - Note there is no guarantee this core's interrupts were on, so
596                          *   it may not get the message for a while... */
597                         spin_unlock(&p->proc_lock);
598                         __proc_kmsg_pending(p, self_ipi_pending);
599                         break;
600                 default:
601                         spin_unlock(&p->proc_lock);
602                         panic("Invalid process state %p in proc_run()!!", p->state);
603         }
604 }
605
606 /* Actually runs the given context (trapframe) of process p on the core this
607  * code executes on.  This is called directly by __startcore, which needs to
608  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
609  *
610  * A note on refcnting: this function will not return, and your proc reference
611  * will end up stored in current.  This will make no changes to p's refcnt, so
612  * do your accounting such that there is only the +1 for current.  This means if
613  * it is already in current (like in the trap return path), don't up it.  If
614  * it's already in current and you have another reference (like pid2proc or from
615  * an IPI), then down it (which is what happens in __startcore()).  If it's not
616  * in current and you have one reference, like proc_run(non_current_p), then
617  * also do nothing.  The refcnt for your *p will count for the reference stored
618  * in current. */
619 static void __proc_startcore(struct proc *p, trapframe_t *tf)
620 {
621         assert(!irq_is_enabled());
622         /* If the process wasn't here, then we need to load its address space. */
623         if (p != current) {
624                 /* Do not incref here.  We were given the reference to current,
625                  * pre-upped. */
626                 lcr3(p->env_cr3);
627                 /* This is "leaving the process context" of the previous proc.  The
628                  * previous lcr3 unloaded the previous proc's context.  This should
629                  * rarely happen, since we usually proactively leave process context,
630                  * but is the fallback. */
631                 if (current)
632                         proc_decref(current, 1);
633                 set_current_proc(p);
634         }
635         /* need to load our silly state, preferably somewhere other than here so we
636          * can avoid the case where the context was just running here.  it's not
637          * sufficient to do it in the "new process" if-block above (could be things
638          * like page faults that cause us to keep the same process, but want a
639          * different context.
640          * for now, we load this silly state here. (TODO) (HSS)
641          * We also need this to be per trapframe, and not per process...
642          */
643         env_pop_ancillary_state(p);
644         env_pop_tf(tf);
645 }
646
647 /* Restarts the given context (trapframe) of process p on the core this code
648  * executes on.  Calls an internal function to do the work.
649  *
650  * In case there are pending routine messages, like __death, __preempt, or
651  * __notify, we need to run them.  Alternatively, if there are any, we could
652  * self_ipi, and run the messages immediately after popping back to userspace,
653  * but that would have crappy overhead.
654  *
655  * Refcnting: this will not return, and it assumes that you've accounted for
656  * your reference as if it was the ref for "current" (which is what happens when
657  * returning from local traps and such. */
658 void proc_restartcore(struct proc *p, trapframe_t *tf)
659 {
660         /* Need ints disabled when we return from processing (race) */
661         disable_irq();
662         process_routine_kmsg();
663         __proc_startcore(p, tf);
664 }
665
666 /*
667  * Destroys the given process.  This may be called from another process, a light
668  * kernel thread (no real process context), asynchronously/cross-core, or from
669  * the process on its own core.
670  *
671  * Here's the way process death works:
672  * 0. grab the lock (protects state transition and core map)
673  * 1. set state to dying.  that keeps the kernel from doing anything for the
674  * process (like proc_running it).
675  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
676  * 3. IPI to clean up those cores (decref, etc).
677  * 4. Unlock
678  * 5. Clean up your core, if applicable
679  * (Last core/kernel thread to decref cleans up and deallocates resources.)
680  *
681  * Note that some cores can be processing async calls, but will eventually
682  * decref.  Should think about this more, like some sort of callback/revocation.
683  *
684  * This will eat your reference if it won't return.  Note that this function
685  * needs to change anyways when we make __death more like __preempt.  (TODO) */
686 void proc_destroy(struct proc *p)
687 {
688         bool self_ipi_pending = FALSE;
689
690 #ifdef __CONFIG_EXPER_TRADPROC__
691         /* in case a fake proc tries to kill themselves directly */
692         if (!is_real_proc(p)) {
693                 printd("Trying to destroy a fake proc, will kill true proc\n");
694                 proc_destroy(p->true_proc);
695                 return;
696         }
697 #endif /* __CONFIG_EXPER_TRADPROC__ */
698
699         spin_lock(&p->proc_lock);
700
701         /* TODO: (DEATH) look at this again when we sort the __death IPI */
702 #ifdef __CONFIG_EXPER_TRADPROC__
703         if ((current == p) || (current && (current->true_proc == p)))
704 #else
705         if (current == p)
706 #endif /* __CONFIG_EXPER_TRADPROC__ */
707                 self_ipi_pending = TRUE;
708
709         switch (p->state) {
710                 case PROC_DYING: // someone else killed this already.
711                         spin_unlock(&p->proc_lock);
712                         __proc_kmsg_pending(p, self_ipi_pending);
713                         return;
714                 case PROC_RUNNABLE_M:
715                         /* Need to reclaim any cores this proc might have, even though it's
716                          * not running yet. */
717                         __proc_take_allcores(p, NULL, NULL, NULL, NULL);
718                         // fallthrough
719                 case PROC_RUNNABLE_S:
720                         // Think about other lists, like WAITING, or better ways to do this
721                         deschedule_proc(p);
722                         break;
723                 case PROC_RUNNING_S:
724                         #if 0
725                         // here's how to do it manually
726                         if (current == p) {
727                                 lcr3(boot_cr3);
728                                 proc_decref(p, 1); // this decref is for the cr3
729                                 current = NULL;
730                         }
731                         #endif
732                         send_kernel_message(p->procinfo->vcoremap[0].pcoreid, __death,
733                                            (void *SNT)0, (void *SNT)0, (void *SNT)0,
734                                            KMSG_ROUTINE);
735                         __seq_start_write(&p->procinfo->coremap_seqctr);
736                         // TODO: might need to sort num_vcores too later (VC#)
737                         /* vcore is unmapped on the receive side */
738                         __seq_end_write(&p->procinfo->coremap_seqctr);
739                         #if 0
740                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
741                          * managed by the idlecoremap.  so don't do this yet. */
742                         put_idle_core(p->procinfo->vcoremap[0].pcoreid);
743                         #endif
744                         break;
745                 case PROC_RUNNING_M:
746                         /* Send the DEATH message to every core running this process, and
747                          * deallocate the cores.
748                          * The rule is that the vcoremap is set before proc_run, and reset
749                          * within proc_destroy */
750                         __proc_take_allcores(p, __death, (void *SNT)0, (void *SNT)0,
751                                              (void *SNT)0);
752                         break;
753                 default:
754                         panic("Weird state(%s) in %s()", procstate2str(p->state),
755                               __FUNCTION__);
756         }
757         __proc_set_state(p, PROC_DYING);
758         /* this decref is for the process in general */
759         p->env_refcnt--; // TODO (REF)
760         //proc_decref(p, 1);
761
762         /* Unlock and possible decref and wait.  A death IPI should be on its way,
763          * either from the RUNNING_S one, or from proc_take_cores with a __death.
764          * in general, interrupts should be on when you call proc_destroy locally,
765          * but currently aren't for all things (like traphandlers). */
766         spin_unlock(&p->proc_lock);
767         __proc_kmsg_pending(p, self_ipi_pending);
768         return;
769 }
770
771 /* Helper function.  Starting from prev, it will find the next free vcoreid,
772  * which is the next vcore that is not valid.
773  * You better hold the lock before calling this. */
774 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev)
775 {
776         uint32_t i;
777         for (i = prev; i < MAX_NUM_CPUS; i++)
778                 if (!p->procinfo->vcoremap[i].valid)
779                         break;
780         if (i + 1 >= MAX_NUM_CPUS)
781                 warn("At the end of the vcorelist.  Might want to check that out.");
782         return i;
783 }
784
785 /* Helper function.  Starting from prev, it will find the next busy vcoreid,
786  * which is the next vcore that is valid.
787  * You better hold the lock before calling this. */
788 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev)
789 {
790         uint32_t i;
791         for (i = prev; i < MAX_NUM_CPUS; i++)
792                 if (p->procinfo->vcoremap[i].valid)
793                         break;
794         if (i + 1 >= MAX_NUM_CPUS)
795                 warn("At the end of the vcorelist.  Might want to check that out.");
796         return i;
797 }
798
799 /* Helper function.  Is the given pcore a mapped vcore?  Hold the lock before
800  * calling. */
801 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
802 {
803         return p->procinfo->pcoremap[pcoreid].valid;
804 }
805
806 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
807  * You better hold the lock before calling this.  Panics on failure. */
808 static uint32_t get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
809 {
810         assert(is_mapped_vcore(p, pcoreid));
811         return p->procinfo->pcoremap[pcoreid].vcoreid;
812 }
813
814 /* Yields the calling core.  Must be called locally (not async) for now.
815  * - If RUNNING_S, you just give up your time slice and will eventually return.
816  * - If RUNNING_M, you give up the current vcore (which never returns), and
817  *   adjust the amount of cores wanted/granted.
818  * - If you have only one vcore, you switch to RUNNABLE_M.  When you run again,
819  *   you'll have one guaranteed core, starting from the entry point.
820  *
821  * - RES_CORES amt_wanted will be the amount running after taking away the
822  *   yielder, unless there are none left, in which case it will be 1.
823  *
824  * If the call is being nice, it means that it is in response to a preemption
825  * (which needs to be checked).  If there is no preemption pending, just return.
826  * No matter what, don't adjust the number of cores wanted.
827  *
828  * This usually does not return (abandon_core()), so it will eat your reference.
829  * */
830 void proc_yield(struct proc *SAFE p, bool being_nice)
831 {
832         uint32_t vcoreid = get_vcoreid(p, core_id());
833         struct vcore *vc = &p->procinfo->vcoremap[vcoreid];
834
835 #ifdef __CONFIG_OSDI__
836         bool new_idle_core = FALSE;
837 #endif /* __CONFIG_OSDI__ */
838
839         /* no reason to be nice, return */
840         if (being_nice && !vc->preempt_pending)
841                 return;
842
843 #ifdef __CONFIG_EXPER_TRADPROC__
844         if (p->state == (PROC_RUNNING_M | PROC_DYING))
845                 return;
846 #endif /* __CONFIG_EXPER_TRADPROC__ */
847
848         spin_lock(&p->proc_lock); /* horrible scalability.  =( */
849
850         /* fate is sealed, return and take the preempt message on the way out.
851          * we're making this check while holding the lock, since the preemptor
852          * should hold the lock when sending messages. */
853         if (vc->preempt_served) {
854                 spin_unlock(&p->proc_lock);
855                 return;
856         }
857         /* no need to preempt later, since we are yielding (nice or otherwise) */
858         if (vc->preempt_pending)
859                 vc->preempt_pending = 0;
860
861         switch (p->state) {
862                 case (PROC_RUNNING_S):
863                         p->env_tf= *current_tf;
864                         env_push_ancillary_state(p);
865                         __proc_set_state(p, PROC_RUNNABLE_S);
866                         schedule_proc(p);
867                         break;
868                 case (PROC_RUNNING_M):
869                         printd("[K] Process %d (%p) is yielding on vcore %d\n", p->pid, p,
870                                get_vcoreid(p, core_id()));
871                         /* TODO: (RMS) the Scheduler cannot handle the Runnable Ms (RMS), so
872                          * don't yield the last vcore.  It's ghetto and for OSDI, but it
873                          * needs to be fixed for all builds, not just CONFIG_OSDI. */
874                         if (p->procinfo->num_vcores == 1) {
875                                 spin_unlock(&p->proc_lock);
876                                 return;
877                         }
878                         __seq_start_write(&p->procinfo->coremap_seqctr);
879                         // give up core
880                         __unmap_vcore(p, get_vcoreid(p, core_id()));
881                         p->resources[RES_CORES].amt_granted = --(p->procinfo->num_vcores);
882                         if (!being_nice)
883                                 p->resources[RES_CORES].amt_wanted = p->procinfo->num_vcores;
884                         __seq_end_write(&p->procinfo->coremap_seqctr);
885                         // add to idle list
886                         put_idle_core(core_id());
887 #ifdef __CONFIG_OSDI__
888                         new_idle_core = TRUE;
889 #endif /* __CONFIG_OSDI__ */
890                         // last vcore?  then we really want 1, and to yield the gang
891                         // TODO: (RMS) will actually do this.
892                         if (p->procinfo->num_vcores == 0) {
893                                 p->resources[RES_CORES].amt_wanted = 1;
894                                 __proc_set_state(p, PROC_RUNNABLE_M);
895                                 schedule_proc(p);
896                         }
897                         break;
898                 default:
899                         // there are races that can lead to this (async death, preempt, etc)
900                         panic("Weird state(%s) in %s()", procstate2str(p->state),
901                               __FUNCTION__);
902         }
903         spin_unlock(&p->proc_lock);
904         proc_decref(p, 1); // need to eat the ref passed in.
905 #ifdef __CONFIG_OSDI__
906         /* If there was a change to the idle cores, try and give our core to someone who was
907          * preempted.  core_request likely won't return.  if that happens, p's
908          * context ought to be cleaned up in the proc_startcore of the new guy. (if
909          * we actually yielded)
910          * TODO: (RMS) do this more intelligently e.g.: kick_scheduler(); */
911         extern struct proc *victim;
912         if (new_idle_core && victim) {
913                 /* this ghetto victim pointer is not an edible reference, and core
914                  * request will eat it when it doesn't return. */
915                 proc_incref(victim, 1);
916                 core_request(victim);
917                 proc_decref(victim, 1);
918         }
919 #endif /* __CONFIG_OSDI__ */
920         /* Clean up the core and idle.  For mgmt cores, they will ultimately call
921          * manager, which will call schedule() and will repick the yielding proc. */
922         abandon_core();
923 }
924
925 /* If you expect to notify yourself, cleanup state and process_routine_kmsg() */
926 void do_notify(struct proc *p, uint32_t vcoreid, unsigned int notif,
927                struct notif_event *ne)
928 {
929         printd("sending notif %d to proc %p\n", notif, p);
930         assert(notif < MAX_NR_NOTIF);
931         if (ne)
932                 assert(notif == ne->ne_type);
933
934         struct notif_method *nm = &p->procdata->notif_methods[notif];
935         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
936
937         printd("nm = %p, vcpd = %p\n", nm, vcpd);
938         /* enqueue notif message or toggle bits */
939         if (ne && nm->flags & NOTIF_MSG) {
940                 if (bcq_enqueue(&vcpd->notif_evts, ne, NR_PERCORE_EVENTS, 4)) {
941                         atomic_inc((atomic_t)&vcpd->event_overflows); // careful here
942                         SET_BITMASK_BIT_ATOMIC(vcpd->notif_bmask, notif);
943                 }
944         } else {
945                 SET_BITMASK_BIT_ATOMIC(vcpd->notif_bmask, notif);
946         }
947
948         /* Active notification */
949         /* TODO: Currently, there is a race for notif_pending, and multiple senders
950          * can send an IPI.  Worst thing is that the process gets interrupted
951          * briefly and the kernel immediately returns back once it realizes notifs
952          * are masked.  To fix it, we'll need atomic_swapb() (right answer), or not
953          * use a bool. (wrong answer). */
954         if (nm->flags & NOTIF_IPI && !vcpd->notif_pending) {
955                 vcpd->notif_pending = TRUE;
956                 if (vcpd->notif_enabled) {
957                         /* GIANT WARNING: we aren't using the proc-lock to protect the
958                          * vcoremap.  We want to be able to use this from interrupt context,
959                          * and don't want the proc_lock to be an irqsave.
960                          */
961                         if ((p->state & PROC_RUNNING_M) && // TODO: (VC#) (_S state)
962                                       (p->procinfo->vcoremap[vcoreid].valid)) {
963                                 printd("[kernel] sending notif to vcore %d\n", vcoreid);
964                                 send_kernel_message(p->procinfo->vcoremap[vcoreid].pcoreid,
965                                                     __notify, p, 0, 0, KMSG_ROUTINE);
966                         } else { // TODO: think about this, fallback, etc
967                                 warn("Vcore unmapped, not receiving an active notif");
968                         }
969                 }
970         }
971 }
972
973 /* Sends notification number notif to proc p.  Meant for generic notifications /
974  * reference implementation.  do_notify does the real work.  This one mostly
975  * just determines where the notif should be sent, other checks, etc.
976  * Specifically, it handles the parameters of notif_methods.  If you happen to
977  * notify yourself, make sure you process routine kmsgs. */
978 void proc_notify(struct proc *p, unsigned int notif, struct notif_event *ne)
979 {
980         assert(notif < MAX_NR_NOTIF); // notifs start at 0
981         struct notif_method *nm = &p->procdata->notif_methods[notif];
982         struct notif_event local_ne;
983
984         /* Caller can opt to not send an NE, in which case we use the notif */
985         if (!ne) {
986                 ne = &local_ne;
987                 ne->ne_type = notif;
988         }
989
990         if (!(nm->flags & NOTIF_WANTED))
991                 return;
992         do_notify(p, nm->vcoreid, ne->ne_type, ne);
993 }
994
995 /************************  Preemption Functions  ******************************
996  * Don't rely on these much - I'll be sure to change them up a bit.
997  *
998  * Careful about what takes a vcoreid and what takes a pcoreid.  Also, there may
999  * be weird glitches with setting the state to RUNNABLE_M.  It is somewhat in
1000  * flux.  The num_vcores is changed after take_cores, but some of the messages
1001  * (or local traps) may not yet be ready to handle seeing their future state.
1002  * But they should be, so fix those when they pop up.
1003  *
1004  * TODO: (RMS) we need to actually make the scheduler handle RUNNABLE_Ms and
1005  * then schedule these, or change proc_destroy to not assume they need to be
1006  * descheduled.
1007  *
1008  * Another thing to do would be to make the _core functions take a pcorelist,
1009  * and not just one pcoreid. */
1010
1011 /* Sets a preempt_pending warning for p's vcore, to go off 'when'.  If you care
1012  * about locking, do it before calling.  Takes a vcoreid! */
1013 void __proc_preempt_warn(struct proc *p, uint32_t vcoreid, uint64_t when)
1014 {
1015         /* danger with doing this unlocked: preempt_pending is set, but never 0'd,
1016          * since it is unmapped and not dealt with (TODO)*/
1017         p->procinfo->vcoremap[vcoreid].preempt_pending = when;
1018         /* notify, if they want to hear about this event.  regardless of how they
1019          * want it, we can send this as a bit.  Subject to change. */
1020         if (p->procdata->notif_methods[NE_PREEMPT_PENDING].flags | NOTIF_WANTED)
1021                 do_notify(p, vcoreid, NE_PREEMPT_PENDING, 0);
1022         /* TODO: consider putting in some lookup place for the alarm to find it.
1023          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1024 }
1025
1026 /* Warns all active vcores of an impending preemption.  Hold the lock if you
1027  * care about the mapping (and you should). */
1028 void __proc_preempt_warnall(struct proc *p, uint64_t when)
1029 {
1030         uint32_t active_vcoreid = 0;
1031         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1032                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1033                 __proc_preempt_warn(p, active_vcoreid, when);
1034                 active_vcoreid++;
1035         }
1036         /* TODO: consider putting in some lookup place for the alarm to find it.
1037          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1038 }
1039
1040 // TODO: function to set an alarm, if none is outstanding
1041
1042 /* Raw function to preempt a single core.  Returns TRUE if the calling core will
1043  * get a kmsg.  If you care about locking, do it before calling. */
1044 bool __proc_preempt_core(struct proc *p, uint32_t pcoreid)
1045 {
1046         uint32_t vcoreid = get_vcoreid(p, pcoreid);
1047
1048         p->procinfo->vcoremap[vcoreid].preempt_served = TRUE;
1049         // expects a pcorelist.  assumes pcore is mapped and running_m
1050         return __proc_take_cores(p, &pcoreid, 1, __preempt, p, 0, 0);
1051 }
1052
1053 /* Raw function to preempt every vcore.  Returns TRUE if the calling core will
1054  * get a kmsg.  If you care about locking, do it before calling. */
1055 bool __proc_preempt_all(struct proc *p)
1056 {
1057         /* instead of doing this, we could just preempt_served all possible vcores,
1058          * and not just the active ones.  We would need to sort out a way to deal
1059          * with stale preempt_serveds first.  This might be just as fast anyways. */
1060         uint32_t active_vcoreid = 0;
1061         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1062                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1063                 p->procinfo->vcoremap[active_vcoreid].preempt_served = TRUE;
1064                 active_vcoreid++;
1065         }
1066         return __proc_take_allcores(p, __preempt, p, 0, 0);
1067 }
1068
1069 /* Warns and preempts a vcore from p.  No delaying / alarming, or anything.  The
1070  * warning will be for u usec from now. */
1071 void proc_preempt_core(struct proc *p, uint32_t pcoreid, uint64_t usec)
1072 {
1073         bool self_ipi_pending = FALSE;
1074         uint64_t warn_time = read_tsc() + usec * 1000000 / system_timing.tsc_freq;
1075
1076         /* DYING could be okay */
1077         if (p->state != PROC_RUNNING_M) {
1078                 warn("Tried to preempt from a non RUNNING_M proc!");
1079                 return;
1080         }
1081         spin_lock(&p->proc_lock);
1082         if (is_mapped_vcore(p, pcoreid)) {
1083                 __proc_preempt_warn(p, get_vcoreid(p, pcoreid), warn_time);
1084                 self_ipi_pending = __proc_preempt_core(p, pcoreid);
1085         } else {
1086                 warn("Pcore doesn't belong to the process!!");
1087         }
1088         /* TODO: (RMS) do this once a scheduler can handle RUNNABLE_M, and make sure
1089          * to schedule it */
1090         #if 0
1091         if (!p->procinfo->num_vcores) {
1092                 __proc_set_state(p, PROC_RUNNABLE_M);
1093                 schedule_proc(p);
1094         }
1095         #endif
1096         spin_unlock(&p->proc_lock);
1097         __proc_kmsg_pending(p, self_ipi_pending);
1098 }
1099
1100 /* Warns and preempts all from p.  No delaying / alarming, or anything.  The
1101  * warning will be for u usec from now. */
1102 void proc_preempt_all(struct proc *p, uint64_t usec)
1103 {
1104         bool self_ipi_pending = FALSE;
1105         uint64_t warn_time = read_tsc() + usec * 1000000 / system_timing.tsc_freq;
1106
1107         spin_lock(&p->proc_lock);
1108         /* DYING could be okay */
1109         if (p->state != PROC_RUNNING_M) {
1110                 warn("Tried to preempt from a non RUNNING_M proc!");
1111                 spin_unlock(&p->proc_lock);
1112                 return;
1113         }
1114         __proc_preempt_warnall(p, warn_time);
1115         self_ipi_pending = __proc_preempt_all(p);
1116         assert(!p->procinfo->num_vcores);
1117         /* TODO: (RMS) do this once a scheduler can handle RUNNABLE_M, and make sure
1118          * to schedule it */
1119         #if 0
1120         __proc_set_state(p, PROC_RUNNABLE_M);
1121         schedule_proc(p);
1122         #endif
1123         spin_unlock(&p->proc_lock);
1124         __proc_kmsg_pending(p, self_ipi_pending);
1125 }
1126
1127 /* Give the specific pcore to proc p.  Lots of assumptions, so don't really use
1128  * this.  The proc needs to be _M and prepared for it.  the pcore needs to be
1129  * free, etc. */
1130 void proc_give(struct proc *p, uint32_t pcoreid)
1131 {
1132         bool self_ipi_pending = FALSE;
1133
1134         spin_lock(&p->proc_lock);
1135         // expects a pcorelist, we give it a list of one
1136         self_ipi_pending = __proc_give_cores(p, &pcoreid, 1);
1137         spin_unlock(&p->proc_lock);
1138         __proc_kmsg_pending(p, self_ipi_pending);
1139 }
1140
1141 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
1142  * out). */
1143 uint32_t proc_get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
1144 {
1145         uint32_t vcoreid;
1146         // TODO: the code currently doesn't track the vcoreid properly for _S (VC#)
1147         spin_lock(&p->proc_lock);
1148         switch (p->state) {
1149                 case PROC_RUNNING_S:
1150                         spin_unlock(&p->proc_lock);
1151                         return 0; // TODO: here's the ugly part
1152                 case PROC_RUNNING_M:
1153                         vcoreid = get_vcoreid(p, pcoreid);
1154                         spin_unlock(&p->proc_lock);
1155                         return vcoreid;
1156                 case PROC_DYING: // death message is on the way
1157                         spin_unlock(&p->proc_lock);
1158                         return 0;
1159                 default:
1160                         spin_unlock(&p->proc_lock);
1161                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1162                               __FUNCTION__);
1163         }
1164 }
1165
1166 /* Gives process p the additional num cores listed in pcorelist.  You must be
1167  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
1168  * startup your new cores at the entry point with their virtual IDs (or restore
1169  * a preemption).  If you're RUNNABLE_M, you should call proc_run after this so
1170  * that the process can start to use its cores.
1171  *
1172  * If you're *_S, make sure your core0's TF is set (which is done when coming in
1173  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
1174  * Then call proc_run().
1175  *
1176  * The reason I didn't bring the _S cases from core_request over here is so we
1177  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
1178  * this is called from another core, and to avoid the need_to_idle business.
1179  * The other way would be to have this function have the side effect of changing
1180  * state, and finding another way to do the need_to_idle.
1181  *
1182  * The returned bool signals whether or not a stack-crushing IPI will come in
1183  * once you unlock after this function.
1184  *
1185  * WARNING: You must hold the proc_lock before calling this! */
1186 bool __proc_give_cores(struct proc *SAFE p, uint32_t *pcorelist, size_t num)
1187 { TRUSTEDBLOCK
1188 #ifdef __CONFIG_EXPER_TRADPROC__
1189         assert(is_real_proc(p));
1190 #endif /* __CONFIG_EXPER_TRADPROC__ */
1191         bool self_ipi_pending = FALSE;
1192         uint32_t free_vcoreid = 0;
1193         switch (p->state) {
1194                 case (PROC_RUNNABLE_S):
1195                 case (PROC_RUNNING_S):
1196                         panic("Don't give cores to a process in a *_S state!\n");
1197                         break;
1198                 case (PROC_DYING):
1199                         panic("Attempted to give cores to a DYING process.\n");
1200                         break;
1201                 case (PROC_RUNNABLE_M):
1202                         // set up vcoremap.  list should be empty, but could be called
1203                         // multiple times before proc_running (someone changed their mind?)
1204                         if (p->procinfo->num_vcores) {
1205                                 printk("[kernel] Yaaaaaarrrrr!  Giving extra cores, are we?\n");
1206                                 // debugging: if we aren't packed, then there's a problem
1207                                 // somewhere, like someone forgot to take vcores after
1208                                 // preempting.
1209                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
1210                                         assert(p->procinfo->vcoremap[i].valid);
1211                         }
1212                         // add new items to the vcoremap
1213 #ifdef __CONFIG_EXPER_TRADPROC__
1214                         __proc_set_state(p, PROC_RUNNING_M);
1215                         // want an extra one since res_req jacked on on our transition
1216                         p->env_refcnt++;
1217 #endif /* __CONFIG_EXPER_TRADPROC__ */
1218                         __seq_start_write(&p->procinfo->coremap_seqctr);
1219                         for (int i = 0; i < num; i++) {
1220                                 // find the next free slot, which should be the next one
1221                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
1222                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
1223                                        pcorelist[i]);
1224                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
1225                                 p->procinfo->num_vcores++;
1226 #ifdef __CONFIG_EXPER_TRADPROC__
1227                                 struct proc *fake_proc;
1228                                 /* every vcore is a fake proc */
1229                                 fake_proc_alloc(&fake_proc, p, free_vcoreid);
1230                                 local_schedule_proc(pcorelist[i], fake_proc);
1231 #endif /* __CONFIG_EXPER_TRADPROC__ */
1232                         }
1233                         __seq_end_write(&p->procinfo->coremap_seqctr);
1234                         break;
1235                 case (PROC_RUNNING_M):
1236                         /* Up the refcnt, since num cores are going to start using this
1237                          * process and have it loaded in their 'current'. */
1238                         // TODO: (REF) use proc_incref once we have atomics
1239 #ifndef __CONFIG_EXPER_TRADPROC__ // the refcnt is done in fake_proc_alloc
1240                         p->env_refcnt += num;
1241 #endif /* __CONFIG_EXPER_TRADPROC__ */
1242                         __seq_start_write(&p->procinfo->coremap_seqctr);
1243                         for (int i = 0; i < num; i++) {
1244                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
1245                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
1246                                        pcorelist[i]);
1247                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
1248                                 p->procinfo->num_vcores++;
1249 #ifdef __CONFIG_EXPER_TRADPROC__
1250                                 struct proc *fake_proc;
1251                                 fake_proc_alloc(&fake_proc, p, free_vcoreid);
1252                                 local_schedule_proc(pcorelist[i], fake_proc);
1253 #else
1254                                 send_kernel_message(pcorelist[i], __startcore, p, 0, 0,
1255                                                     KMSG_ROUTINE);
1256 #endif /* __CONFIG_EXPER_TRADPROC__ */
1257                                 if (pcorelist[i] == core_id())
1258                                         self_ipi_pending = TRUE;
1259                         }
1260                         __seq_end_write(&p->procinfo->coremap_seqctr);
1261                         break;
1262                 default:
1263                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1264                               __FUNCTION__);
1265         }
1266         p->resources[RES_CORES].amt_granted += num;
1267         return self_ipi_pending;
1268 }
1269
1270 /* Makes process p's coremap look like pcorelist (add, remove, etc).  Caller
1271  * needs to know what cores are free after this call (removed, failed, etc).
1272  * This info will be returned via corelist and *num.  This will send message to
1273  * any cores that are getting removed.
1274  *
1275  * Before implementing this, we should probably think about when this will be
1276  * used.  Implies preempting for the message.  The more that I think about this,
1277  * the less I like it.  For now, don't use this, and think hard before
1278  * implementing it.
1279  *
1280  * WARNING: You must hold the proc_lock before calling this! */
1281 bool __proc_set_allcores(struct proc *SAFE p, uint32_t *pcorelist,
1282                          size_t *num, amr_t message,TV(a0t) arg0,
1283                          TV(a1t) arg1, TV(a2t) arg2)
1284 {
1285         panic("Set all cores not implemented.\n");
1286 }
1287
1288 /* Takes from process p the num cores listed in pcorelist, using the given
1289  * message for the kernel message (__death, __preempt, etc).  Like the others
1290  * in this function group, bool signals whether or not an IPI is pending.
1291  *
1292  * WARNING: You must hold the proc_lock before calling this! */
1293 bool __proc_take_cores(struct proc *SAFE p, uint32_t *pcorelist,
1294                        size_t num, amr_t message, TV(a0t) arg0,
1295                        TV(a1t) arg1, TV(a2t) arg2)
1296 { TRUSTEDBLOCK
1297 #ifdef __CONFIG_EXPER_TRADPROC__
1298         assert(is_real_proc(p));
1299         assert(0);
1300 #endif /* __CONFIG_EXPER_TRADPROC__ */
1301         uint32_t vcoreid, pcoreid;
1302         bool self_ipi_pending = FALSE;
1303         switch (p->state) {
1304                 case (PROC_RUNNABLE_M):
1305                         assert(!message);
1306                         break;
1307                 case (PROC_RUNNING_M):
1308                         assert(message);
1309                         break;
1310                 default:
1311                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1312                               __FUNCTION__);
1313         }
1314         spin_lock(&idle_lock);
1315         assert((num <= p->procinfo->num_vcores) &&
1316                (num_idlecores + num <= num_cpus));
1317         spin_unlock(&idle_lock);
1318         __seq_start_write(&p->procinfo->coremap_seqctr);
1319         for (int i = 0; i < num; i++) {
1320                 vcoreid = get_vcoreid(p, pcorelist[i]);
1321                 // while ugly, this is done to facilitate merging with take_all_cores
1322                 pcoreid = p->procinfo->vcoremap[vcoreid].pcoreid;
1323                 assert(pcoreid == pcorelist[i]);
1324                 if (message) {
1325                         if (pcoreid == core_id())
1326                                 self_ipi_pending = TRUE;
1327                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
1328                                             KMSG_ROUTINE);
1329                 } else {
1330                         /* if there was a msg, the vcore is unmapped on the receive side.
1331                          * o/w, we need to do it here. */
1332                         __unmap_vcore(p, vcoreid);
1333                 }
1334                 // give the pcore back to the idlecoremap
1335                 put_idle_core(pcoreid);
1336         }
1337         p->procinfo->num_vcores -= num;
1338         __seq_end_write(&p->procinfo->coremap_seqctr);
1339         p->resources[RES_CORES].amt_granted -= num;
1340         return self_ipi_pending;
1341 }
1342
1343 /* Takes all cores from a process, which must be in an _M state.  Cores are
1344  * placed back in the idlecoremap.  If there's a message, such as __death or
1345  * __preempt, it will be sent to the cores.  The bool signals whether or not an
1346  * IPI is coming in once you unlock.
1347  *
1348  * WARNING: You must hold the proc_lock before calling this! */
1349 bool __proc_take_allcores(struct proc *SAFE p, amr_t message,
1350                           TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
1351 {
1352 #ifdef __CONFIG_EXPER_TRADPROC__
1353         assert(is_real_proc(p));
1354 #endif /* __CONFIG_EXPER_TRADPROC__ */
1355         uint32_t active_vcoreid = 0, pcoreid;
1356         bool self_ipi_pending = FALSE;
1357         switch (p->state) {
1358                 case (PROC_RUNNABLE_M):
1359                         assert(!message);
1360                         break;
1361                 case (PROC_RUNNING_M):
1362                         assert(message);
1363                         break;
1364                 default:
1365                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1366                               __FUNCTION__);
1367         }
1368         spin_lock(&idle_lock);
1369         assert(num_idlecores + p->procinfo->num_vcores <= num_cpus); // sanity
1370         spin_unlock(&idle_lock);
1371         __seq_start_write(&p->procinfo->coremap_seqctr);
1372 #ifdef __CONFIG_EXPER_TRADPROC__
1373         /* Decref each child, so they will free themselves when they unmap */
1374         for (int i = 1; i < MAX_NUM_CPUS; i++) {
1375                 if (p->vcore_procs[i])
1376                         proc_decref(p->vcore_procs[i], 1);
1377         }
1378 #endif /* __CONFIG_EXPER_TRADPROC__ */
1379         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1380                 // find next active vcore
1381                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1382                 pcoreid = p->procinfo->vcoremap[active_vcoreid].pcoreid;
1383                 if (message) {
1384                         if (pcoreid == core_id())
1385                                 self_ipi_pending = TRUE;
1386                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
1387                                             KMSG_ROUTINE);
1388                 } else {
1389                         /* if there was a msg, the vcore is unmapped on the receive side.
1390                          * o/w, we need to do it here. */
1391                         __unmap_vcore(p, active_vcoreid);
1392                 }
1393                 // give the pcore back to the idlecoremap
1394                 put_idle_core(pcoreid);
1395                 active_vcoreid++; // for the next loop, skip the one we just used
1396         }
1397         p->procinfo->num_vcores = 0;
1398         __seq_end_write(&p->procinfo->coremap_seqctr);
1399         p->resources[RES_CORES].amt_granted = 0;
1400         return self_ipi_pending;
1401 }
1402
1403 /* Helper, to be used when a proc management kmsg should be on its way.  This
1404  * used to also unlock and then handle the message, back when the proc_lock was
1405  * an irqsave, and we had an IPI pending.  Now we use routine kmsgs.  If a msg
1406  * is pending, this needs to decref (to eat the reference of the caller) and
1407  * then process the message.  Unlock before calling this, since you might not
1408  * return.
1409  *
1410  * There should already be a kmsg waiting for us, since when we checked state to
1411  * see a message was coming, the message had already been sent before unlocking.
1412  * Note we do not need interrupts enabled for this to work (you can receive a
1413  * message before its IPI by polling), though in most cases they will be.
1414  *
1415  * TODO: consider inlining this, so __FUNCTION__ works (will require effort in
1416  * core_request(). */
1417 void __proc_kmsg_pending(struct proc *p, bool ipi_pending)
1418 {
1419         if (ipi_pending) {
1420                 proc_decref(p, 1);
1421                 process_routine_kmsg();
1422                 panic("stack-killing kmsg not found in %s!!!", __FUNCTION__);
1423         }
1424 }
1425
1426 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
1427  * calling. */
1428 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
1429 {
1430         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
1431         p->procinfo->vcoremap[vcoreid].valid = TRUE;
1432         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
1433         p->procinfo->pcoremap[pcoreid].valid = TRUE;
1434 }
1435
1436 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
1437  * calling. */
1438 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
1439 {
1440         p->procinfo->vcoremap[vcoreid].valid = FALSE;
1441         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid = FALSE;
1442 }
1443
1444 /* This takes a referenced process and ups the refcnt by count.  If the refcnt
1445  * was already 0, then someone has a bug, so panic.  Check out the Documentation
1446  * for brutal details about refcnting.
1447  *
1448  * Implementation aside, the important thing is that we atomically increment
1449  * only if it wasn't already 0.  If it was 0, panic.
1450  *
1451  * TODO: (REF) change to use CAS / atomics. */
1452 void proc_incref(struct proc *p, size_t count)
1453 {
1454         spin_lock_irqsave(&p->proc_lock);
1455         if (p->env_refcnt)
1456                 p->env_refcnt += count;
1457         else
1458                 panic("Tried to incref a proc with no existing references!");
1459         spin_unlock_irqsave(&p->proc_lock);
1460 }
1461
1462 /* When the kernel is done with a process, it decrements its reference count.
1463  * When the count hits 0, no one is using it and it should be freed.  "Last one
1464  * out" actually finalizes the death of the process.  This is tightly coupled
1465  * with the previous function (incref)
1466  *
1467  * TODO: (REF) change to use CAS.  Note that when we do so, we may be holding
1468  * the process lock when calling __proc_free().  Think about what order to do
1469  * those calls in (unlock, then decref?), and the race with someone unlocking
1470  * while someone else is __proc_free()ing. */
1471 void proc_decref(struct proc *p, size_t count)
1472 {
1473         spin_lock_irqsave(&p->proc_lock);
1474         p->env_refcnt -= count;
1475         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
1476         spin_unlock_irqsave(&p->proc_lock);
1477         // if we hit 0, no one else will increment and we can check outside the lock
1478         if (!refcnt)
1479                 __proc_free(p);
1480         if (refcnt < 0)
1481                 panic("Too many decrefs!");
1482 }
1483
1484 /* Kernel message handler to start a process's context on this core.  Tightly
1485  * coupled with proc_run().  Interrupts are disabled. */
1486 void __startcore(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1487 {
1488         uint32_t pcoreid = core_id(), vcoreid;
1489         struct proc *p_to_run = (struct proc *CT(1))a0;
1490         struct trapframe local_tf;
1491         struct preempt_data *vcpd;
1492
1493         assert(p_to_run);
1494         /* the sender of the amsg increfed, thinking we weren't running current. */
1495         if (p_to_run == current)
1496                 proc_decref(p_to_run, 1);
1497         vcoreid = get_vcoreid(p_to_run, pcoreid);
1498         vcpd = &p_to_run->procdata->vcore_preempt_data[vcoreid];
1499         printd("[kernel] startcore on physical core %d for process %d's vcore %d\n",
1500                pcoreid, p_to_run->pid, vcoreid);
1501
1502         if (seq_is_locked(vcpd->preempt_tf_valid)) {
1503                 __seq_end_write(&vcpd->preempt_tf_valid); /* mark tf as invalid */
1504                 restore_fp_state(&vcpd->preempt_anc);
1505                 /* notif_pending and enabled means the proc wants to receive the IPI,
1506                  * but might have missed it.  copy over the tf so they can restart it
1507                  * later, and give them a fresh vcore. */
1508                 if (vcpd->notif_pending && vcpd->notif_enabled) {
1509                         vcpd->notif_tf = vcpd->preempt_tf; // could memset
1510                         proc_init_trapframe(&local_tf, vcoreid, p_to_run->env_entry,
1511                                             vcpd->transition_stack);
1512                         vcpd->notif_enabled = FALSE;
1513                         vcpd->notif_pending = FALSE;
1514                 } else {
1515                         /* copy-in the tf we'll pop, then set all security-related fields */
1516                         local_tf = vcpd->preempt_tf;
1517                         proc_secure_trapframe(&local_tf);
1518                 }
1519         } else { /* not restarting from a preemption, use a fresh vcore */
1520                 proc_init_trapframe(&local_tf, vcoreid, p_to_run->env_entry,
1521                                     vcpd->transition_stack);
1522                 /* Disable/mask active notifications for fresh vcores */
1523                 vcpd->notif_enabled = FALSE;
1524         }
1525         __proc_startcore(p_to_run, &local_tf); // TODO: (HSS) pass silly state *?
1526 }
1527
1528 /* Bail out if it's the wrong process, or if they no longer want a notif.  Make
1529  * sure that you are passing in a user tf (otherwise, it's a bug).  Try not to
1530  * grab locks or write access to anything that isn't per-core in here. */
1531 void __notify(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1532 {
1533         struct user_trapframe local_tf;
1534         struct preempt_data *vcpd;
1535         uint32_t vcoreid;
1536         struct proc *p = (struct proc*)a0;
1537
1538         if (p != current)
1539                 return;
1540         assert(!in_kernel(tf));
1541         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1542          * mapping would only happen if the vcore was free, which it isn't until
1543          * after we unmap. */
1544         vcoreid = get_vcoreid(p, core_id());
1545         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1546         printd("received active notification for proc %d's vcore %d on pcore %d\n",
1547                p->procinfo->pid, vcoreid, core_id());
1548         /* sort signals.  notifs are now masked, like an interrupt gate */
1549         if (!vcpd->notif_enabled)
1550                 return;
1551         vcpd->notif_enabled = FALSE;
1552         vcpd->notif_pending = FALSE; // no longer pending - it made it here
1553         /* save the old tf in the notify slot, build and pop a new one.  Note that
1554          * silly state isn't our business for a notification. */
1555         // TODO: this is assuming the struct user_tf is the same as a regular TF
1556         vcpd->notif_tf = *tf;
1557         memset(&local_tf, 0, sizeof(local_tf));
1558         proc_init_trapframe(&local_tf, vcoreid, p->env_entry,
1559                             vcpd->transition_stack);
1560         __proc_startcore(p, &local_tf);
1561 }
1562
1563 /* Stop running whatever context is on this core, load a known-good cr3, and
1564  * 'idle'.  Note this leaves no trace of what was running. This "leaves the
1565  * process's context. */
1566 void abandon_core(void)
1567 {
1568         if (current)
1569                 __abandon_core();
1570         smp_idle();
1571 }
1572
1573 void __preempt(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1574 {
1575         struct preempt_data *vcpd;
1576         uint32_t vcoreid, coreid = core_id();
1577         struct proc *p = (struct proc*)a0;
1578
1579         if (p != current)
1580                 panic("__preempt arrived for a process (%p) that was not current (%p)!",
1581                       p, current);
1582         assert(!in_kernel(tf));
1583         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1584          * mapping would only happen if the vcore was free, which it isn't until
1585          * after we unmap. */
1586         vcoreid = get_vcoreid(p, coreid);
1587         p->procinfo->vcoremap[vcoreid].preempt_served = FALSE;
1588         /* either __preempt or proc_yield() ends the preempt phase. */
1589         p->procinfo->vcoremap[vcoreid].preempt_pending = 0;
1590         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1591         printd("[kernel] received __preempt for proc %d's vcore %d on pcore %d\n",
1592                p->procinfo->pid, vcoreid, core_id());
1593
1594         /* save the old tf in the preempt slot, save the silly state, and signal the
1595          * state is a valid tf.  when it is 'written,' it is valid.  Using the
1596          * seq_ctrs so userspace can tell between different valid versions.  If the
1597          * TF was already valid, it will panic (if CONFIGed that way). */
1598         // TODO: this is assuming the struct user_tf is the same as a regular TF
1599         vcpd->preempt_tf = *tf;
1600         save_fp_state(&vcpd->preempt_anc);
1601         __seq_start_write(&vcpd->preempt_tf_valid);
1602         __unmap_vcore(p, vcoreid);
1603         abandon_core();
1604 }
1605
1606 /* Kernel message handler to clean up the core when a process is dying.
1607  * Note this leaves no trace of what was running.
1608  * It's okay if death comes to a core that's already idling and has no current.
1609  * It could happen if a process decref'd before __proc_startcore could incref. */
1610 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
1611              void *SNT a2)
1612 {
1613         uint32_t vcoreid, coreid = core_id();
1614         if (current) {
1615                 vcoreid = get_vcoreid(current, coreid);
1616                 printd("[kernel] death on physical core %d for process %d's vcore %d\n",
1617                        coreid, current->pid, vcoreid);
1618                 __unmap_vcore(current, vcoreid);
1619         }
1620         abandon_core();
1621 }
1622
1623 void print_idlecoremap(void)
1624 {
1625         spin_lock(&idle_lock);
1626         printk("There are %d idle cores.\n", num_idlecores);
1627         for (int i = 0; i < num_idlecores; i++)
1628                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
1629         spin_unlock(&idle_lock);
1630 }
1631
1632 void print_allpids(void)
1633 {
1634         spin_lock(&pid_hash_lock);
1635         if (hashtable_count(pid_hash)) {
1636                 hashtable_itr_t *phtable_i = hashtable_iterator(pid_hash);
1637                 printk("PID      STATE    \n");
1638                 printk("------------------\n");
1639                 do {
1640                         struct proc *p = hashtable_iterator_value(phtable_i);
1641                         printk("%8d %s\n", hashtable_iterator_key(phtable_i),
1642                                p ? procstate2str(p->state) : "(null)");
1643                 } while (hashtable_iterator_advance(phtable_i));
1644         }
1645         spin_unlock(&pid_hash_lock);
1646 }
1647
1648 void print_proc_info(pid_t pid)
1649 {
1650         int j = 0;
1651         struct proc *p = pid2proc(pid);
1652         // not concerned with a race on the state...
1653         if (!p) {
1654                 printk("Bad PID.\n");
1655                 return;
1656         }
1657         spinlock_debug(&p->proc_lock);
1658         spin_lock(&p->proc_lock);
1659         printk("struct proc: %p\n", p);
1660         printk("PID: %d\n", p->pid);
1661         printk("PPID: %d\n", p->ppid);
1662         printk("State: 0x%08x\n", p->state);
1663         printk("Refcnt: %d\n", p->env_refcnt - 1); // don't report our ref
1664         printk("Flags: 0x%08x\n", p->env_flags);
1665         printk("CR3(phys): 0x%08x\n", p->env_cr3);
1666         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
1667         printk("Vcoremap:\n");
1668         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1669                 j = get_busy_vcoreid(p, j);
1670                 printk("\tVcore %d: Pcore %d\n", j, p->procinfo->vcoremap[j].pcoreid);
1671                 j++;
1672         }
1673         printk("Resources:\n");
1674         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
1675                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
1676                        p->resources[i].amt_wanted, p->resources[i].amt_granted);
1677         /* No one cares, and it clutters the terminal */
1678         //printk("Vcore 0's Last Trapframe:\n");
1679         //print_trapframe(&p->env_tf);
1680         spin_unlock(&p->proc_lock);
1681         proc_decref(p, 1); /* decref for the pid2proc reference */
1682 }