Made a global num_mgmtcores variable
[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_irqsave(&p->proc_lock);
383         switch (p->state) {
384                 case (PROC_DYING):
385                         spin_unlock_irqsave(&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 keep 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.  Note the use of a regular unlock. */
411                         spin_unlock(&p->proc_lock);
412                         __proc_startcore(p, &p->env_tf);
413                         break;
414                 case (PROC_RUNNABLE_M):
415                         /* vcoremap[i] holds the coreid of the physical core allocated to
416                          * this process.  It is set outside proc_run.  For the kernel
417                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
418                         if (p->procinfo->num_vcores) {
419                                 __proc_set_state(p, PROC_RUNNING_M);
420                                 /* Up the refcnt, since num_vcores are going to start using this
421                                  * process and have it loaded in their 'current'. */
422                                 p->env_refcnt += p->procinfo->num_vcores; // TODO: (REF) use incref
423                                 /* If the core we are running on is in the vcoremap, we will get
424                                  * an IPI (once we reenable interrupts) and never return. */
425                                 if (is_mapped_vcore(p, core_id()))
426                                         self_ipi_pending = TRUE;
427                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
428                                         send_kernel_message(p->procinfo->vcoremap[i].pcoreid,
429                                                             (void *)__startcore, (void *)p, 0, 0,
430                                                             KMSG_ROUTINE);
431                         } else {
432                                 warn("Tried to proc_run() an _M with no vcores!");
433                         }
434                         /* Unlock and decref/wait for the IPI if one is pending.  This will
435                          * eat the reference if we aren't returning. 
436                          *
437                          * There a subtle race avoidance here.  __proc_startcore can handle
438                          * a death message, but we can't have the startcore come after the
439                          * death message.  Otherwise, it would look like a new process.  So
440                          * we hold the lock til after we send our message, which prevents a
441                          * possible death message.
442                          * - Likewise, we need interrupts to be disabled, in case one of the
443                          *   messages was for us, and reenable them after letting go of the
444                          *   lock.  This is done by spin_lock_irqsave, so be careful if you
445                          *   change this.
446                          * - Note there is no guarantee this core's interrupts were on, so
447                          *   it may not get the message for a while... */
448                         __proc_unlock_ipi_pending(p, self_ipi_pending);
449                         break;
450                 default:
451                         spin_unlock_irqsave(&p->proc_lock);
452                         panic("Invalid process state %p in proc_run()!!", p->state);
453         }
454 }
455
456 /* Actually runs the given context (trapframe) of process p on the core this
457  * code executes on.  This is called directly by __startcore, which needs to
458  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
459  * 
460  * A note on refcnting: this function will not return, and your proc reference
461  * will end up stored in current.  This will make no changes to p's refcnt, so
462  * do your accounting such that there is only the +1 for current.  This means if
463  * it is already in current (like in the trap return path), don't up it.  If
464  * it's already in current and you have another reference (like pid2proc or from
465  * an IPI), then down it (which is what happens in __startcore()).  If it's not
466  * in current and you have one reference, like proc_run(non_current_p), then
467  * also do nothing.  The refcnt for your *p will count for the reference stored
468  * in current. */
469 static void __proc_startcore(struct proc *p, trapframe_t *tf)
470 {
471         assert(!irq_is_enabled());
472         /* If the process wasn't here, then we need to load its address space. */
473         if (p != current) {
474                 /* Do not incref here.  We were given the reference to current,
475                  * pre-upped. */
476                 lcr3(p->env_cr3);
477                 /* This is "leaving the process context" of the previous proc.  The
478                  * previous lcr3 unloaded the previous proc's context.  This should
479                  * rarely happen, since we usually proactively leave process context,
480                  * but is the fallback. */
481                 if (current)
482                         proc_decref(current, 1);
483                 set_current_proc(p);
484         }
485         /* need to load our silly state, preferably somewhere other than here so we
486          * can avoid the case where the context was just running here.  it's not
487          * sufficient to do it in the "new process" if-block above (could be things
488          * like page faults that cause us to keep the same process, but want a
489          * different context.
490          * for now, we load this silly state here. (TODO) (HSS)
491          * We also need this to be per trapframe, and not per process...
492          */
493         env_pop_ancillary_state(p);
494         env_pop_tf(tf);
495 }
496
497 /* Restarts the given context (trapframe) of process p on the core this code
498  * executes on.  Calls an internal function to do the work.
499  * 
500  * In case there are pending routine messages, like __death, __preempt, or
501  * __notify, we need to run them.  Alternatively, if there are any, we could
502  * self_ipi, and run the messages immediately after popping back to userspace,
503  * but that would have crappy overhead.
504  *
505  * Refcnting: this will not return, and it assumes that you've accounted for
506  * your reference as if it was the ref for "current" (which is what happens when
507  * returning from local traps and such. */
508 void proc_restartcore(struct proc *p, trapframe_t *tf)
509 {
510         /* Need ints disabled when we return from processing (race) */
511         disable_irq();
512         process_routine_kmsg();
513         __proc_startcore(p, tf);
514 }
515
516 /*
517  * Destroys the given process.  This may be called from another process, a light
518  * kernel thread (no real process context), asynchronously/cross-core, or from
519  * the process on its own core.
520  *
521  * Here's the way process death works:
522  * 0. grab the lock (protects state transition and core map)
523  * 1. set state to dying.  that keeps the kernel from doing anything for the
524  * process (like proc_running it).
525  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
526  * 3. IPI to clean up those cores (decref, etc).
527  * 4. Unlock
528  * 5. Clean up your core, if applicable
529  * (Last core/kernel thread to decref cleans up and deallocates resources.)
530  *
531  * Note that some cores can be processing async calls, but will eventually
532  * decref.  Should think about this more, like some sort of callback/revocation.
533  *
534  * This will eat your reference if it won't return.  Note that this function
535  * needs to change anyways when we make __death more like __preempt.  (TODO) */
536 void proc_destroy(struct proc *p)
537 {
538         bool self_ipi_pending = FALSE;
539         spin_lock_irqsave(&p->proc_lock);
540
541         /* TODO: (DEATH) look at this again when we sort the __death IPI */
542         if (current == p)
543                 self_ipi_pending = TRUE;
544
545         switch (p->state) {
546                 case PROC_DYING: // someone else killed this already.
547                         __proc_unlock_ipi_pending(p, self_ipi_pending);
548                         return;
549                 case PROC_RUNNABLE_M:
550                         /* Need to reclaim any cores this proc might have, even though it's
551                          * not running yet. */
552                         __proc_take_allcores(p, NULL, NULL, NULL, NULL);
553                         // fallthrough
554                 case PROC_RUNNABLE_S:
555                         // Think about other lists, like WAITING, or better ways to do this
556                         deschedule_proc(p);
557                         break;
558                 case PROC_RUNNING_S:
559                         #if 0
560                         // here's how to do it manually
561                         if (current == p) {
562                                 lcr3(boot_cr3);
563                                 proc_decref(p, 1); // this decref is for the cr3
564                                 current = NULL;
565                         }
566                         #endif
567                         send_kernel_message(p->procinfo->vcoremap[0].pcoreid, __death,
568                                            (void *SNT)0, (void *SNT)0, (void *SNT)0,
569                                            KMSG_ROUTINE);
570                         __seq_start_write(&p->procinfo->coremap_seqctr);
571                         // TODO: might need to sort num_vcores too later (VC#)
572                         /* vcore is unmapped on the receive side */
573                         __seq_end_write(&p->procinfo->coremap_seqctr);
574                         #if 0
575                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
576                          * managed by the idlecoremap.  so don't do this yet. */
577                         put_idle_core(p->procinfo->vcoremap[0].pcoreid);
578                         #endif
579                         break;
580                 case PROC_RUNNING_M:
581                         /* Send the DEATH message to every core running this process, and
582                          * deallocate the cores.
583                          * The rule is that the vcoremap is set before proc_run, and reset
584                          * within proc_destroy */
585                         __proc_take_allcores(p, __death, (void *SNT)0, (void *SNT)0,
586                                              (void *SNT)0);
587                         break;
588                 default:
589                         panic("Weird state(%s) in %s()", procstate2str(p->state),
590                               __FUNCTION__);
591         }
592         __proc_set_state(p, PROC_DYING);
593         /* this decref is for the process in general */
594         p->env_refcnt--; // TODO (REF)
595         //proc_decref(p, 1);
596
597         /* Unlock and possible decref and wait.  A death IPI should be on its way,
598          * either from the RUNNING_S one, or from proc_take_cores with a __death.
599          * in general, interrupts should be on when you call proc_destroy locally,
600          * but currently aren't for all things (like traphandlers). */
601         __proc_unlock_ipi_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_irqsave(&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_irqsave(&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_irqsave(&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_irqsave(&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                         spin_lock_irqsave(&p->proc_lock);
761                                 if ((p->state & PROC_RUNNING_M) && // TODO: (VC#) (_S state)
762                                               (p->procinfo->vcoremap[vcoreid].valid)) {
763                                         printk("[kernel] sending notif to vcore %d\n", vcoreid);
764                                         send_kernel_message(p->procinfo->vcoremap[vcoreid].pcoreid,
765                                                             __notify, p, 0, 0, KMSG_ROUTINE);
766                                 } else { // TODO: think about this, fallback, etc
767                                         warn("Vcore unmapped, not receiving an active notif");
768                                 }
769                         spin_unlock_irqsave(&p->proc_lock);
770                 }
771         }
772 }
773
774 /* Sends notification number notif to proc p.  Meant for generic notifications /
775  * reference implementation.  do_notify does the real work.  This one mostly
776  * just determines where the notif should be sent, other checks, etc.
777  * Specifically, it handles the parameters of notif_methods.  If you happen to
778  * notify yourself, make sure you process routine kmsgs. */
779 void proc_notify(struct proc *p, unsigned int notif, struct notif_event *ne)
780 {
781         assert(notif < MAX_NR_NOTIF); // notifs start at 0
782         struct notif_method *nm = &p->procdata->notif_methods[notif];
783         struct notif_event local_ne;
784         
785         /* Caller can opt to not send an NE, in which case we use the notif */
786         if (!ne) {
787                 ne = &local_ne;
788                 ne->ne_type = notif;
789         }
790
791         if (!(nm->flags & NOTIF_WANTED))
792                 return;
793         do_notify(p, nm->vcoreid, ne->ne_type, ne);
794 }
795
796 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
797  * out). */
798 uint32_t proc_get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
799 {
800         uint32_t vcoreid;
801         // TODO: the code currently doesn't track the vcoreid properly for _S (VC#)
802         spin_lock_irqsave(&p->proc_lock);
803         switch (p->state) {
804                 case PROC_RUNNING_S:
805                         spin_unlock_irqsave(&p->proc_lock);
806                         return 0; // TODO: here's the ugly part
807                 case PROC_RUNNING_M:
808                         vcoreid = get_vcoreid(p, pcoreid);
809                         spin_unlock_irqsave(&p->proc_lock);
810                         return vcoreid;
811                 case PROC_DYING: // death message is on the way
812                         spin_unlock_irqsave(&p->proc_lock);
813                         return 0;
814                 default:
815                         spin_unlock_irqsave(&p->proc_lock);
816                         panic("Weird state(%s) in %s()", procstate2str(p->state),
817                               __FUNCTION__);
818         }
819 }
820
821 /* Gives process p the additional num cores listed in pcorelist.  You must be
822  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
823  * startup your new cores at the entry point with their virtual IDs (or restore
824  * a preemption).  If you're RUNNABLE_M, you should call proc_run after this so
825  * that the process can start to use its cores.
826  *
827  * If you're *_S, make sure your core0's TF is set (which is done when coming in
828  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
829  * Then call proc_run().
830  *
831  * The reason I didn't bring the _S cases from core_request over here is so we
832  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
833  * this is called from another core, and to avoid the need_to_idle business.
834  * The other way would be to have this function have the side effect of changing
835  * state, and finding another way to do the need_to_idle.
836  *
837  * The returned bool signals whether or not a stack-crushing IPI will come in
838  * once you unlock after this function.
839  *
840  * WARNING: You must hold the proc_lock before calling this! */
841 bool __proc_give_cores(struct proc *SAFE p, uint32_t *pcorelist, size_t num)
842 { TRUSTEDBLOCK
843         bool self_ipi_pending = FALSE;
844         uint32_t free_vcoreid = 0;
845         switch (p->state) {
846                 case (PROC_RUNNABLE_S):
847                 case (PROC_RUNNING_S):
848                         panic("Don't give cores to a process in a *_S state!\n");
849                         break;
850                 case (PROC_DYING):
851                         panic("Attempted to give cores to a DYING process.\n");
852                         break;
853                 case (PROC_RUNNABLE_M):
854                         // set up vcoremap.  list should be empty, but could be called
855                         // multiple times before proc_running (someone changed their mind?)
856                         if (p->procinfo->num_vcores) {
857                                 printk("[kernel] Yaaaaaarrrrr!  Giving extra cores, are we?\n");
858                                 // debugging: if we aren't packed, then there's a problem
859                                 // somewhere, like someone forgot to take vcores after
860                                 // preempting.
861                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
862                                         assert(p->procinfo->vcoremap[i].valid);
863                         }
864                         // add new items to the vcoremap
865                         __seq_start_write(&p->procinfo->coremap_seqctr);
866                         for (int i = 0; i < num; i++) {
867                                 // find the next free slot, which should be the next one
868                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
869                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
870                                        pcorelist[i]);
871                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
872                                 p->procinfo->num_vcores++;
873                         }
874                         __seq_end_write(&p->procinfo->coremap_seqctr);
875                         break;
876                 case (PROC_RUNNING_M):
877                         /* Up the refcnt, since num cores are going to start using this
878                          * process and have it loaded in their 'current'. */
879                         // TODO: (REF) use proc_incref once we have atomics
880                         p->env_refcnt += num;
881                         __seq_start_write(&p->procinfo->coremap_seqctr);
882                         for (int i = 0; i < num; i++) {
883                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
884                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
885                                        pcorelist[i]);
886                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
887                                 p->procinfo->num_vcores++;
888                                 send_kernel_message(pcorelist[i], __startcore, p, 0, 0,
889                                                     KMSG_ROUTINE);
890                                 if (pcorelist[i] == core_id())
891                                         self_ipi_pending = TRUE;
892                         }
893                         __seq_end_write(&p->procinfo->coremap_seqctr);
894                         break;
895                 default:
896                         panic("Weird state(%s) in %s()", procstate2str(p->state),
897                               __FUNCTION__);
898         }
899         p->resources[RES_CORES].amt_granted += num;
900         return self_ipi_pending;
901 }
902
903 /* Makes process p's coremap look like pcorelist (add, remove, etc).  Caller
904  * needs to know what cores are free after this call (removed, failed, etc).
905  * This info will be returned via corelist and *num.  This will send message to
906  * any cores that are getting removed.
907  *
908  * Before implementing this, we should probably think about when this will be
909  * used.  Implies preempting for the message.  The more that I think about this,
910  * the less I like it.  For now, don't use this, and think hard before
911  * implementing it.
912  *
913  * WARNING: You must hold the proc_lock before calling this! */
914 bool __proc_set_allcores(struct proc *SAFE p, uint32_t *pcorelist,
915                          size_t *num, amr_t message,TV(a0t) arg0,
916                          TV(a1t) arg1, TV(a2t) arg2)
917 {
918         panic("Set all cores not implemented.\n");
919 }
920
921 /* Takes from process p the num cores listed in pcorelist, using the given
922  * message for the kernel message (__death, __preempt, etc).  Like the others
923  * in this function group, bool signals whether or not an IPI is pending.
924  *
925  * WARNING: You must hold the proc_lock before calling this! */
926 bool __proc_take_cores(struct proc *SAFE p, uint32_t *pcorelist,
927                        size_t num, amr_t message, TV(a0t) arg0,
928                        TV(a1t) arg1, TV(a2t) arg2)
929 { TRUSTEDBLOCK
930         uint32_t vcoreid, pcoreid;
931         bool self_ipi_pending = FALSE;
932         switch (p->state) {
933                 case (PROC_RUNNABLE_M):
934                         assert(!message);
935                         break;
936                 case (PROC_RUNNING_M):
937                         assert(message);
938                         break;
939                 default:
940                         panic("Weird state(%s) in %s()", procstate2str(p->state),
941                               __FUNCTION__);
942         }
943         spin_lock(&idle_lock);
944         assert((num <= p->procinfo->num_vcores) &&
945                (num_idlecores + num <= num_cpus));
946         spin_unlock(&idle_lock);
947         __seq_start_write(&p->procinfo->coremap_seqctr);
948         for (int i = 0; i < num; i++) {
949                 vcoreid = get_vcoreid(p, pcorelist[i]);
950                 // while ugly, this is done to facilitate merging with take_all_cores
951                 pcoreid = p->procinfo->vcoremap[vcoreid].pcoreid;
952                 assert(pcoreid == pcorelist[i]);
953                 if (message) {
954                         if (pcoreid == core_id())
955                                 self_ipi_pending = TRUE;
956                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
957                                             KMSG_ROUTINE);
958                 } else {
959                         /* if there was a msg, the vcore is unmapped on the receive side.
960                          * o/w, we need to do it here. */
961                         __unmap_vcore(p, vcoreid);
962                 }
963                 // give the pcore back to the idlecoremap
964                 put_idle_core(pcoreid);
965         }
966         p->procinfo->num_vcores -= num;
967         __seq_end_write(&p->procinfo->coremap_seqctr);
968         p->resources[RES_CORES].amt_granted -= num;
969         return self_ipi_pending;
970 }
971
972 /* Takes all cores from a process, which must be in an _M state.  Cores are
973  * placed back in the idlecoremap.  If there's a message, such as __death or
974  * __preempt, it will be sent to the cores.  The bool signals whether or not an
975  * IPI is coming in once you unlock.
976  *
977  * WARNING: You must hold the proc_lock before calling this! */
978 bool __proc_take_allcores(struct proc *SAFE p, amr_t message,
979                           TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
980 {
981         uint32_t active_vcoreid = 0, pcoreid;
982         bool self_ipi_pending = FALSE;
983         switch (p->state) {
984                 case (PROC_RUNNABLE_M):
985                         assert(!message);
986                         break;
987                 case (PROC_RUNNING_M):
988                         assert(message);
989                         break;
990                 default:
991                         panic("Weird state(%s) in %s()", procstate2str(p->state),
992                               __FUNCTION__);
993         }
994         spin_lock(&idle_lock);
995         assert(num_idlecores + p->procinfo->num_vcores <= num_cpus); // sanity
996         spin_unlock(&idle_lock);
997         __seq_start_write(&p->procinfo->coremap_seqctr);
998         for (int i = 0; i < p->procinfo->num_vcores; i++) {
999                 // find next active vcore
1000                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1001                 pcoreid = p->procinfo->vcoremap[active_vcoreid].pcoreid;
1002                 if (message) {
1003                         if (pcoreid == core_id())
1004                                 self_ipi_pending = TRUE;
1005                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
1006                                             KMSG_ROUTINE);
1007                 } else {
1008                         /* if there was a msg, the vcore is unmapped on the receive side.
1009                          * o/w, we need to do it here. */
1010                         __unmap_vcore(p, active_vcoreid);
1011                 }
1012                 // give the pcore back to the idlecoremap
1013                 put_idle_core(pcoreid);
1014                 active_vcoreid++; // for the next loop, skip the one we just used
1015         }
1016         p->procinfo->num_vcores = 0;
1017         __seq_end_write(&p->procinfo->coremap_seqctr);
1018         p->resources[RES_CORES].amt_granted = 0;
1019         return self_ipi_pending;
1020 }
1021
1022 /* Helper, to be used when unlocking after calling the above functions that
1023  * might cause an IPI to be sent.  There should already be a kmsg waiting for
1024  * us, since when we checked state to see a message was coming, the message had
1025  * already been sent before unlocking.  Note we do not need interrupts enabled
1026  * for this to work (you can receive a message before its IPI by polling).
1027  *
1028  * TODO: consider inlining this, so __FUNCTION__ works (will require effort in
1029  * core_request(). */
1030 void __proc_unlock_ipi_pending(struct proc *p, bool ipi_pending)
1031 {
1032         if (ipi_pending) {
1033                 p->env_refcnt--; // TODO: (REF) (atomics)
1034                 spin_unlock_irqsave(&p->proc_lock);
1035                 process_routine_kmsg();
1036                 panic("stack-killing kmsg not found in %s!!!", __FUNCTION__);
1037         } else {
1038                 spin_unlock_irqsave(&p->proc_lock);
1039         }
1040 }
1041
1042 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
1043  * calling. */
1044 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
1045 {
1046         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
1047         p->procinfo->vcoremap[vcoreid].valid = TRUE;
1048         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
1049         p->procinfo->pcoremap[pcoreid].valid = TRUE;
1050 }
1051
1052 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
1053  * calling. */
1054 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
1055 {
1056         p->procinfo->vcoremap[vcoreid].valid = FALSE;
1057         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid = FALSE;
1058 }
1059
1060 /* This takes a referenced process and ups the refcnt by count.  If the refcnt
1061  * was already 0, then someone has a bug, so panic.  Check out the Documentation
1062  * for brutal details about refcnting.
1063  *
1064  * Implementation aside, the important thing is that we atomically increment
1065  * only if it wasn't already 0.  If it was 0, panic.
1066  *
1067  * TODO: (REF) change to use CAS / atomics. */
1068 void proc_incref(struct proc *p, size_t count)
1069 {
1070         spin_lock_irqsave(&p->proc_lock);
1071         if (p->env_refcnt)
1072                 p->env_refcnt += count;
1073         else
1074                 panic("Tried to incref a proc with no existing refernces!");
1075         spin_unlock_irqsave(&p->proc_lock);
1076 }
1077
1078 /* When the kernel is done with a process, it decrements its reference count.
1079  * When the count hits 0, no one is using it and it should be freed.  "Last one
1080  * out" actually finalizes the death of the process.  This is tightly coupled
1081  * with the previous function (incref)
1082  *
1083  * TODO: (REF) change to use CAS.  Note that when we do so, we may be holding
1084  * the process lock when calling __proc_free(). */
1085 void proc_decref(struct proc *p, size_t count)
1086 {
1087         spin_lock_irqsave(&p->proc_lock);
1088         p->env_refcnt -= count;
1089         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
1090         spin_unlock_irqsave(&p->proc_lock);
1091         // if we hit 0, no one else will increment and we can check outside the lock
1092         if (!refcnt)
1093                 __proc_free(p);
1094         if (refcnt < 0)
1095                 panic("Too many decrefs!");
1096 }
1097
1098 /* Kernel message handler to start a process's context on this core.  Tightly
1099  * coupled with proc_run().  Interrupts are disabled. */
1100 void __startcore(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1101 {
1102         uint32_t pcoreid = core_id(), vcoreid;
1103         struct proc *p_to_run = (struct proc *CT(1))a0;
1104         struct trapframe local_tf;
1105         struct preempt_data *vcpd;
1106
1107         assert(p_to_run);
1108         /* the sender of the amsg increfed, thinking we weren't running current. */
1109         if (p_to_run == current)
1110                 proc_decref(p_to_run, 1);
1111         vcoreid = get_vcoreid(p_to_run, pcoreid);
1112         vcpd = &p_to_run->procdata->vcore_preempt_data[vcoreid];
1113         printd("[kernel] startcore on physical core %d for process %d's vcore %d\n",
1114                pcoreid, p_to_run->pid, vcoreid);
1115
1116         if (seq_is_locked(vcpd->preempt_tf_valid)) {
1117                 __seq_end_write(&vcpd->preempt_tf_valid); /* mark tf as invalid */
1118                 restore_fp_state(&vcpd->preempt_anc);
1119                 /* notif_pending and enabled means the proc wants to receive the IPI,
1120                  * but might have missed it.  copy over the tf so they can restart it
1121                  * later, and give them a fresh vcore. */
1122                 if (vcpd->notif_pending && vcpd->notif_enabled) {
1123                         vcpd->notif_tf = vcpd->preempt_tf; // could memset
1124                         proc_init_trapframe(&local_tf, vcoreid, p_to_run->env_entry,
1125                                             vcpd->transition_stack);
1126                         vcpd->notif_enabled = FALSE;
1127                         vcpd->notif_pending = FALSE;
1128                 } else {
1129                         /* copy-in the tf we'll pop, then set all security-related fields */
1130                         local_tf = vcpd->preempt_tf;
1131                         proc_secure_trapframe(&local_tf);
1132                 }
1133         } else { /* not restarting from a preemption, use a fresh vcore */
1134                 proc_init_trapframe(&local_tf, vcoreid, p_to_run->env_entry,
1135                                     vcpd->transition_stack);
1136                 /* Disable/mask active notifications for fresh vcores */
1137                 vcpd->notif_enabled = FALSE;
1138         }
1139         __proc_startcore(p_to_run, &local_tf); // TODO: (HSS) pass silly state *?
1140 }
1141
1142 /* Bail out if it's the wrong process, or if they no longer want a notif.  Make
1143  * sure that you are passing in a user tf (otherwise, it's a bug).  Try not to
1144  * grab locks or write access to anything that isn't per-core in here. */
1145 void __notify(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1146 {
1147         struct user_trapframe local_tf;
1148         struct preempt_data *vcpd;
1149         uint32_t vcoreid;
1150         struct proc *p = (struct proc*)a0;
1151
1152         if (p != current)
1153                 return;
1154         assert(!in_kernel(tf));
1155         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1156          * mapping would only happen if the vcore was free, which it isn't until
1157          * after we unmap. */
1158         vcoreid = get_vcoreid(p, core_id());
1159         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1160         printd("received active notification for proc %d's vcore %d on pcore %d\n",
1161                p->procinfo->pid, vcoreid, core_id());
1162         /* sort signals.  notifs are now masked, like an interrupt gate */
1163         if (!vcpd->notif_enabled)
1164                 return;
1165         vcpd->notif_enabled = FALSE;
1166         vcpd->notif_pending = FALSE; // no longer pending - it made it here
1167         /* save the old tf in the notify slot, build and pop a new one.  Note that
1168          * silly state isn't our business for a notification. */        
1169         // TODO: this is assuming the struct user_tf is the same as a regular TF
1170         vcpd->notif_tf = *tf;
1171         memset(&local_tf, 0, sizeof(local_tf));
1172         proc_init_trapframe(&local_tf, vcoreid, p->env_entry,
1173                             vcpd->transition_stack);
1174         __proc_startcore(p, &local_tf);
1175 }
1176
1177 /* Stop running whatever context is on this core, load a known-good cr3, and
1178  * 'idle'.  Note this leaves no trace of what was running. This "leaves the
1179  * process's context. */
1180 void abandon_core(void)
1181 {
1182         if (current)
1183                 __abandon_core();
1184         smp_idle();
1185 }
1186
1187 void __preempt(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1188 {
1189         struct preempt_data *vcpd;
1190         uint32_t vcoreid, coreid = core_id();
1191         struct proc *p = (struct proc*)a0;
1192
1193         if (p != current)
1194                 warn("__preempt arrived for a process that was not current!");
1195         assert(!in_kernel(tf));
1196         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1197          * mapping would only happen if the vcore was free, which it isn't until
1198          * after we unmap. */
1199         vcoreid = get_vcoreid(p, coreid);
1200         p->procinfo->vcoremap[vcoreid].preempt_served = FALSE;
1201         /* either __preempt or proc_yield() ends the preempt phase. */
1202         p->procinfo->vcoremap[vcoreid].preempt_pending = 0;
1203         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1204         printk("[kernel] received __preempt for proc %d's vcore %d on pcore %d\n",
1205                p->procinfo->pid, vcoreid, core_id());
1206
1207         /* save the old tf in the preempt slot, save the silly state, and signal the
1208          * state is a valid tf.  when it is 'written,' it is valid.  Using the
1209          * seq_ctrs so userspace can tell between different valid versions.  If the
1210          * TF was already valid, it will panic (if CONFIGed that way). */
1211         // TODO: this is assuming the struct user_tf is the same as a regular TF
1212         vcpd->preempt_tf = *tf;
1213         save_fp_state(&vcpd->preempt_anc);
1214         __seq_start_write(&vcpd->preempt_tf_valid);
1215         __unmap_vcore(p, vcoreid);
1216         abandon_core();
1217 }
1218
1219 /* Kernel message handler to clean up the core when a process is dying.
1220  * Note this leaves no trace of what was running.
1221  * It's okay if death comes to a core that's already idling and has no current.
1222  * It could happen if a process decref'd before __proc_startcore could incref. */
1223 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
1224              void *SNT a2)
1225 {
1226         uint32_t vcoreid, coreid = core_id();
1227         if (current) {
1228                 vcoreid = get_vcoreid(current, coreid);
1229                 printd("[kernel] death on physical core %d for process %d's vcore %d\n",
1230                        coreid, current->pid, vcoreid);
1231                 __unmap_vcore(current, vcoreid);
1232         }
1233         abandon_core();
1234 }
1235
1236 void print_idlecoremap(void)
1237 {
1238         spin_lock(&idle_lock);
1239         printk("There are %d idle cores.\n", num_idlecores);
1240         for (int i = 0; i < num_idlecores; i++)
1241                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
1242         spin_unlock(&idle_lock);
1243 }
1244
1245 void print_allpids(void)
1246 {
1247         spin_lock(&pid_hash_lock);
1248         if (hashtable_count(pid_hash)) {
1249                 hashtable_itr_t *phtable_i = hashtable_iterator(pid_hash);
1250                 printk("PID      STATE    \n");
1251                 printk("------------------\n");
1252                 do {
1253                         struct proc *p = hashtable_iterator_value(phtable_i);
1254                         printk("%8d %s\n", hashtable_iterator_key(phtable_i),
1255                                p ? procstate2str(p->state) : "(null)");
1256                 } while (hashtable_iterator_advance(phtable_i));
1257         }
1258         spin_unlock(&pid_hash_lock);
1259 }
1260
1261 void print_proc_info(pid_t pid)
1262 {
1263         int j = 0;
1264         struct proc *p = pid2proc(pid);
1265         // not concerned with a race on the state...
1266         if (!p) {
1267                 printk("Bad PID.\n");
1268                 return;
1269         }
1270         spinlock_debug(&p->proc_lock);
1271         spin_lock_irqsave(&p->proc_lock);
1272         printk("struct proc: %p\n", p);
1273         printk("PID: %d\n", p->pid);
1274         printk("PPID: %d\n", p->ppid);
1275         printk("State: 0x%08x\n", p->state);
1276         printk("Refcnt: %d\n", p->env_refcnt - 1); // don't report our ref
1277         printk("Flags: 0x%08x\n", p->env_flags);
1278         printk("CR3(phys): 0x%08x\n", p->env_cr3);
1279         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
1280         printk("Vcoremap:\n");
1281         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1282                 j = get_busy_vcoreid(p, j);
1283                 printk("\tVcore %d: Pcore %d\n", j, p->procinfo->vcoremap[j].pcoreid);
1284                 j++;
1285         }
1286         printk("Resources:\n");
1287         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
1288                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
1289                        p->resources[i].amt_wanted, p->resources[i].amt_granted);
1290         printk("Vcore 0's Last Trapframe:\n");
1291         print_trapframe(&p->env_tf);
1292         spin_unlock_irqsave(&p->proc_lock);
1293         proc_decref(p, 1); /* decref for the pid2proc reference */
1294 }