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