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