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