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