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