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