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