Adds a pcoremap for reverse lookups
[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 <arch/arch.h>
12 #include <arch/bitmask.h>
13 #include <process.h>
14 #include <atomic.h>
15 #include <smp.h>
16 #include <pmap.h>
17 #include <trap.h>
18 #include <schedule.h>
19 #include <manager.h>
20 #include <stdio.h>
21 #include <assert.h>
22 #include <timing.h>
23 #include <hashtable.h>
24 #include <slab.h>
25 #include <sys/queue.h>
26 #include <frontend.h>
27
28 /* Process Lists */
29 struct proc_list proc_runnablelist = TAILQ_HEAD_INITIALIZER(proc_runnablelist);
30 spinlock_t runnablelist_lock = SPINLOCK_INITIALIZER;
31 struct kmem_cache *proc_cache;
32
33 /* Tracks which cores are idle, similar to the vcoremap.  Each value is the
34  * physical coreid of an unallocated core. */
35 spinlock_t idle_lock = SPINLOCK_INITIALIZER;
36 uint32_t LCKD(&idle_lock) (RO idlecoremap)[MAX_NUM_CPUS];
37 uint32_t LCKD(&idle_lock) num_idlecores = 0;
38
39 /* Helper function to return a core to the idlemap.  It causes some more lock
40  * acquisitions (like in a for loop), but it's a little easier.  Plus, one day
41  * we might be able to do this without locks (for the putting). */
42 static void put_idle_core(uint32_t coreid)
43 {
44         spin_lock(&idle_lock);
45         idlecoremap[num_idlecores++] = coreid;
46         spin_unlock(&idle_lock);
47 }
48
49 /* Other helpers, implemented later. */
50 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev);
51 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev);
52 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid);
53 static uint32_t get_vcoreid(struct proc *SAFE p, uint32_t pcoreid);
54 static inline void __wait_for_ipi(const char *fnname);
55
56 /* PID management. */
57 #define PID_MAX 32767 // goes from 0 to 32767, with 0 reserved
58 static DECL_BITMASK(pid_bmask, PID_MAX + 1);
59 spinlock_t pid_bmask_lock = SPINLOCK_INITIALIZER;
60 struct hashtable *pid_hash;
61 spinlock_t pid_hash_lock; // initialized in proc_init
62
63 /* Finds the next free entry (zero) entry in the pid_bitmask.  Set means busy.
64  * PID 0 is reserved (in proc_init).  A return value of 0 is a failure (and
65  * you'll also see a warning, for now).  Consider doing this with atomics. */
66 static pid_t get_free_pid(void)
67 {
68         static pid_t next_free_pid = 1;
69         pid_t my_pid = 0;
70
71         spin_lock(&pid_bmask_lock);
72         // atomically (can lock for now, then change to atomic_and_return
73         FOR_CIRC_BUFFER(next_free_pid, PID_MAX + 1, i) {
74                 // always points to the next to test
75                 next_free_pid = (next_free_pid + 1) % (PID_MAX + 1);
76                 if (!GET_BITMASK_BIT(pid_bmask, i)) {
77                         SET_BITMASK_BIT(pid_bmask, i);
78                         my_pid = i;
79                         break;
80                 }
81         }
82         spin_unlock(&pid_bmask_lock);
83         if (!my_pid)
84                 warn("Shazbot!  Unable to find a PID!  You need to deal with this!\n");
85         return my_pid;
86 }
87
88 /* Return a pid to the pid bitmask */
89 static void put_free_pid(pid_t pid)
90 {
91         spin_lock(&pid_bmask_lock);
92         CLR_BITMASK_BIT(pid_bmask, pid);
93         spin_unlock(&pid_bmask_lock);
94 }
95
96 /* While this could be done with just an assignment, this gives us the
97  * opportunity to check for bad transitions.  Might compile these out later, so
98  * we shouldn't rely on them for sanity checking from userspace.  */
99 int __proc_set_state(struct proc *p, uint32_t state)
100 {
101         uint32_t curstate = p->state;
102         /* Valid transitions:
103          * C   -> RBS
104          * RBS -> RGS
105          * RGS -> RBS
106          * RGS -> W
107          * W   -> RBS
108          * RGS -> RBM
109          * RBM -> RGM
110          * RGM -> RBM
111          * RGM -> RBS
112          * RGS -> D
113          * RGM -> D
114          *
115          * These ought to be implemented later (allowed, not thought through yet).
116          * RBS -> D
117          * RBM -> D
118          *
119          * This isn't allowed yet, should be later.  Is definitely causable.
120          * C   -> D
121          */
122         #if 1 // some sort of correctness flag
123         switch (curstate) {
124                 case PROC_CREATED:
125                         if (state != PROC_RUNNABLE_S)
126                                 panic("Invalid State Transition! PROC_CREATED to %d", state);
127                         break;
128                 case PROC_RUNNABLE_S:
129                         if (!(state & (PROC_RUNNING_S | PROC_DYING)))
130                                 panic("Invalid State Transition! PROC_RUNNABLE_S to %d", state);
131                         break;
132                 case PROC_RUNNING_S:
133                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
134                                        PROC_DYING)))
135                                 panic("Invalid State Transition! PROC_RUNNING_S to %d", state);
136                         break;
137                 case PROC_WAITING:
138                         if (state != PROC_RUNNABLE_S)
139                                 panic("Invalid State Transition! PROC_WAITING to %d", state);
140                         break;
141                 case PROC_DYING:
142                         if (state != PROC_CREATED) // when it is reused (TODO)
143                                 panic("Invalid State Transition! PROC_DYING to %d", state);
144                         break;
145                 case PROC_RUNNABLE_M:
146                         if (!(state & (PROC_RUNNING_M | PROC_DYING)))
147                                 panic("Invalid State Transition! PROC_RUNNABLE_M to %d", state);
148                         break;
149                 case PROC_RUNNING_M:
150                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_DYING)))
151                                 panic("Invalid State Transition! PROC_RUNNING_M to %d", state);
152                         break;
153         }
154         #endif
155         p->state = state;
156         return 0;
157 }
158
159 /* Returns a pointer to the proc with the given pid, or 0 if there is none */
160 struct proc *pid2proc(pid_t pid)
161 {
162         spin_lock(&pid_hash_lock);
163         struct proc *p = hashtable_search(pid_hash, (void*)pid);
164         spin_unlock(&pid_hash_lock);
165         /* if the refcnt was 0, decref and return 0 (we failed). (TODO) */
166         if (p)
167                 proc_incref(p, 1); // TODO:(REF) to do this all atomically and not panic
168         return p;
169 }
170
171 /* Performs any initialization related to processes, such as create the proc
172  * cache, prep the scheduler, etc.  When this returns, we should be ready to use
173  * any process related function. */
174 void proc_init(void)
175 {
176         proc_cache = kmem_cache_create("proc", sizeof(struct proc),
177                      MAX(HW_CACHE_ALIGN, __alignof__(struct proc)), 0, 0, 0);
178         /* Init PID mask and hash.  pid 0 is reserved. */
179         SET_BITMASK_BIT(pid_bmask, 0);
180         spinlock_init(&pid_hash_lock);
181         spin_lock(&pid_hash_lock);
182         pid_hash = create_hashtable(100, __generic_hash, __generic_eq);
183         spin_unlock(&pid_hash_lock);
184         schedule_init();
185         /* Init idle cores. Core 0 is the management core, and core 1 is
186      * dedicated to the NIC currently */
187         spin_lock(&idle_lock);
188         #ifdef __CONFIG_NETWORKING__
189         assert(num_cpus >= 2);
190         int reserved_cores = 2;
191         #else
192         int reserved_cores = 1;
193         #endif
194         num_idlecores = num_cpus - reserved_cores;
195         for (int i = 0; i < num_idlecores; i++)
196                 idlecoremap[i] = i + reserved_cores;
197         spin_unlock(&idle_lock);
198         atomic_init(&num_envs, 0);
199 }
200
201 void
202 proc_init_procinfo(struct proc* p)
203 {
204         memset(&p->procinfo->vcoremap, 0, sizeof(p->procinfo->vcoremap));
205         memset(&p->procinfo->pcoremap, 0, sizeof(p->procinfo->pcoremap));
206         p->procinfo->num_vcores = 0;
207         // TODO: change these too
208         p->procinfo->pid = p->pid;
209         p->procinfo->ppid = p->ppid;
210         p->procinfo->tsc_freq = system_timing.tsc_freq;
211         // TODO: maybe do something smarter here
212         p->procinfo->max_harts = MAX(1,num_cpus-1);
213 }
214
215 /* Allocates and initializes a process, with the given parent.  Currently
216  * writes the *p into **pp, and returns 0 on success, < 0 for an error.
217  * Errors include:
218  *  - ENOFREEPID if it can't get a PID
219  *  - ENOMEM on memory exhaustion */
220 static error_t proc_alloc(struct proc *SAFE*SAFE pp, pid_t parent_id)
221 {
222         error_t r;
223         struct proc *p;
224
225         if (!(p = kmem_cache_alloc(proc_cache, 0)))
226                 return -ENOMEM;
227
228         { INITSTRUCT(*p)
229
230         // Setup the default map of where to get cache colors from
231         p->cache_colors_map = global_cache_colors_map;
232         p->next_cache_color = 0;
233
234         /* Initialize the address space */
235         if ((r = env_setup_vm(p)) < 0) {
236                 kmem_cache_free(proc_cache, p);
237                 return r;
238         }
239
240         /* Get a pid, then store a reference in the pid_hash */
241         if (!(p->pid = get_free_pid())) {
242                 kmem_cache_free(proc_cache, p);
243                 return -ENOFREEPID;
244         }
245         spin_lock(&pid_hash_lock);
246         hashtable_insert(pid_hash, (void*)p->pid, p);
247         spin_unlock(&pid_hash_lock);
248
249         /* Set the basic status variables. */
250         spinlock_init(&p->proc_lock);
251         p->exitcode = 0;
252         p->ppid = parent_id;
253         p->state = PROC_CREATED; // shouldn't go through state machine for init
254         p->env_refcnt = 2; // one for the object, one for the ref we pass back
255         p->env_flags = 0;
256         p->env_entry = 0; // cheating.  this really gets set in load_icode
257         p->procinfo->heap_bottom = (void*)UTEXT;
258         p->heap_top = (void*)UTEXT;
259         memset(&p->resources, 0, sizeof(p->resources));
260         memset(&p->env_ancillary_state, 0, sizeof(p->env_ancillary_state));
261         memset(&p->env_tf, 0, sizeof(p->env_tf));
262
263         /* Initialize the contents of the e->procinfo structure */
264         proc_init_procinfo(p);
265         /* Initialize the contents of the e->procdata structure */
266
267         /* Initialize the generic syscall ring buffer */
268         SHARED_RING_INIT(&p->procdata->syscallring);
269         /* Initialize the backend of the syscall ring buffer */
270         BACK_RING_INIT(&p->syscallbackring,
271                        &p->procdata->syscallring,
272                        SYSCALLRINGSIZE);
273
274         /* Initialize the generic sysevent ring buffer */
275         SHARED_RING_INIT(&p->procdata->syseventring);
276         /* Initialize the frontend of the sysevent ring buffer */
277         FRONT_RING_INIT(&p->syseventfrontring,
278                         &p->procdata->syseventring,
279                         SYSEVENTRINGSIZE);
280         *pp = p;
281         atomic_inc(&num_envs);
282
283         frontend_proc_init(p);
284
285         printd("[%08x] new process %08x\n", current ? current->pid : 0, p->pid);
286         } // INIT_STRUCT
287         return 0;
288 }
289
290 /* Creates a process from the specified binary, which is of size size.
291  * Currently, the binary must be a contiguous block of memory, which needs to
292  * change.  On any failure, it just panics, which ought to be sorted. */
293 struct proc *proc_create(uint8_t *binary, size_t size)
294 {
295         struct proc *p;
296         error_t r;
297         pid_t curid;
298
299         curid = (current ? current->pid : 0);
300         if ((r = proc_alloc(&p, curid)) < 0)
301                 panic("proc_create: %e", r); // one of 3 quaint usages of %e.
302         if(binary != NULL)
303                 env_load_icode(p, NULL, binary, size);
304         return p;
305 }
306
307 /* This is called by proc_decref, once the last reference to the process is
308  * gone.  Don't call this otherwise (it will panic).  It will clean up the
309  * address space and deallocate any other used memory. */
310 static void __proc_free(struct proc *p)
311 {
312         physaddr_t pa;
313
314         printd("[PID %d] freeing proc: %d\n", current ? current->pid : 0, p->pid);
315         // All parts of the kernel should have decref'd before __proc_free is called
316         assert(p->env_refcnt == 0);
317
318         frontend_proc_free(p);
319
320         // Free any colors allocated to this process
321         if(p->cache_colors_map != global_cache_colors_map) {
322                 for(int i=0; i<llc_cache->num_colors; i++)
323                         cache_color_free(llc_cache, p->cache_colors_map);
324                 cache_colors_map_free(p->cache_colors_map);
325         }
326
327         // Flush all mapped pages in the user portion of the address space
328         env_user_mem_free(p, 0, UVPT);
329         /* These need to be free again, since they were allocated with a refcnt. */
330         free_cont_pages(p->procinfo, LOG2_UP(PROCINFO_NUM_PAGES));
331         free_cont_pages(p->procdata, LOG2_UP(PROCDATA_NUM_PAGES));
332
333         env_pagetable_free(p);
334         p->env_pgdir = 0;
335         p->env_cr3 = 0;
336
337         /* Remove self from the pid hash, return PID.  Note the reversed order. */
338         spin_lock(&pid_hash_lock);
339         if (!hashtable_remove(pid_hash, (void*)p->pid))
340                 panic("Proc not in the pid table in %s", __FUNCTION__);
341         spin_unlock(&pid_hash_lock);
342         put_free_pid(p->pid);
343         atomic_dec(&num_envs);
344
345         /* Dealloc the struct proc */
346         kmem_cache_free(proc_cache, p);
347 }
348
349 /* Whether or not actor can control target.  Note we currently don't need
350  * locking for this. TODO: think about that, esp wrt proc's dying. */
351 bool proc_controls(struct proc *actor, struct proc *target)
352 {
353         return ((actor == target) || (target->ppid == actor->pid));
354 }
355
356 /* Dispatches a process to run, either on the current core in the case of a
357  * RUNNABLE_S, or on its partition in the case of a RUNNABLE_M.  This should
358  * never be called to "restart" a core.  This expects that the "instructions"
359  * for which core(s) to run this on will be in the vcoremap, which needs to be
360  * set externally.
361  *
362  * When a process goes from RUNNABLE_M to RUNNING_M, its vcoremap will be
363  * "packed" (no holes in the vcore->pcore mapping), vcore0 will continue to run
364  * it's old core0 context, and the other cores will come in at the entry point.
365  * Including in the case of preemption.
366  *
367  * This won't return if the current core is going to be one of the processes
368  * cores (either for _S mode or for _M if it's in the vcoremap).  proc_run will
369  * eat your reference if it does not return. */
370 void proc_run(struct proc *p)
371 {
372         bool self_ipi_pending = FALSE;
373         spin_lock_irqsave(&p->proc_lock);
374         switch (p->state) {
375                 case (PROC_DYING):
376                         spin_unlock_irqsave(&p->proc_lock);
377                         printk("Process %d not starting due to async death\n", p->pid);
378                         // if we're a worker core, smp_idle, o/w return
379                         if (!management_core())
380                                 smp_idle(); // this never returns
381                         return;
382                 case (PROC_RUNNABLE_S):
383                         __proc_set_state(p, PROC_RUNNING_S);
384                         /* We will want to know where this process is running, even if it is
385                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
386                          * Also, this is the signal used in trap.c to know to save the tf in
387                          * env_tf. */
388                         // TODO: (VSEQ) signal these vcore changes
389                         p->procinfo->num_vcores = 0;
390                         __map_vcore(p, 0, core_id()); // sort of.  this needs work.
391                         spin_unlock_irqsave(&p->proc_lock);
392                         /* Transferring our reference to startcore, where p will become
393                          * current.  If it already is, decref in advance.  This is similar
394                          * to __startcore(), in that it sorts out the refcnt accounting.  */
395                         if (current == p)
396                                 proc_decref(p, 1);
397                         proc_startcore(p, &p->env_tf);
398                         break;
399                 case (PROC_RUNNABLE_M):
400                         /* vcoremap[i] holds the coreid of the physical core allocated to
401                          * this process.  It is set outside proc_run.  For the active
402                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
403                         if (p->procinfo->num_vcores) {
404                                 __proc_set_state(p, PROC_RUNNING_M);
405                                 int i = 0;
406                                 /* Up the refcnt, since num_vcores are going to start using this
407                                  * process and have it loaded in their 'current'. */
408                                 p->env_refcnt += p->procinfo->num_vcores; // TODO: (REF) use incref
409                                 /* If the core we are running on is in the vcoremap, we will get
410                                  * an IPI (once we reenable interrupts) and never return. */
411                                 if (is_mapped_vcore(p, core_id()))
412                                         self_ipi_pending = TRUE;
413                                 // TODO: handle silly state (HSS)
414                                 // set virtual core 0 to run the main context on transition
415                                 if (p->env_flags & PROC_TRANSITION_TO_M) {
416                                         p->env_flags &= !PROC_TRANSITION_TO_M;
417 #ifdef __IVY__
418                                         send_active_message(p->procinfo->vcoremap[0].pcoreid,
419                                                             __startcore, p,
420                                                             &p->env_tf, (void *SNT)0);
421 #else
422                                         send_active_message(p->procinfo->vcoremap[0].pcoreid,
423                                                             (void *)__startcore, (void *)p,
424                                                                                 (void *)&p->env_tf, 0);
425 #endif
426                                         i = 1; // start at vcore1 in the loop below
427                                 }
428                                 /* handle the others. */
429                                 for (/* i set above */; i < p->procinfo->num_vcores; i++)
430 #ifdef __IVY__
431                                         send_active_message(p->procinfo->vcoremap[i].pcoreid,
432                                                             __startcore, p,
433                                                                                 (trapframe_t *CT(1))NULL, (void *SNT)i);
434 #else
435                                         send_active_message(p->procinfo->vcoremap[i].pcoreid,
436                                                             (void *)__startcore, (void *)p,
437                                                                                 (void *)0, (void *)i);
438 #endif
439                         } else {
440                                 warn("Tried to proc_run() an _M with no vcores!");
441                         }
442                         /* Unlock and decref/wait for the IPI if one is pending.  This will
443                          * eat the reference if we aren't returning. 
444                          *
445                          * There a subtle race avoidance here.  proc_startcore can handle a
446                          * death message, but we can't have the startcore come after the
447                          * death message.  Otherwise, it would look like a new process.  So
448                          * we hold the lock til after we send our message, which prevents a
449                          * possible death message.
450                          * - Likewise, we need interrupts to be disabled, in case one of the
451                          *   messages was for us, and reenable them after letting go of the
452                          *   lock.  This is done by spin_lock_irqsave, so be careful if you
453                          *   change this.
454                          * - Note there is no guarantee this core's interrupts were on, so
455                          *   it may not get the message for a while... */
456                         __proc_unlock_ipi_pending(p, self_ipi_pending);
457                         break;
458                 default:
459                         spin_unlock_irqsave(&p->proc_lock);
460                         panic("Invalid process state %p in proc_run()!!", p->state);
461         }
462 }
463
464 /* Runs the given context (trapframe) of process p on the core this code
465  * executes on.
466  *
467  * Given we are RUNNING_*, an IPI for death or preemption could come in:
468  * 1. death attempt (IPI to kill whatever is on your core):
469  *              we don't need to worry about protecting the stack, since we're
470  *              abandoning ship - just need to get a good cr3 and decref current, which
471  *              the death handler will do.
472  *              If a death IPI comes in, we immediately stop this function and will
473  *              never come back.
474  * 2. preempt attempt (IPI to package state and maybe run something else):
475  *              - if a preempt attempt comes in while we're in the kernel, it'll
476  *              just set a flag.  we could attempt to bundle the kernel state
477  *              and rerun it later, but it's really messy (and possibly given
478  *              back to userspace).  we'll disable ints, check this flag, and if
479  *              so, handle the preemption using the same funcs as the normal
480  *              preemption handler.  nonblocking kernel calls will just slow
481  *              down the preemption while they work.  blocking kernel calls will
482  *              need to package their state properly anyway.
483  *
484  * TODO: in general, think about when we no longer need the stack, in case we
485  * are preempted and expected to run again from somewhere else.  we can't
486  * expect to have the kernel stack around anymore.  the nice thing about being
487  * at this point is that we are just about ready to give up the stack anyways.
488  *
489  * I think we need to make it such that the kernel in "process context" never
490  * gets removed from the core (displaced from its stack) without going through
491  * some "bundling" code.
492  *
493  * A note on refcnting: this function will not return, and your proc reference
494  * will end up stored in current.  This will make no changes to p's refcnt, so
495  * do your accounting such that there is only the +1 for current.  This means if
496  * it is already in current (like in the trap return path), don't up it.  If
497  * it's already in current and you have another reference (like pid2proc or from
498  * an IPI), then down it (which is what happens in __startcore()).  If it's not
499  * in current and you have one reference, like proc_run(non_current_p), then
500  * also do nothing.  The refcnt for your *p will count for the reference stored
501  * in current. */
502 void proc_startcore(struct proc *p, trapframe_t *tf) {
503         // it's possible to be DYING, but it's a rare race.
504         //if (p->state & (PROC_RUNNING_S | PROC_RUNNING_M))
505         //      printk("dying before (re)startcore on core %d\n", core_id());
506         // sucks to have ints disabled when doing env_decref and possibly freeing
507         disable_irq();
508         if (per_cpu_info[core_id()].preempt_pending) {
509                 // TODO: handle preemption
510                 // the functions will need to consider deal with current like down below
511                 panic("Preemption not supported!");
512         }
513         /* If the process wasn't here, then we need to load its address space. */
514         if (p != current) {
515                 /* Do not incref here.  We were given the reference to current,
516                  * pre-upped. */
517                 lcr3(p->env_cr3);
518                 /* This is "leaving the process context" of the previous proc.  The
519                  * previous lcr3 unloaded the previous proc's context.  This should
520                  * rarely happen, since we usually proactively leave process context,
521                  * but is the fallback. */
522                 if (current)
523                         proc_decref(current, 1);
524                 set_current_proc(p);
525         }
526         /* need to load our silly state, preferably somewhere other than here so we
527          * can avoid the case where the context was just running here.  it's not
528          * sufficient to do it in the "new process" if-block above (could be things
529          * like page faults that cause us to keep the same process, but want a
530          * different context.
531          * for now, we load this silly state here. (TODO) (HSS)
532          * We also need this to be per trapframe, and not per process...
533          */
534         env_pop_ancillary_state(p);
535         env_pop_tf(tf);
536 }
537
538 /*
539  * Destroys the given process.  This may be called from another process, a light
540  * kernel thread (no real process context), asynchronously/cross-core, or from
541  * the process on its own core.
542  *
543  * Here's the way process death works:
544  * 0. grab the lock (protects state transition and core map)
545  * 1. set state to dying.  that keeps the kernel from doing anything for the
546  * process (like proc_running it).
547  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
548  * 3. IPI to clean up those cores (decref, etc).
549  * 4. Unlock
550  * 5. Clean up your core, if applicable
551  * (Last core/kernel thread to decref cleans up and deallocates resources.)
552  *
553  * Note that some cores can be processing async calls, but will eventually
554  * decref.  Should think about this more, like some sort of callback/revocation.
555  *
556  * This will eat your reference if it won't return.  Note that this function
557  * needs to change anyways when we make __death more like __preempt.  (TODO) */
558 void proc_destroy(struct proc *p)
559 {
560         bool self_ipi_pending = FALSE;
561         spin_lock_irqsave(&p->proc_lock);
562
563         /* TODO: (DEATH) look at this again when we sort the __death IPI */
564         if (current == p)
565                 self_ipi_pending = TRUE;
566
567         switch (p->state) {
568                 case PROC_DYING: // someone else killed this already.
569                         __proc_unlock_ipi_pending(p, self_ipi_pending);
570                         return;
571                 case PROC_RUNNABLE_M:
572                         /* Need to reclaim any cores this proc might have, even though it's
573                          * not running yet. */
574                         __proc_take_allcores(p, NULL, NULL, NULL, NULL);
575                         // fallthrough
576                 case PROC_RUNNABLE_S:
577                         // Think about other lists, like WAITING, or better ways to do this
578                         deschedule_proc(p);
579                         break;
580                 case PROC_RUNNING_S:
581                         #if 0
582                         // here's how to do it manually
583                         if (current == p) {
584                                 lcr3(boot_cr3);
585                                 proc_decref(p, 1); // this decref is for the cr3
586                                 current = NULL;
587                         }
588                         #endif
589                         send_active_message(p->procinfo->vcoremap[0].pcoreid, __death,
590                                            (void *SNT)0, (void *SNT)0, (void *SNT)0);
591                         // TODO: (VSEQ) signal these vcore changes
592                         __unmap_vcore(p, 0);
593                         #if 0
594                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
595                          * managed by the idlecoremap.  so don't do this yet. */
596                         put_idle_core(p->procinfo->vcoremap[0].pcoreid);
597                         #endif
598                         break;
599                 case PROC_RUNNING_M:
600                         /* Send the DEATH message to every core running this process, and
601                          * deallocate the cores.
602                          * The rule is that the vcoremap is set before proc_run, and reset
603                          * within proc_destroy */
604                         __proc_take_allcores(p, __death, (void *SNT)0, (void *SNT)0,
605                                              (void *SNT)0);
606                         break;
607                 default:
608                         panic("Weird state(0x%08x) in proc_destroy", p->state);
609         }
610         __proc_set_state(p, PROC_DYING);
611         /* this decref is for the process in general */
612         p->env_refcnt--; // TODO (REF)
613         //proc_decref(p, 1);
614
615         /* Unlock and possible decref and wait.  A death IPI should be on its way,
616          * either from the RUNNING_S one, or from proc_take_cores with a __death.
617          * in general, interrupts should be on when you call proc_destroy locally,
618          * but currently aren't for all things (like traphandlers). */
619         __proc_unlock_ipi_pending(p, self_ipi_pending);
620         return;
621 }
622
623 /* Helper function.  Starting from prev, it will find the next free vcoreid,
624  * which is the next vcore that is not valid.
625  * You better hold the lock before calling this. */
626 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev)
627 {
628         uint32_t i;
629         for (i = prev; i < MAX_NUM_CPUS; i++)
630                 if (!p->procinfo->vcoremap[i].valid)
631                         break;
632         if (i + 1 >= MAX_NUM_CPUS)
633                 warn("At the end of the vcorelist.  Might want to check that out.");
634         return i;
635 }
636
637 /* Helper function.  Starting from prev, it will find the next busy vcoreid,
638  * which is the next vcore that is valid.
639  * You better hold the lock before calling this. */
640 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev)
641 {
642         uint32_t i;
643         for (i = prev; i < MAX_NUM_CPUS; i++)
644                 if (p->procinfo->vcoremap[i].valid)
645                         break;
646         if (i + 1 >= MAX_NUM_CPUS)
647                 warn("At the end of the vcorelist.  Might want to check that out.");
648         return i;
649 }
650
651 /* Helper function.  Is the given pcore a mapped vcore?  Hold the lock before
652  * calling. */
653 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
654 {
655         return p->procinfo->pcoremap[pcoreid].valid;
656 }
657
658 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
659  * You better hold the lock before calling this.  Panics on failure. */
660 static uint32_t get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
661 {
662         assert(is_mapped_vcore(p, pcoreid));
663         return p->procinfo->pcoremap[pcoreid].vcoreid;
664 }
665
666 /* Use this when you are waiting for an IPI that you sent yourself.  In most
667  * cases, interrupts should already be on (like after a spin_unlock_irqsave from
668  * process context), but aren't always, like in proc_destroy().  We might be
669  * able to remove the enable_irq in the future.  Think about this (TODO).
670  *
671  * Note this means all non-proc management interrupt handlers must return (which
672  * they need to do anyway), so that we get back to this point.  */
673 static inline void __wait_for_ipi(const char *fnname)
674 {
675         enable_irq();
676         udelay(1000000);
677         panic("Waiting too long on core %d for an IPI in %s()!", core_id(), fnname);
678 }
679
680 /* Yields the calling core.  Must be called locally (not async) for now.
681  * - If RUNNING_S, you just give up your time slice and will eventually return.
682  * - If RUNNING_M, you give up the current vcore (which never returns), and
683  *   adjust the amount of cores wanted/granted.
684  * - If you have only one vcore, you switch to RUNNABLE_M.  When you run again,
685  *   you'll have one guaranteed core, starting from the entry point.
686  *
687  * - RES_CORES amt_wanted will be the amount running after taking away the
688  *   yielder, unless there are none left, in which case it will be 1.
689  *
690  * This does not return (abandon_core()), so it will eat your reference.  */
691 void proc_yield(struct proc *SAFE p)
692 {
693         spin_lock_irqsave(&p->proc_lock);
694         switch (p->state) {
695                 case (PROC_RUNNING_S):
696                         p->env_tf= *current_tf;
697                         env_push_ancillary_state(p);
698                         __proc_set_state(p, PROC_RUNNABLE_S);
699                         schedule_proc(p);
700                         break;
701                 case (PROC_RUNNING_M):
702                         // TODO: (VSEQ) signal these vcore changes
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                         p->resources[RES_CORES].amt_wanted = p->procinfo->num_vcores;
707                         // add to idle list
708                         put_idle_core(core_id());
709                         // last vcore?  then we really want 1, and to yield the gang
710                         if (p->procinfo->num_vcores == 0) {
711                                 // might replace this with m_yield, if we have it directly
712                                 p->resources[RES_CORES].amt_wanted = 1;
713                                 __proc_set_state(p, PROC_RUNNABLE_M);
714                                 schedule_proc(p);
715                         }
716                         break;
717                 default:
718                         // there are races that can lead to this (async death, preempt, etc)
719                         panic("Weird state(0x%08x) in proc_yield", p->state);
720         }
721         spin_unlock_irqsave(&p->proc_lock);
722         proc_decref(p, 1);
723         /* Clean up the core and idle.  For mgmt cores, they will ultimately call
724          * manager, which will call schedule() and will repick the yielding proc. */
725         abandon_core();
726 }
727
728 /* Gives process p the additional num cores listed in pcorelist.  You must be
729  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
730  * startup your new cores at the entry point with their virtual IDs.  If you're
731  * RUNNABLE_M, you should call proc_run after this so that the process can start
732  * to use its cores.
733  *
734  * If you're *_S, make sure your core0's TF is set (which is done when coming in
735  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
736  * Then call proc_run().
737  *
738  * The reason I didn't bring the _S cases from core_request over here is so we
739  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
740  * this is called from another core, and to avoid the need_to_idle business.
741  * The other way would be to have this function have the side effect of changing
742  * state, and finding another way to do the need_to_idle.
743  *
744  * The returned bool signals whether or not a stack-crushing IPI will come in
745  * once you unlock after this function.
746  *
747  * WARNING: You must hold the proc_lock before calling this! */
748 bool __proc_give_cores(struct proc *SAFE p, uint32_t *pcorelist, size_t num)
749 { TRUSTEDBLOCK
750         bool self_ipi_pending = FALSE;
751         uint32_t free_vcoreid = 0;
752         switch (p->state) {
753                 case (PROC_RUNNABLE_S):
754                 case (PROC_RUNNING_S):
755                         panic("Don't give cores to a process in a *_S state!\n");
756                         break;
757                 case (PROC_DYING):
758                         panic("Attempted to give cores to a DYING process.\n");
759                         break;
760                 case (PROC_RUNNABLE_M):
761                         // set up vcoremap.  list should be empty, but could be called
762                         // multiple times before proc_running (someone changed their mind?)
763                         if (p->procinfo->num_vcores) {
764                                 printk("[kernel] Yaaaaaarrrrr!  Giving extra cores, are we?\n");
765                                 // debugging: if we aren't packed, then there's a problem
766                                 // somewhere, like someone forgot to take vcores after
767                                 // preempting.
768                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
769                                         assert(p->procinfo->vcoremap[i].valid);
770                         }
771                         // TODO: (VSEQ) signal these vcore changes
772                         // add new items to the vcoremap
773                         for (int i = 0; i < num; i++) {
774                                 // find the next free slot, which should be the next one
775                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
776                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
777                                        pcorelist[i]);
778                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
779                                 p->procinfo->num_vcores++;
780                         }
781                         break;
782                 case (PROC_RUNNING_M):
783                         /* Up the refcnt, since num cores are going to start using this
784                          * process and have it loaded in their 'current'. */
785                         // TODO: (REF) use proc_incref once we have atomics
786                         p->env_refcnt += num;
787                         // TODO: (VSEQ) signal these vcore changes
788                         for (int i = 0; i < num; i++) {
789                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
790                                 //todo
791                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
792                                        pcorelist[i]);
793                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
794                                 p->procinfo->num_vcores++;
795                                 send_active_message(pcorelist[i], __startcore, p,
796                                                     (struct trapframe *)0,
797                                                     (void*SNT)free_vcoreid);
798                                 if (pcorelist[i] == core_id())
799                                         self_ipi_pending = TRUE;
800                         }
801                         break;
802                 default:
803                         panic("Weird proc state %d in proc_give_cores()!\n", p->state);
804         }
805         return self_ipi_pending;
806 }
807
808 /* Makes process p's coremap look like pcorelist (add, remove, etc).  Caller
809  * needs to know what cores are free after this call (removed, failed, etc).
810  * This info will be returned via corelist and *num.  This will send message to
811  * any cores that are getting removed.
812  *
813  * Before implementing this, we should probably think about when this will be
814  * used.  Implies preempting for the message.  The more that I think about this,
815  * the less I like it.  For now, don't use this, and think hard before
816  * implementing it.
817  *
818  * WARNING: You must hold the proc_lock before calling this! */
819 bool __proc_set_allcores(struct proc *SAFE p, uint32_t *pcorelist,
820                          size_t *num, amr_t message,TV(a0t) arg0,
821                          TV(a1t) arg1, TV(a2t) arg2)
822 {
823         panic("Set all cores not implemented.\n");
824 }
825
826 /* Takes from process p the num cores listed in pcorelist, using the given
827  * message for the active message (__death, __preempt, etc).  Like the others
828  * in this function group, bool signals whether or not an IPI is pending.
829  *
830  * WARNING: You must hold the proc_lock before calling this! */
831 bool __proc_take_cores(struct proc *SAFE p, uint32_t *pcorelist,
832                        size_t num, amr_t message, TV(a0t) arg0,
833                        TV(a1t) arg1, TV(a2t) arg2)
834 { TRUSTEDBLOCK
835         uint32_t vcoreid, pcoreid;
836         bool self_ipi_pending = FALSE;
837         switch (p->state) {
838                 case (PROC_RUNNABLE_M):
839                         assert(!message);
840                         break;
841                 case (PROC_RUNNING_M):
842                         assert(message);
843                         break;
844                 default:
845                         panic("Weird state %d in proc_take_cores()!\n", p->state);
846         }
847         spin_lock(&idle_lock);
848         assert((num <= p->procinfo->num_vcores) &&
849                (num_idlecores + num <= num_cpus));
850         spin_unlock(&idle_lock);
851         // TODO: (VSEQ) signal these vcore changes
852         for (int i = 0; i < num; i++) {
853                 vcoreid = get_vcoreid(p, pcorelist[i]);
854                 pcoreid = p->procinfo->vcoremap[vcoreid].pcoreid;
855                 assert(pcoreid == pcorelist[i]);
856                 if (message) {
857                         if (pcoreid == core_id())
858                                 self_ipi_pending = TRUE;
859                         send_active_message(pcoreid, message, arg0, arg1, arg2);
860                 }
861                 // give the pcore back to the idlecoremap
862                 __unmap_vcore(p, vcoreid);
863                 put_idle_core(pcoreid);
864         }
865         p->procinfo->num_vcores -= num;
866         p->resources[RES_CORES].amt_granted -= num;
867         return self_ipi_pending;
868 }
869
870 /* Takes all cores from a process, which must be in an _M state.  Cores are
871  * placed back in the idlecoremap.  If there's a message, such as __death or
872  * __preempt, it will be sent to the cores.  The bool signals whether or not an
873  * IPI is coming in once you unlock.
874  *
875  * WARNING: You must hold the proc_lock before calling this! */
876 bool __proc_take_allcores(struct proc *SAFE p, amr_t message,
877                           TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
878 {
879         uint32_t active_vcoreid = 0, pcoreid;
880         bool self_ipi_pending = FALSE;
881         switch (p->state) {
882                 case (PROC_RUNNABLE_M):
883                         assert(!message);
884                         break;
885                 case (PROC_RUNNING_M):
886                         assert(message);
887                         break;
888                 default:
889                         panic("Weird state %d in proc_take_allcores()!\n", p->state);
890         }
891         spin_lock(&idle_lock);
892         assert(num_idlecores + p->procinfo->num_vcores <= num_cpus); // sanity
893         spin_unlock(&idle_lock);
894         // TODO: (VSEQ) signal these vcore changes
895         for (int i = 0; i < p->procinfo->num_vcores; i++) {
896                 // find next active vcore
897                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
898                 pcoreid = p->procinfo->vcoremap[active_vcoreid].pcoreid;
899                 if (message) {
900                         if (pcoreid == core_id())
901                                 self_ipi_pending = TRUE;
902                         send_active_message(pcoreid, message, arg0, arg1, arg2);
903                 }
904                 // give the pcore back to the idlecoremap
905                 __unmap_vcore(p, active_vcoreid);
906                 put_idle_core(pcoreid);
907         }
908         p->procinfo->num_vcores = 0;
909         p->resources[RES_CORES].amt_granted = 0;
910         return self_ipi_pending;
911 }
912
913 /* Helper, to be used when unlocking after calling the above functions that
914  * might cause an IPI to be sent.  TODO inline this, so the __FUNCTION__ works.
915  * Will require an overhaul of core_request (break it up, etc) */
916 void __proc_unlock_ipi_pending(struct proc *p, bool ipi_pending)
917 {
918         if (ipi_pending) {
919                 p->env_refcnt--; // TODO: (REF) (atomics)
920                 spin_unlock_irqsave(&p->proc_lock);
921                 __wait_for_ipi(__FUNCTION__);
922         } else {
923                 spin_unlock_irqsave(&p->proc_lock);
924         }
925 }
926
927 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
928  * calling. */
929 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
930 {
931         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
932         p->procinfo->vcoremap[vcoreid].valid = TRUE;
933         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
934         p->procinfo->pcoremap[pcoreid].valid = TRUE;
935 }
936
937 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
938  * calling. */
939 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
940 {
941         p->procinfo->vcoremap[vcoreid].valid = FALSE;
942         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid = FALSE;
943 }
944
945 /* This takes a referenced process and ups the refcnt by count.  If the refcnt
946  * was already 0, then someone has a bug, so panic.  Check out the Documentation
947  * for brutal details about refcnting.
948  *
949  * Implementation aside, the important thing is that we atomically increment
950  * only if it wasn't already 0.  If it was 0, panic.
951  *
952  * TODO: (REF) change to use CAS / atomics. */
953 void proc_incref(struct proc *p, size_t count)
954 {
955         spin_lock_irqsave(&p->proc_lock);
956         if (p->env_refcnt)
957                 p->env_refcnt += count;
958         else
959                 panic("Tried to incref a proc with no existing refernces!");
960         spin_unlock_irqsave(&p->proc_lock);
961 }
962
963 /* When the kernel is done with a process, it decrements its reference count.
964  * When the count hits 0, no one is using it and it should be freed.  "Last one
965  * out" actually finalizes the death of the process.  This is tightly coupled
966  * with the previous function (incref)
967  *
968  * TODO: (REF) change to use CAS.  Note that when we do so, we may be holding
969  * the process lock when calling __proc_free(). */
970 void proc_decref(struct proc *p, size_t count)
971 {
972         spin_lock_irqsave(&p->proc_lock);
973         p->env_refcnt -= count;
974         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
975         spin_unlock_irqsave(&p->proc_lock);
976         // if we hit 0, no one else will increment and we can check outside the lock
977         if (!refcnt)
978                 __proc_free(p);
979         if (refcnt < 0)
980                 panic("Too many decrefs!");
981 }
982
983 /* Active message handler to start a process's context on this core.  Tightly
984  * coupled with proc_run() */
985 #ifdef __IVY__
986 void __startcore(trapframe_t *tf, uint32_t srcid, struct proc *CT(1) a0,
987                  trapframe_t *CT(1) a1, void *SNT a2)
988 #else
989 void __startcore(trapframe_t *tf, uint32_t srcid, void * a0, void * a1,
990                  void * a2)
991 #endif
992 {
993         uint32_t coreid = core_id();
994         uint32_t vcoreid = (uint32_t)a2;
995         struct proc *p_to_run = (struct proc *CT(1))a0;
996         trapframe_t local_tf;
997         trapframe_t *tf_to_pop = (trapframe_t *CT(1))a1;
998
999         printd("[kernel] Startcore on physical core %d for Process %d\n",
1000                coreid, p_to_run->pid);
1001         assert(p_to_run);
1002         // TODO: handle silly state (HSS)
1003         if (!tf_to_pop) {
1004                 tf_to_pop = &local_tf;
1005                 memset(tf_to_pop, 0, sizeof(*tf_to_pop));
1006                 proc_init_trapframe(tf_to_pop, vcoreid, p_to_run->env_entry,
1007                                     p_to_run->procdata->stack_pointers[vcoreid]);
1008         }
1009         /* the sender of the amsg increfed, thinking we weren't running current. */
1010         if (p_to_run == current)
1011                 proc_decref(p_to_run, 1);
1012         proc_startcore(p_to_run, tf_to_pop);
1013 }
1014
1015 /* Stop running whatever context is on this core, load a known-good cr3, and
1016  * 'idle'.  Note this leaves no trace of what was running. This "leaves the
1017  * process's context. */
1018 void abandon_core(void)
1019 {
1020         if (current)
1021                 __abandon_core();
1022         smp_idle();
1023 }
1024
1025 /* Active message handler to clean up the core when a process is dying.
1026  * Note this leaves no trace of what was running.
1027  * It's okay if death comes to a core that's already idling and has no current.
1028  * It could happen if a process decref'd before proc_startcore could incref. */
1029 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
1030              void *SNT a2)
1031 {
1032         abandon_core();
1033 }
1034
1035 void print_idlecoremap(void)
1036 {
1037         spin_lock(&idle_lock);
1038         printk("There are %d idle cores.\n", num_idlecores);
1039         for (int i = 0; i < num_idlecores; i++)
1040                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
1041         spin_unlock(&idle_lock);
1042 }
1043
1044 void print_allpids(void)
1045 {
1046         spin_lock(&pid_hash_lock);
1047         if (hashtable_count(pid_hash)) {
1048                 hashtable_itr_t *phtable_i = hashtable_iterator(pid_hash);
1049                 printk("PID      STATE    \n");
1050                 printk("------------------\n");
1051                 do {
1052                         struct proc *p = hashtable_iterator_value(phtable_i);
1053                         printk("%8d %s\n", hashtable_iterator_key(phtable_i),
1054                                p ? procstate2str(p->state) : "(null)");
1055                 } while (hashtable_iterator_advance(phtable_i));
1056         }
1057         spin_unlock(&pid_hash_lock);
1058 }
1059
1060 void print_proc_info(pid_t pid)
1061 {
1062         int j = 0;
1063         struct proc *p = pid2proc(pid);
1064         // not concerned with a race on the state...
1065         if (!p) {
1066                 printk("Bad PID.\n");
1067                 return;
1068         }
1069         spinlock_debug(&p->proc_lock);
1070         spin_lock_irqsave(&p->proc_lock);
1071         printk("struct proc: %p\n", p);
1072         printk("PID: %d\n", p->pid);
1073         printk("PPID: %d\n", p->ppid);
1074         printk("State: 0x%08x\n", p->state);
1075         printk("Refcnt: %d\n", p->env_refcnt - 1); // don't report our ref
1076         printk("Flags: 0x%08x\n", p->env_flags);
1077         printk("CR3(phys): 0x%08x\n", p->env_cr3);
1078         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
1079         printk("Vcoremap:\n");
1080         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1081                 j = get_busy_vcoreid(p, j);
1082                 printk("\tVcore %d: Pcore %d\n", j, p->procinfo->vcoremap[j].pcoreid);
1083                 j++;
1084         }
1085         printk("Resources:\n");
1086         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
1087                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
1088                        p->resources[i].amt_wanted, p->resources[i].amt_granted);
1089         printk("Vcore 0's Last Trapframe:\n");
1090         print_trapframe(&p->env_tf);
1091         spin_unlock_irqsave(&p->proc_lock);
1092         proc_decref(p, 1); /* decref for the pid2proc reference */
1093 }