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