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