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