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