Fixed DISABLE_SMT to report the right max_vcores
[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 <ros/bcq.h>
12 #include <arch/arch.h>
13 #include <arch/bitmask.h>
14 #include <process.h>
15 #include <atomic.h>
16 #include <smp.h>
17 #include <pmap.h>
18 #include <trap.h>
19 #include <schedule.h>
20 #include <manager.h>
21 #include <stdio.h>
22 #include <assert.h>
23 #include <timing.h>
24 #include <hashtable.h>
25 #include <slab.h>
26 #include <sys/queue.h>
27 #include <frontend.h>
28 #include <monitor.h>
29
30 /* Process Lists */
31 struct proc_list proc_runnablelist = TAILQ_HEAD_INITIALIZER(proc_runnablelist);
32 spinlock_t runnablelist_lock = SPINLOCK_INITIALIZER;
33 struct kmem_cache *proc_cache;
34
35 /* Tracks which cores are idle, similar to the vcoremap.  Each value is the
36  * physical coreid of an unallocated core. */
37 spinlock_t idle_lock = SPINLOCK_INITIALIZER;
38 uint32_t LCKD(&idle_lock) (RO idlecoremap)[MAX_NUM_CPUS];
39 uint32_t LCKD(&idle_lock) num_idlecores = 0;
40 uint32_t num_mgmtcores = 1;
41
42 /* Helper function to return a core to the idlemap.  It causes some more lock
43  * acquisitions (like in a for loop), but it's a little easier.  Plus, one day
44  * we might be able to do this without locks (for the putting). */
45 static void put_idle_core(uint32_t coreid)
46 {
47         spin_lock(&idle_lock);
48 #ifdef __CONFIG_EXPER_TRADPROC__ /* often a good check, but hurts performance */
49         for (int i = 0; i < num_idlecores; i++)
50                 if (idlecoremap[i] == coreid)
51                         warn("Core %d added to the freelist twice!", coreid);
52 #endif /* __CONFIG_EXPER_TRADPROC__ */
53         idlecoremap[num_idlecores++] = coreid;
54         spin_unlock(&idle_lock);
55 }
56
57 /* Other helpers, implemented later. */
58 static void __proc_startcore(struct proc *p, trapframe_t *tf);
59 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev);
60 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev);
61 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid);
62 static uint32_t get_vcoreid(struct proc *SAFE p, uint32_t pcoreid);
63
64 /* PID management. */
65 #define PID_MAX 32767 // goes from 0 to 32767, with 0 reserved
66 static DECL_BITMASK(pid_bmask, PID_MAX + 1);
67 spinlock_t pid_bmask_lock = SPINLOCK_INITIALIZER;
68 struct hashtable *pid_hash;
69 spinlock_t pid_hash_lock; // initialized in proc_init
70
71 /* Finds the next free entry (zero) entry in the pid_bitmask.  Set means busy.
72  * PID 0 is reserved (in proc_init).  A return value of 0 is a failure (and
73  * you'll also see a warning, for now).  Consider doing this with atomics. */
74 static pid_t get_free_pid(void)
75 {
76         static pid_t next_free_pid = 1;
77         pid_t my_pid = 0;
78
79         spin_lock(&pid_bmask_lock);
80         // atomically (can lock for now, then change to atomic_and_return
81         FOR_CIRC_BUFFER(next_free_pid, PID_MAX + 1, i) {
82                 // always points to the next to test
83                 next_free_pid = (next_free_pid + 1) % (PID_MAX + 1);
84                 if (!GET_BITMASK_BIT(pid_bmask, i)) {
85                         SET_BITMASK_BIT(pid_bmask, i);
86                         my_pid = i;
87                         break;
88                 }
89         }
90         spin_unlock(&pid_bmask_lock);
91         if (!my_pid)
92                 warn("Shazbot!  Unable to find a PID!  You need to deal with this!\n");
93         return my_pid;
94 }
95
96 /* Return a pid to the pid bitmask */
97 static void put_free_pid(pid_t pid)
98 {
99         spin_lock(&pid_bmask_lock);
100         CLR_BITMASK_BIT(pid_bmask, pid);
101         spin_unlock(&pid_bmask_lock);
102 }
103
104 /* While this could be done with just an assignment, this gives us the
105  * opportunity to check for bad transitions.  Might compile these out later, so
106  * we shouldn't rely on them for sanity checking from userspace.  */
107 int __proc_set_state(struct proc *p, uint32_t state)
108 {
109         uint32_t curstate = p->state;
110         /* Valid transitions:
111          * C   -> RBS
112          * RBS -> RGS
113          * RGS -> RBS
114          * RGS -> W
115          * W   -> RBS
116          * RGS -> RBM
117          * RBM -> RGM
118          * RGM -> RBM
119          * RGM -> RBS
120          * RGS -> D
121          * RGM -> D
122          *
123          * These ought to be implemented later (allowed, not thought through yet).
124          * RBS -> D
125          * RBM -> D
126          *
127          * This isn't allowed yet, should be later.  Is definitely causable.
128          * C   -> D
129          */
130         #if 1 // some sort of correctness flag
131         switch (curstate) {
132                 case PROC_CREATED:
133                         if (state != PROC_RUNNABLE_S)
134                                 panic("Invalid State Transition! PROC_CREATED to %02x", state);
135                         break;
136                 case PROC_RUNNABLE_S:
137                         if (!(state & (PROC_RUNNING_S | PROC_DYING)))
138                                 panic("Invalid State Transition! PROC_RUNNABLE_S to %02x", state);
139                         break;
140                 case PROC_RUNNING_S:
141                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
142                                        PROC_DYING)))
143                                 panic("Invalid State Transition! PROC_RUNNING_S to %02x", state);
144                         break;
145                 case PROC_WAITING:
146                         if (state != PROC_RUNNABLE_S)
147                                 panic("Invalid State Transition! PROC_WAITING to %02x", state);
148                         break;
149                 case PROC_DYING:
150                         if (state != PROC_CREATED) // when it is reused (TODO)
151                                 panic("Invalid State Transition! PROC_DYING to %02x", state);
152                         break;
153                 case PROC_RUNNABLE_M:
154                         if (!(state & (PROC_RUNNING_M | PROC_DYING)))
155                                 panic("Invalid State Transition! PROC_RUNNABLE_M to %02x", state);
156                         break;
157                 case PROC_RUNNING_M:
158                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_DYING)))
159                                 panic("Invalid State Transition! PROC_RUNNING_M to %02x", state);
160                         break;
161         }
162         #endif
163         p->state = state;
164         return 0;
165 }
166
167 /* Returns a pointer to the proc with the given pid, or 0 if there is none */
168 struct proc *pid2proc(pid_t pid)
169 {
170         spin_lock(&pid_hash_lock);
171         struct proc *p = hashtable_search(pid_hash, (void*)pid);
172         spin_unlock(&pid_hash_lock);
173         /* if the refcnt was 0, decref and return 0 (we failed). (TODO) */
174         if (p)
175                 proc_incref(p, 1); // TODO:(REF) to do this all atomically and not panic
176         return p;
177 }
178
179 /* Performs any initialization related to processes, such as create the proc
180  * cache, prep the scheduler, etc.  When this returns, we should be ready to use
181  * any process related function. */
182 void proc_init(void)
183 {
184         proc_cache = kmem_cache_create("proc", sizeof(struct proc),
185                      MAX(HW_CACHE_ALIGN, __alignof__(struct proc)), 0, 0, 0);
186         /* Init PID mask and hash.  pid 0 is reserved. */
187         SET_BITMASK_BIT(pid_bmask, 0);
188         spinlock_init(&pid_hash_lock);
189         spin_lock(&pid_hash_lock);
190         pid_hash = create_hashtable(100, __generic_hash, __generic_eq);
191         spin_unlock(&pid_hash_lock);
192         schedule_init();
193         /* Init idle cores. Core 0 is the management core. */
194         spin_lock(&idle_lock);
195 #ifdef __CONFIG_DISABLE_SMT__
196         /* assumes core0 is the only management core (NIC and monitor functionality
197          * are run there too.  it just adds the odd cores to the idlecoremap */
198         assert(!(num_cpus % 2));
199         // TODO: consider checking x86 for machines that actually hyperthread
200         num_idlecores = num_cpus >> 1;
201         for (int i = 0; i < num_idlecores; i++)
202                 idlecoremap[i] = (i * 2) + 1;
203 #else
204         #ifdef __CONFIG_NETWORKING__
205         num_mgmtcores++; // Next core is dedicated to the NIC
206         assert(num_cpus >= num_mgmtcores);
207         #endif
208         #ifdef __CONFIG_APPSERVER__
209         #ifdef __CONFIG_DEDICATED_MONITOR__
210         num_mgmtcores++; // Next core dedicated to running the kernel monitor
211         assert(num_cpus >= num_mgmtcores);
212         // Need to subtract 1 from the num_mgmtcores # to get the cores index
213         send_kernel_message(num_mgmtcores-1, (amr_t)monitor, 0,0,0, KMSG_ROUTINE);
214         #endif
215         #endif
216         num_idlecores = num_cpus - num_mgmtcores;
217         for (int i = 0; i < num_idlecores; i++)
218                 idlecoremap[i] = i + num_mgmtcores;
219 #endif /* __CONFIG_DISABLE_SMT__ */
220         spin_unlock(&idle_lock);
221         atomic_init(&num_envs, 0);
222 }
223
224 void
225 proc_init_procinfo(struct proc* p)
226 {
227         memset(&p->procinfo->vcoremap, 0, sizeof(p->procinfo->vcoremap));
228         memset(&p->procinfo->pcoremap, 0, sizeof(p->procinfo->pcoremap));
229         p->procinfo->num_vcores = 0;
230         p->procinfo->coremap_seqctr = SEQCTR_INITIALIZER;
231         // TODO: change these too
232         p->procinfo->pid = p->pid;
233         p->procinfo->ppid = p->ppid;
234         p->procinfo->tsc_freq = system_timing.tsc_freq;
235         // TODO: maybe do something smarter here
236 #ifdef __CONFIG_DISABLE_SMT__
237         p->procinfo->max_vcores = num_cpus >> 1;
238 #else
239         p->procinfo->max_vcores = MAX(1,num_cpus-num_mgmtcores);
240 #endif /* __CONFIG_DISABLE_SMT__ */
241 }
242
243 #ifdef __CONFIG_EXPER_TRADPROC__
244 bool is_real_proc(struct proc *p)
245 {
246         // the real proc has no true proc pointer
247         return !p->true_proc;
248 }
249
250 /* Make a _S process to represent a vcore in a traditional threading/scheduling
251  * model.  Should be able to proc_run this once it's done.  Hold the parent's
252  * lock when you call this. */
253 int fake_proc_alloc(struct proc **pp, struct proc *parent, uint32_t vcoreid)
254 {
255         error_t r;
256         struct proc *p;
257
258         /* So we can call this anytime we want to run a vcore, including vcore0,
259          * which is the true_proc / parent.  Probably horribly broken. */
260         if (!vcoreid) {
261                 *pp = parent;
262                 return 0;
263         }
264
265         if (!(p = kmem_cache_alloc(proc_cache, 0)))
266                 return -ENOMEM;
267
268         spinlock_init(&p->proc_lock);
269         p->pid = parent->pid;
270         p->ppid = parent->ppid;
271         p->exitcode = 0;
272         p->state = PROC_RUNNING_M;
273         p->env_refcnt = 2;
274         p->env_entry = parent->env_entry;
275         p->cache_colors_map = parent->cache_colors_map;
276         p->next_cache_color = parent->next_cache_color;
277         p->heap_top = (void*)0xdeadbeef; // shouldn't use this.  poisoning.
278         p->env_pgdir = parent->env_pgdir;
279         p->env_cr3 = parent->env_cr3;
280         p->procinfo = parent->procinfo;
281         p->procdata = parent->procdata;
282         /* Don't use ARSCs, they aren't turned on */
283         // p->syscallbackring = not happening
284         p->true_proc = parent;
285         p->vcoreid = vcoreid;
286         /* map us to the true parent vcoremap */
287         assert(!parent->vcore_procs[vcoreid]);
288         parent->vcore_procs[vcoreid] = p;
289         parent->env_refcnt++;
290
291         memset(&p->env_ancillary_state, 0, sizeof(p->env_ancillary_state));
292         /* env_tf is 0'd in init_trapframe */
293         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
294         proc_init_trapframe(&p->env_tf, vcoreid, p->env_entry,
295                             vcpd->transition_stack);
296
297         *pp = p;
298         atomic_inc(&num_envs);
299
300         printd("[%08x] fake process %08x\n", current ? current->pid : 0, p->pid);
301         return 0;
302 }
303 #endif /* __CONFIG_EXPER_TRADPROC__ */
304
305 /* Allocates and initializes a process, with the given parent.  Currently
306  * writes the *p into **pp, and returns 0 on success, < 0 for an error.
307  * Errors include:
308  *  - ENOFREEPID if it can't get a PID
309  *  - ENOMEM on memory exhaustion */
310 static error_t proc_alloc(struct proc *SAFE*SAFE pp, pid_t parent_id)
311 {
312         error_t r;
313         struct proc *p;
314
315         if (!(p = kmem_cache_alloc(proc_cache, 0)))
316                 return -ENOMEM;
317
318         { INITSTRUCT(*p)
319
320         // Setup the default map of where to get cache colors from
321         p->cache_colors_map = global_cache_colors_map;
322         p->next_cache_color = 0;
323
324         /* Initialize the address space */
325         if ((r = env_setup_vm(p)) < 0) {
326                 kmem_cache_free(proc_cache, p);
327                 return r;
328         }
329
330         /* Get a pid, then store a reference in the pid_hash */
331         if (!(p->pid = get_free_pid())) {
332                 kmem_cache_free(proc_cache, p);
333                 return -ENOFREEPID;
334         }
335         spin_lock(&pid_hash_lock);
336         hashtable_insert(pid_hash, (void*)p->pid, p);
337         spin_unlock(&pid_hash_lock);
338
339         /* Set the basic status variables. */
340         spinlock_init(&p->proc_lock);
341         p->exitcode = 0;
342         p->ppid = parent_id;
343         p->state = PROC_CREATED; // shouldn't go through state machine for init
344         p->env_refcnt = 2; // one for the object, one for the ref we pass back
345         p->env_flags = 0;
346         p->env_entry = 0; // cheating.  this really gets set in load_icode
347         p->procinfo->heap_bottom = (void*)UTEXT;
348         p->heap_top = (void*)UTEXT;
349         memset(&p->resources, 0, sizeof(p->resources));
350         memset(&p->env_ancillary_state, 0, sizeof(p->env_ancillary_state));
351         memset(&p->env_tf, 0, sizeof(p->env_tf));
352
353         /* Initialize the contents of the e->procinfo structure */
354         proc_init_procinfo(p);
355         /* Initialize the contents of the e->procdata structure */
356
357         /* Initialize the generic syscall ring buffer */
358         SHARED_RING_INIT(&p->procdata->syscallring);
359         /* Initialize the backend of the syscall ring buffer */
360         BACK_RING_INIT(&p->syscallbackring,
361                        &p->procdata->syscallring,
362                        SYSCALLRINGSIZE);
363
364         /* Initialize the generic sysevent ring buffer */
365         SHARED_RING_INIT(&p->procdata->syseventring);
366         /* Initialize the frontend of the sysevent ring buffer */
367         FRONT_RING_INIT(&p->syseventfrontring,
368                         &p->procdata->syseventring,
369                         SYSEVENTRINGSIZE);
370         *pp = p;
371         atomic_inc(&num_envs);
372
373 #ifdef __CONFIG_EXPER_TRADPROC__
374         p->true_proc = 0;
375         p->vcoreid = 0;
376         memset(p->vcore_procs, 0, sizeof(p->vcore_procs));
377 #endif /* __CONFIG_EXPER_TRADPROC__ */
378
379         frontend_proc_init(p);
380
381         printd("[%08x] new process %08x\n", current ? current->pid : 0, p->pid);
382         } // INIT_STRUCT
383         return 0;
384 }
385
386 /* Creates a process from the specified binary, which is of size size.
387  * Currently, the binary must be a contiguous block of memory, which needs to
388  * change.  On any failure, it just panics, which ought to be sorted. */
389 struct proc *proc_create(uint8_t *binary, size_t size)
390 {
391         struct proc *p;
392         error_t r;
393         pid_t curid;
394
395         curid = (current ? current->pid : 0);
396         if ((r = proc_alloc(&p, curid)) < 0)
397                 panic("proc_create: %e", r); // one of 3 quaint usages of %e.
398         if(binary != NULL)
399                 env_load_icode(p, NULL, binary, size);
400         return p;
401 }
402
403 /* This is called by proc_decref, once the last reference to the process is
404  * gone.  Don't call this otherwise (it will panic).  It will clean up the
405  * address space and deallocate any other used memory. */
406 static void __proc_free(struct proc *p)
407 {
408         physaddr_t pa;
409
410         printd("[PID %d] freeing proc: %d\n", current ? current->pid : 0, p->pid);
411         // All parts of the kernel should have decref'd before __proc_free is called
412         assert(p->env_refcnt == 0);
413
414 #ifdef __CONFIG_EXPER_TRADPROC__
415         if (!is_real_proc(p)) {
416                 printd("Fake proc on core %d unmapping from parent\n", core_id());
417                 p->true_proc->vcore_procs[p->vcoreid] = 0; /* unmap self */
418                 proc_decref(p->true_proc, 1); // might deadlock
419                 kmem_cache_free(proc_cache, p);
420                 return;
421         } else {
422                 /* make sure the kids are dead before spinning */
423                 if (current && !is_real_proc(current)) {
424                         __abandon_core();
425                 }
426                 /* spin til my peeps are dead */
427                 for (int i = 0; i < MAX_NUM_CPUS; i++) {
428                         for (int j = 0; p->vcore_procs[i]; j++) {
429                                 cpu_relax();
430                                 if (j == 10000) {
431                                         printd("Core %d stalled while waiting on peep %d\n",
432                                                core_id(), i);
433                                         //send_kernel_message(p->procinfo->vcoremap[i].pcoreid,
434                                         //                    __death, 0, 0, 0, KMSG_ROUTINE);
435                                 }
436                         }
437                 }
438         }
439         assert(is_real_proc(p));
440         printd("Core %d really trying to free proc %d (%p)\n", core_id(), p->pid, p);
441 #endif /* __CONFIG_EXPER_TRADPROC__ */
442
443         frontend_proc_free(p);
444
445         // Free any colors allocated to this process
446         if(p->cache_colors_map != global_cache_colors_map) {
447                 for(int i=0; i<llc_cache->num_colors; i++)
448                         cache_color_free(llc_cache, p->cache_colors_map);
449                 cache_colors_map_free(p->cache_colors_map);
450         }
451
452         // Flush all mapped pages in the user portion of the address space
453         env_user_mem_free(p, 0, UVPT);
454         /* These need to be free again, since they were allocated with a refcnt. */
455         free_cont_pages(p->procinfo, LOG2_UP(PROCINFO_NUM_PAGES));
456         free_cont_pages(p->procdata, LOG2_UP(PROCDATA_NUM_PAGES));
457
458         env_pagetable_free(p);
459         p->env_pgdir = 0;
460         p->env_cr3 = 0;
461
462         /* Remove self from the pid hash, return PID.  Note the reversed order. */
463         spin_lock(&pid_hash_lock);
464         if (!hashtable_remove(pid_hash, (void*)p->pid))
465                 panic("Proc not in the pid table in %s", __FUNCTION__);
466         spin_unlock(&pid_hash_lock);
467         put_free_pid(p->pid);
468         atomic_dec(&num_envs);
469
470         /* Dealloc the struct proc */
471         kmem_cache_free(proc_cache, p);
472 }
473
474 /* Whether or not actor can control target.  Note we currently don't need
475  * locking for this. TODO: think about that, esp wrt proc's dying. */
476 bool proc_controls(struct proc *actor, struct proc *target)
477 {
478         return ((actor == target) || (target->ppid == actor->pid));
479 }
480
481 /* Dispatches a process to run, either on the current core in the case of a
482  * RUNNABLE_S, or on its partition in the case of a RUNNABLE_M.  This should
483  * never be called to "restart" a core.  This expects that the "instructions"
484  * for which core(s) to run this on will be in the vcoremap, which needs to be
485  * set externally.
486  *
487  * When a process goes from RUNNABLE_M to RUNNING_M, its vcoremap will be
488  * "packed" (no holes in the vcore->pcore mapping), vcore0 will continue to run
489  * it's old core0 context, and the other cores will come in at the entry point.
490  * Including in the case of preemption.
491  *
492  * This won't return if the current core is going to be one of the processes
493  * cores (either for _S mode or for _M if it's in the vcoremap).  proc_run will
494  * eat your reference if it does not return. */
495 void proc_run(struct proc *p)
496 {
497         bool self_ipi_pending = FALSE;
498         spin_lock(&p->proc_lock);
499
500 #ifdef __CONFIG_EXPER_TRADPROC__
501         /* this filth is so the state won't affect how it's run.  whenever we call
502          * proc_run, we think we are RUNNABLE_S.  prob issues with DYING. */
503         switch (p->state) {
504                 case (PROC_DYING):
505                         spin_unlock(&p->proc_lock);
506                         printk("Process %d not starting due to async death\n", p->pid);
507                         if (!management_core())
508                                 smp_idle(); // this never returns
509                         return;
510                 case (PROC_RUNNABLE_S):
511                         assert(current != p);
512                         __proc_set_state(p, PROC_RUNNING_S);
513                         __seq_start_write(&p->procinfo->coremap_seqctr);
514                         p->procinfo->num_vcores = 0;
515                         __map_vcore(p, p->vcoreid, core_id());
516                         __seq_end_write(&p->procinfo->coremap_seqctr);
517                         // fallthru
518                 case (PROC_RUNNING_M):
519                         if (p == current)
520                                 p->env_refcnt--; // TODO: (REF) use incref
521                         spin_unlock(&p->proc_lock);
522                         // TODO: HSS!!
523                         // restore fp state from the preempt slot?
524                         disable_irq();
525                         __proc_startcore(p, &p->env_tf);
526                         break;
527                 default:
528                         panic("Weird state(%s) in %s()", procstate2str(p->state),
529                               __FUNCTION__);
530         }
531         return;
532 #endif /* __CONFIG_EXPER_TRADPROC__ */
533
534         switch (p->state) {
535                 case (PROC_DYING):
536                         spin_unlock(&p->proc_lock);
537                         printk("Process %d not starting due to async death\n", p->pid);
538                         // if we're a worker core, smp_idle, o/w return
539                         if (!management_core())
540                                 smp_idle(); // this never returns
541                         return;
542                 case (PROC_RUNNABLE_S):
543                         assert(current != p);
544                         __proc_set_state(p, PROC_RUNNING_S);
545                         /* We will want to know where this process is running, even if it is
546                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
547                          * Also, this is the signal used in trap.c to know to save the tf in
548                          * env_tf. */
549                         __seq_start_write(&p->procinfo->coremap_seqctr);
550                         p->procinfo->num_vcores = 0;
551                         __map_vcore(p, 0, core_id()); // sort of.  this needs work.
552                         __seq_end_write(&p->procinfo->coremap_seqctr);
553                         /* __proc_startcore assumes the reference we give it is for current.
554                          * Decref if current is already properly set. */
555                         if (p == current)
556                                 p->env_refcnt--; // TODO: (REF) use incref
557                         /* We don't want to process routine messages here, since it's a bit
558                          * different than when we perform a syscall in this process's
559                          * context.  We want interrupts disabled so that if there was a
560                          * routine message on the way, we'll get the interrupt once we pop
561                          * back to userspace.  */
562                         spin_unlock(&p->proc_lock);
563                         disable_irq();
564                         __proc_startcore(p, &p->env_tf);
565                         break;
566                 case (PROC_RUNNABLE_M):
567                         /* vcoremap[i] holds the coreid of the physical core allocated to
568                          * this process.  It is set outside proc_run.  For the kernel
569                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
570                         if (p->procinfo->num_vcores) {
571                                 __proc_set_state(p, PROC_RUNNING_M);
572                                 /* Up the refcnt, since num_vcores are going to start using this
573                                  * process and have it loaded in their 'current'. */
574                                 p->env_refcnt += p->procinfo->num_vcores; // TODO: (REF) use incref
575                                 /* If the core we are running on is in the vcoremap, we will get
576                                  * an IPI (once we reenable interrupts) and never return. */
577                                 if (is_mapped_vcore(p, core_id()))
578                                         self_ipi_pending = TRUE;
579                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
580                                         send_kernel_message(p->procinfo->vcoremap[i].pcoreid,
581                                                             (void *)__startcore, (void *)p, 0, 0,
582                                                             KMSG_ROUTINE);
583                         } else {
584                                 warn("Tried to proc_run() an _M with no vcores!");
585                         }
586                         /* Unlock and decref/wait for the IPI if one is pending.  This will
587                          * eat the reference if we aren't returning.
588                          *
589                          * There a subtle race avoidance here.  __proc_startcore can handle
590                          * a death message, but we can't have the startcore come after the
591                          * death message.  Otherwise, it would look like a new process.  So
592                          * we hold the lock til after we send our message, which prevents a
593                          * possible death message.
594                          * - Note there is no guarantee this core's interrupts were on, so
595                          *   it may not get the message for a while... */
596                         spin_unlock(&p->proc_lock);
597                         __proc_kmsg_pending(p, self_ipi_pending);
598                         break;
599                 default:
600                         spin_unlock(&p->proc_lock);
601                         panic("Invalid process state %p in proc_run()!!", p->state);
602         }
603 }
604
605 /* Actually runs the given context (trapframe) of process p on the core this
606  * code executes on.  This is called directly by __startcore, which needs to
607  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
608  *
609  * A note on refcnting: this function will not return, and your proc reference
610  * will end up stored in current.  This will make no changes to p's refcnt, so
611  * do your accounting such that there is only the +1 for current.  This means if
612  * it is already in current (like in the trap return path), don't up it.  If
613  * it's already in current and you have another reference (like pid2proc or from
614  * an IPI), then down it (which is what happens in __startcore()).  If it's not
615  * in current and you have one reference, like proc_run(non_current_p), then
616  * also do nothing.  The refcnt for your *p will count for the reference stored
617  * in current. */
618 static void __proc_startcore(struct proc *p, trapframe_t *tf)
619 {
620         assert(!irq_is_enabled());
621         /* If the process wasn't here, then we need to load its address space. */
622         if (p != current) {
623                 /* Do not incref here.  We were given the reference to current,
624                  * pre-upped. */
625                 lcr3(p->env_cr3);
626                 /* This is "leaving the process context" of the previous proc.  The
627                  * previous lcr3 unloaded the previous proc's context.  This should
628                  * rarely happen, since we usually proactively leave process context,
629                  * but is the fallback. */
630                 if (current)
631                         proc_decref(current, 1);
632                 set_current_proc(p);
633         }
634         /* need to load our silly state, preferably somewhere other than here so we
635          * can avoid the case where the context was just running here.  it's not
636          * sufficient to do it in the "new process" if-block above (could be things
637          * like page faults that cause us to keep the same process, but want a
638          * different context.
639          * for now, we load this silly state here. (TODO) (HSS)
640          * We also need this to be per trapframe, and not per process...
641          */
642         env_pop_ancillary_state(p);
643         env_pop_tf(tf);
644 }
645
646 /* Restarts the given context (trapframe) of process p on the core this code
647  * executes on.  Calls an internal function to do the work.
648  *
649  * In case there are pending routine messages, like __death, __preempt, or
650  * __notify, we need to run them.  Alternatively, if there are any, we could
651  * self_ipi, and run the messages immediately after popping back to userspace,
652  * but that would have crappy overhead.
653  *
654  * Refcnting: this will not return, and it assumes that you've accounted for
655  * your reference as if it was the ref for "current" (which is what happens when
656  * returning from local traps and such. */
657 void proc_restartcore(struct proc *p, trapframe_t *tf)
658 {
659         /* Need ints disabled when we return from processing (race) */
660         disable_irq();
661         process_routine_kmsg();
662         __proc_startcore(p, tf);
663 }
664
665 /*
666  * Destroys the given process.  This may be called from another process, a light
667  * kernel thread (no real process context), asynchronously/cross-core, or from
668  * the process on its own core.
669  *
670  * Here's the way process death works:
671  * 0. grab the lock (protects state transition and core map)
672  * 1. set state to dying.  that keeps the kernel from doing anything for the
673  * process (like proc_running it).
674  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
675  * 3. IPI to clean up those cores (decref, etc).
676  * 4. Unlock
677  * 5. Clean up your core, if applicable
678  * (Last core/kernel thread to decref cleans up and deallocates resources.)
679  *
680  * Note that some cores can be processing async calls, but will eventually
681  * decref.  Should think about this more, like some sort of callback/revocation.
682  *
683  * This will eat your reference if it won't return.  Note that this function
684  * needs to change anyways when we make __death more like __preempt.  (TODO) */
685 void proc_destroy(struct proc *p)
686 {
687         bool self_ipi_pending = FALSE;
688
689 #ifdef __CONFIG_EXPER_TRADPROC__
690         /* in case a fake proc tries to kill themselves directly */
691         if (!is_real_proc(p)) {
692                 printd("Trying to destroy a fake proc, will kill true proc\n");
693                 proc_destroy(p->true_proc);
694                 return;
695         }
696 #endif /* __CONFIG_EXPER_TRADPROC__ */
697
698         spin_lock(&p->proc_lock);
699
700         /* TODO: (DEATH) look at this again when we sort the __death IPI */
701 #ifdef __CONFIG_EXPER_TRADPROC__
702         if ((current == p) || (current && (current->true_proc == p)))
703 #else
704         if (current == p)
705 #endif /* __CONFIG_EXPER_TRADPROC__ */
706                 self_ipi_pending = TRUE;
707         
708         switch (p->state) {
709                 case PROC_DYING: // someone else killed this already.
710                         spin_unlock(&p->proc_lock);
711                         __proc_kmsg_pending(p, self_ipi_pending);
712                         return;
713                 case PROC_RUNNABLE_M:
714                         /* Need to reclaim any cores this proc might have, even though it's
715                          * not running yet. */
716                         __proc_take_allcores(p, NULL, NULL, NULL, NULL);
717                         // fallthrough
718                 case PROC_RUNNABLE_S:
719                         // Think about other lists, like WAITING, or better ways to do this
720                         deschedule_proc(p);
721                         break;
722                 case PROC_RUNNING_S:
723                         #if 0
724                         // here's how to do it manually
725                         if (current == p) {
726                                 lcr3(boot_cr3);
727                                 proc_decref(p, 1); // this decref is for the cr3
728                                 current = NULL;
729                         }
730                         #endif
731                         send_kernel_message(p->procinfo->vcoremap[0].pcoreid, __death,
732                                            (void *SNT)0, (void *SNT)0, (void *SNT)0,
733                                            KMSG_ROUTINE);
734                         __seq_start_write(&p->procinfo->coremap_seqctr);
735                         // TODO: might need to sort num_vcores too later (VC#)
736                         /* vcore is unmapped on the receive side */
737                         __seq_end_write(&p->procinfo->coremap_seqctr);
738                         #if 0
739                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
740                          * managed by the idlecoremap.  so don't do this yet. */
741                         put_idle_core(p->procinfo->vcoremap[0].pcoreid);
742                         #endif
743                         break;
744                 case PROC_RUNNING_M:
745                         /* Send the DEATH message to every core running this process, and
746                          * deallocate the cores.
747                          * The rule is that the vcoremap is set before proc_run, and reset
748                          * within proc_destroy */
749                         __proc_take_allcores(p, __death, (void *SNT)0, (void *SNT)0,
750                                              (void *SNT)0);
751                         break;
752                 default:
753                         panic("Weird state(%s) in %s()", procstate2str(p->state),
754                               __FUNCTION__);
755         }
756         __proc_set_state(p, PROC_DYING);
757         /* this decref is for the process in general */
758         p->env_refcnt--; // TODO (REF)
759         //proc_decref(p, 1);
760
761         /* Unlock and possible decref and wait.  A death IPI should be on its way,
762          * either from the RUNNING_S one, or from proc_take_cores with a __death.
763          * in general, interrupts should be on when you call proc_destroy locally,
764          * but currently aren't for all things (like traphandlers). */
765         spin_unlock(&p->proc_lock);
766         __proc_kmsg_pending(p, self_ipi_pending);
767         return;
768 }
769
770 /* Helper function.  Starting from prev, it will find the next free vcoreid,
771  * which is the next vcore that is not valid.
772  * You better hold the lock before calling this. */
773 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev)
774 {
775         uint32_t i;
776         for (i = prev; i < MAX_NUM_CPUS; i++)
777                 if (!p->procinfo->vcoremap[i].valid)
778                         break;
779         if (i + 1 >= MAX_NUM_CPUS)
780                 warn("At the end of the vcorelist.  Might want to check that out.");
781         return i;
782 }
783
784 /* Helper function.  Starting from prev, it will find the next busy vcoreid,
785  * which is the next vcore that is valid.
786  * You better hold the lock before calling this. */
787 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev)
788 {
789         uint32_t i;
790         for (i = prev; i < MAX_NUM_CPUS; i++)
791                 if (p->procinfo->vcoremap[i].valid)
792                         break;
793         if (i + 1 >= MAX_NUM_CPUS)
794                 warn("At the end of the vcorelist.  Might want to check that out.");
795         return i;
796 }
797
798 /* Helper function.  Is the given pcore a mapped vcore?  Hold the lock before
799  * calling. */
800 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
801 {
802         return p->procinfo->pcoremap[pcoreid].valid;
803 }
804
805 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
806  * You better hold the lock before calling this.  Panics on failure. */
807 static uint32_t get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
808 {
809         assert(is_mapped_vcore(p, pcoreid));
810         return p->procinfo->pcoremap[pcoreid].vcoreid;
811 }
812
813 /* Yields the calling core.  Must be called locally (not async) for now.
814  * - If RUNNING_S, you just give up your time slice and will eventually return.
815  * - If RUNNING_M, you give up the current vcore (which never returns), and
816  *   adjust the amount of cores wanted/granted.
817  * - If you have only one vcore, you switch to RUNNABLE_M.  When you run again,
818  *   you'll have one guaranteed core, starting from the entry point.
819  *
820  * - RES_CORES amt_wanted will be the amount running after taking away the
821  *   yielder, unless there are none left, in which case it will be 1.
822  *
823  * If the call is being nice, it means that it is in response to a preemption
824  * (which needs to be checked).  If there is no preemption pending, just return.
825  * No matter what, don't adjust the number of cores wanted.
826  *
827  * This usually does not return (abandon_core()), so it will eat your reference.
828  * */
829 void proc_yield(struct proc *SAFE p, bool being_nice)
830 {
831         uint32_t vcoreid = get_vcoreid(p, core_id());
832         struct vcore *vc = &p->procinfo->vcoremap[vcoreid];
833
834         /* no reason to be nice, return */
835         if (being_nice && !vc->preempt_pending)
836                 return;
837
838 #ifdef __CONFIG_EXPER_TRADPROC__
839         if (p->state == (PROC_RUNNING_M | PROC_DYING))
840                 return;
841 #endif /* __CONFIG_EXPER_TRADPROC__ */
842
843         spin_lock(&p->proc_lock); /* horrible scalability.  =( */
844
845         /* fate is sealed, return and take the preempt message on the way out.
846          * we're making this check while holding the lock, since the preemptor
847          * should hold the lock when sending messages. */
848         if (vc->preempt_served) {
849                 spin_unlock(&p->proc_lock);
850                 return;
851         }
852         /* no need to preempt later, since we are yielding (nice or otherwise) */
853         if (vc->preempt_pending)
854                 vc->preempt_pending = 0;
855
856         switch (p->state) {
857                 case (PROC_RUNNING_S):
858                         p->env_tf= *current_tf;
859                         env_push_ancillary_state(p);
860                         __proc_set_state(p, PROC_RUNNABLE_S);
861                         schedule_proc(p);
862                         break;
863                 case (PROC_RUNNING_M):
864 #ifdef __CONFIG_OSDI__
865                         /* Ghetto, for OSDI: */
866                         printd("[K] Process %d (%p) is yielding on vcore %d\n", p->pid, p,
867                                get_vcoreid(p, core_id()));
868                         if (p->procinfo->num_vcores == 1) {
869                                 spin_unlock(&p->proc_lock);
870                                 return;
871                         }
872 #endif /* __CONFIG_OSDI__ */
873                         __seq_start_write(&p->procinfo->coremap_seqctr);
874                         // give up core
875                         __unmap_vcore(p, get_vcoreid(p, core_id()));
876                         p->resources[RES_CORES].amt_granted = --(p->procinfo->num_vcores);
877                         if (!being_nice)
878                                 p->resources[RES_CORES].amt_wanted = p->procinfo->num_vcores;
879                         __seq_end_write(&p->procinfo->coremap_seqctr);
880                         // add to idle list
881                         put_idle_core(core_id());
882                         // last vcore?  then we really want 1, and to yield the gang
883                         if (p->procinfo->num_vcores == 0) {
884                                 p->resources[RES_CORES].amt_wanted = 1;
885                                 __proc_set_state(p, PROC_RUNNABLE_M);
886                                 schedule_proc(p);
887                         }
888                         break;
889                 default:
890                         // there are races that can lead to this (async death, preempt, etc)
891                         panic("Weird state(%s) in %s()", procstate2str(p->state),
892                               __FUNCTION__);
893         }
894         spin_unlock(&p->proc_lock);
895         proc_decref(p, 1); // need to eat the ref passed in.
896         /* Clean up the core and idle.  For mgmt cores, they will ultimately call
897          * manager, which will call schedule() and will repick the yielding proc. */
898         abandon_core();
899 }
900
901 /* If you expect to notify yourself, cleanup state and process_routine_kmsg() */
902 void do_notify(struct proc *p, uint32_t vcoreid, unsigned int notif,
903                struct notif_event *ne)
904 {
905         printd("sending notif %d to proc %p\n", notif, p);
906         assert(notif < MAX_NR_NOTIF);
907         if (ne)
908                 assert(notif == ne->ne_type);
909
910         struct notif_method *nm = &p->procdata->notif_methods[notif];
911         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
912
913         printd("nm = %p, vcpd = %p\n", nm, vcpd);
914         /* enqueue notif message or toggle bits */
915         if (ne && nm->flags & NOTIF_MSG) {
916                 if (bcq_enqueue(&vcpd->notif_evts, ne, NR_PERCORE_EVENTS, 4)) {
917                         atomic_inc((atomic_t)&vcpd->event_overflows); // careful here
918                         SET_BITMASK_BIT_ATOMIC(vcpd->notif_bmask, notif);
919                 }
920         } else {
921                 SET_BITMASK_BIT_ATOMIC(vcpd->notif_bmask, notif);
922         }
923
924         /* Active notification */
925         /* TODO: Currently, there is a race for notif_pending, and multiple senders
926          * can send an IPI.  Worst thing is that the process gets interrupted
927          * briefly and the kernel immediately returns back once it realizes notifs
928          * are masked.  To fix it, we'll need atomic_swapb() (right answer), or not
929          * use a bool. (wrong answer). */
930         if (nm->flags & NOTIF_IPI && !vcpd->notif_pending) {
931                 vcpd->notif_pending = TRUE;
932                 if (vcpd->notif_enabled) {
933                         /* GIANT WARNING: we aren't using the proc-lock to protect the
934                          * vcoremap.  We want to be able to use this from interrupt context,
935                          * and don't want the proc_lock to be an irqsave.
936                          */
937                         if ((p->state & PROC_RUNNING_M) && // TODO: (VC#) (_S state)
938                                       (p->procinfo->vcoremap[vcoreid].valid)) {
939                                 printd("[kernel] sending notif to vcore %d\n", vcoreid);
940                                 send_kernel_message(p->procinfo->vcoremap[vcoreid].pcoreid,
941                                                     __notify, p, 0, 0, KMSG_ROUTINE);
942                         } else { // TODO: think about this, fallback, etc
943                                 warn("Vcore unmapped, not receiving an active notif");
944                         }
945                 }
946         }
947 }
948
949 /* Sends notification number notif to proc p.  Meant for generic notifications /
950  * reference implementation.  do_notify does the real work.  This one mostly
951  * just determines where the notif should be sent, other checks, etc.
952  * Specifically, it handles the parameters of notif_methods.  If you happen to
953  * notify yourself, make sure you process routine kmsgs. */
954 void proc_notify(struct proc *p, unsigned int notif, struct notif_event *ne)
955 {
956         assert(notif < MAX_NR_NOTIF); // notifs start at 0
957         struct notif_method *nm = &p->procdata->notif_methods[notif];
958         struct notif_event local_ne;
959
960         /* Caller can opt to not send an NE, in which case we use the notif */
961         if (!ne) {
962                 ne = &local_ne;
963                 ne->ne_type = notif;
964         }
965
966         if (!(nm->flags & NOTIF_WANTED))
967                 return;
968         do_notify(p, nm->vcoreid, ne->ne_type, ne);
969 }
970
971 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
972  * out). */
973 uint32_t proc_get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
974 {
975         uint32_t vcoreid;
976         // TODO: the code currently doesn't track the vcoreid properly for _S (VC#)
977         spin_lock(&p->proc_lock);
978         switch (p->state) {
979                 case PROC_RUNNING_S:
980                         spin_unlock(&p->proc_lock);
981                         return 0; // TODO: here's the ugly part
982                 case PROC_RUNNING_M:
983                         vcoreid = get_vcoreid(p, pcoreid);
984                         spin_unlock(&p->proc_lock);
985                         return vcoreid;
986                 case PROC_DYING: // death message is on the way
987                         spin_unlock(&p->proc_lock);
988                         return 0;
989                 default:
990                         spin_unlock(&p->proc_lock);
991                         panic("Weird state(%s) in %s()", procstate2str(p->state),
992                               __FUNCTION__);
993         }
994 }
995
996 /* Gives process p the additional num cores listed in pcorelist.  You must be
997  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
998  * startup your new cores at the entry point with their virtual IDs (or restore
999  * a preemption).  If you're RUNNABLE_M, you should call proc_run after this so
1000  * that the process can start to use its cores.
1001  *
1002  * If you're *_S, make sure your core0's TF is set (which is done when coming in
1003  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
1004  * Then call proc_run().
1005  *
1006  * The reason I didn't bring the _S cases from core_request over here is so we
1007  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
1008  * this is called from another core, and to avoid the need_to_idle business.
1009  * The other way would be to have this function have the side effect of changing
1010  * state, and finding another way to do the need_to_idle.
1011  *
1012  * The returned bool signals whether or not a stack-crushing IPI will come in
1013  * once you unlock after this function.
1014  *
1015  * WARNING: You must hold the proc_lock before calling this! */
1016 bool __proc_give_cores(struct proc *SAFE p, uint32_t *pcorelist, size_t num)
1017 { TRUSTEDBLOCK
1018 #ifdef __CONFIG_EXPER_TRADPROC__
1019         assert(is_real_proc(p));
1020 #endif /* __CONFIG_EXPER_TRADPROC__ */
1021         bool self_ipi_pending = FALSE;
1022         uint32_t free_vcoreid = 0;
1023         switch (p->state) {
1024                 case (PROC_RUNNABLE_S):
1025                 case (PROC_RUNNING_S):
1026                         panic("Don't give cores to a process in a *_S state!\n");
1027                         break;
1028                 case (PROC_DYING):
1029                         panic("Attempted to give cores to a DYING process.\n");
1030                         break;
1031                 case (PROC_RUNNABLE_M):
1032                         // set up vcoremap.  list should be empty, but could be called
1033                         // multiple times before proc_running (someone changed their mind?)
1034                         if (p->procinfo->num_vcores) {
1035                                 printk("[kernel] Yaaaaaarrrrr!  Giving extra cores, are we?\n");
1036                                 // debugging: if we aren't packed, then there's a problem
1037                                 // somewhere, like someone forgot to take vcores after
1038                                 // preempting.
1039                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
1040                                         assert(p->procinfo->vcoremap[i].valid);
1041                         }
1042                         // add new items to the vcoremap
1043 #ifdef __CONFIG_EXPER_TRADPROC__
1044                         __proc_set_state(p, PROC_RUNNING_M);
1045                         // want an extra one since res_req jacked on on our transition
1046                         p->env_refcnt++;
1047 #endif /* __CONFIG_EXPER_TRADPROC__ */
1048                         __seq_start_write(&p->procinfo->coremap_seqctr);
1049                         for (int i = 0; i < num; i++) {
1050                                 // find the next free slot, which should be the next one
1051                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
1052                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
1053                                        pcorelist[i]);
1054                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
1055                                 p->procinfo->num_vcores++;
1056 #ifdef __CONFIG_EXPER_TRADPROC__
1057                                 struct proc *fake_proc;
1058                                 /* every vcore is a fake proc */
1059                                 fake_proc_alloc(&fake_proc, p, free_vcoreid);
1060                                 local_schedule_proc(pcorelist[i], fake_proc);
1061 #endif /* __CONFIG_EXPER_TRADPROC__ */
1062                         }
1063                         __seq_end_write(&p->procinfo->coremap_seqctr);
1064                         break;
1065                 case (PROC_RUNNING_M):
1066                         /* Up the refcnt, since num cores are going to start using this
1067                          * process and have it loaded in their 'current'. */
1068                         // TODO: (REF) use proc_incref once we have atomics
1069 #ifndef __CONFIG_EXPER_TRADPROC__ // the refcnt is done in fake_proc_alloc
1070                         p->env_refcnt += num;
1071 #endif /* __CONFIG_EXPER_TRADPROC__ */
1072                         __seq_start_write(&p->procinfo->coremap_seqctr);
1073                         for (int i = 0; i < num; i++) {
1074                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
1075                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
1076                                        pcorelist[i]);
1077                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
1078                                 p->procinfo->num_vcores++;
1079 #ifdef __CONFIG_EXPER_TRADPROC__
1080                                 struct proc *fake_proc;
1081                                 fake_proc_alloc(&fake_proc, p, free_vcoreid);
1082                                 local_schedule_proc(pcorelist[i], fake_proc);
1083 #else
1084                                 send_kernel_message(pcorelist[i], __startcore, p, 0, 0,
1085                                                     KMSG_ROUTINE);
1086 #endif /* __CONFIG_EXPER_TRADPROC__ */
1087                                 if (pcorelist[i] == core_id())
1088                                         self_ipi_pending = TRUE;
1089                         }
1090                         __seq_end_write(&p->procinfo->coremap_seqctr);
1091                         break;
1092                 default:
1093                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1094                               __FUNCTION__);
1095         }
1096         p->resources[RES_CORES].amt_granted += num;
1097         return self_ipi_pending;
1098 }
1099
1100 /* Makes process p's coremap look like pcorelist (add, remove, etc).  Caller
1101  * needs to know what cores are free after this call (removed, failed, etc).
1102  * This info will be returned via corelist and *num.  This will send message to
1103  * any cores that are getting removed.
1104  *
1105  * Before implementing this, we should probably think about when this will be
1106  * used.  Implies preempting for the message.  The more that I think about this,
1107  * the less I like it.  For now, don't use this, and think hard before
1108  * implementing it.
1109  *
1110  * WARNING: You must hold the proc_lock before calling this! */
1111 bool __proc_set_allcores(struct proc *SAFE p, uint32_t *pcorelist,
1112                          size_t *num, amr_t message,TV(a0t) arg0,
1113                          TV(a1t) arg1, TV(a2t) arg2)
1114 {
1115         panic("Set all cores not implemented.\n");
1116 }
1117
1118 /* Takes from process p the num cores listed in pcorelist, using the given
1119  * message for the kernel message (__death, __preempt, etc).  Like the others
1120  * in this function group, bool signals whether or not an IPI is pending.
1121  *
1122  * WARNING: You must hold the proc_lock before calling this! */
1123 bool __proc_take_cores(struct proc *SAFE p, uint32_t *pcorelist,
1124                        size_t num, amr_t message, TV(a0t) arg0,
1125                        TV(a1t) arg1, TV(a2t) arg2)
1126 { TRUSTEDBLOCK
1127 #ifdef __CONFIG_EXPER_TRADPROC__
1128         assert(is_real_proc(p));
1129         assert(0);
1130 #endif /* __CONFIG_EXPER_TRADPROC__ */
1131         uint32_t vcoreid, pcoreid;
1132         bool self_ipi_pending = FALSE;
1133         switch (p->state) {
1134                 case (PROC_RUNNABLE_M):
1135                         assert(!message);
1136                         break;
1137                 case (PROC_RUNNING_M):
1138                         assert(message);
1139                         break;
1140                 default:
1141                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1142                               __FUNCTION__);
1143         }
1144         spin_lock(&idle_lock);
1145         assert((num <= p->procinfo->num_vcores) &&
1146                (num_idlecores + num <= num_cpus));
1147         spin_unlock(&idle_lock);
1148         __seq_start_write(&p->procinfo->coremap_seqctr);
1149         for (int i = 0; i < num; i++) {
1150                 vcoreid = get_vcoreid(p, pcorelist[i]);
1151                 // while ugly, this is done to facilitate merging with take_all_cores
1152                 pcoreid = p->procinfo->vcoremap[vcoreid].pcoreid;
1153                 assert(pcoreid == pcorelist[i]);
1154                 if (message) {
1155                         if (pcoreid == core_id())
1156                                 self_ipi_pending = TRUE;
1157                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
1158                                             KMSG_ROUTINE);
1159                 } else {
1160                         /* if there was a msg, the vcore is unmapped on the receive side.
1161                          * o/w, we need to do it here. */
1162                         __unmap_vcore(p, vcoreid);
1163                 }
1164                 // give the pcore back to the idlecoremap
1165                 put_idle_core(pcoreid);
1166         }
1167         p->procinfo->num_vcores -= num;
1168         __seq_end_write(&p->procinfo->coremap_seqctr);
1169         p->resources[RES_CORES].amt_granted -= num;
1170         return self_ipi_pending;
1171 }
1172
1173 /* Takes all cores from a process, which must be in an _M state.  Cores are
1174  * placed back in the idlecoremap.  If there's a message, such as __death or
1175  * __preempt, it will be sent to the cores.  The bool signals whether or not an
1176  * IPI is coming in once you unlock.
1177  *
1178  * WARNING: You must hold the proc_lock before calling this! */
1179 bool __proc_take_allcores(struct proc *SAFE p, amr_t message,
1180                           TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
1181 {
1182 #ifdef __CONFIG_EXPER_TRADPROC__
1183         assert(is_real_proc(p));
1184 #endif /* __CONFIG_EXPER_TRADPROC__ */
1185         uint32_t active_vcoreid = 0, pcoreid;
1186         bool self_ipi_pending = FALSE;
1187         switch (p->state) {
1188                 case (PROC_RUNNABLE_M):
1189                         assert(!message);
1190                         break;
1191                 case (PROC_RUNNING_M):
1192                         assert(message);
1193                         break;
1194                 default:
1195                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1196                               __FUNCTION__);
1197         }
1198         spin_lock(&idle_lock);
1199         assert(num_idlecores + p->procinfo->num_vcores <= num_cpus); // sanity
1200         spin_unlock(&idle_lock);
1201         __seq_start_write(&p->procinfo->coremap_seqctr);
1202 #ifdef __CONFIG_EXPER_TRADPROC__
1203         /* Decref each child, so they will free themselves when they unmap */
1204         for (int i = 1; i < MAX_NUM_CPUS; i++) {
1205                 if (p->vcore_procs[i])
1206                         proc_decref(p->vcore_procs[i], 1);
1207         }
1208 #endif /* __CONFIG_EXPER_TRADPROC__ */
1209         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1210                 // find next active vcore
1211                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1212                 pcoreid = p->procinfo->vcoremap[active_vcoreid].pcoreid;
1213                 if (message) {
1214                         if (pcoreid == core_id())
1215                                 self_ipi_pending = TRUE;
1216                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
1217                                             KMSG_ROUTINE);
1218                 } else {
1219                         /* if there was a msg, the vcore is unmapped on the receive side.
1220                          * o/w, we need to do it here. */
1221                         __unmap_vcore(p, active_vcoreid);
1222                 }
1223                 // give the pcore back to the idlecoremap
1224                 put_idle_core(pcoreid);
1225                 active_vcoreid++; // for the next loop, skip the one we just used
1226         }
1227         p->procinfo->num_vcores = 0;
1228         __seq_end_write(&p->procinfo->coremap_seqctr);
1229         p->resources[RES_CORES].amt_granted = 0;
1230         return self_ipi_pending;
1231 }
1232
1233 /* Helper, to be used when a proc management kmsg should be on its way.  This
1234  * used to also unlock and then handle the message, back when the proc_lock was
1235  * an irqsave, and we had an IPI pending.  Now we use routine kmsgs.  If a msg
1236  * is pending, this needs to decref (to eat the reference of the caller) and
1237  * then process the message.  Unlock before calling this, since you might not
1238  * return.
1239  *
1240  * There should already be a kmsg waiting for us, since when we checked state to
1241  * see a message was coming, the message had already been sent before unlocking.
1242  * Note we do not need interrupts enabled for this to work (you can receive a
1243  * message before its IPI by polling), though in most cases they will be. 
1244  *
1245  * TODO: consider inlining this, so __FUNCTION__ works (will require effort in
1246  * core_request(). */
1247 void __proc_kmsg_pending(struct proc *p, bool ipi_pending)
1248 {
1249         if (ipi_pending) {
1250                 proc_decref(p, 1);
1251                 process_routine_kmsg();
1252                 panic("stack-killing kmsg not found in %s!!!", __FUNCTION__);
1253         }
1254 }
1255
1256 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
1257  * calling. */
1258 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
1259 {
1260         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
1261         p->procinfo->vcoremap[vcoreid].valid = TRUE;
1262         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
1263         p->procinfo->pcoremap[pcoreid].valid = TRUE;
1264 }
1265
1266 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
1267  * calling. */
1268 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
1269 {
1270         p->procinfo->vcoremap[vcoreid].valid = FALSE;
1271         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid = FALSE;
1272 }
1273
1274 /* This takes a referenced process and ups the refcnt by count.  If the refcnt
1275  * was already 0, then someone has a bug, so panic.  Check out the Documentation
1276  * for brutal details about refcnting.
1277  *
1278  * Implementation aside, the important thing is that we atomically increment
1279  * only if it wasn't already 0.  If it was 0, panic.
1280  *
1281  * TODO: (REF) change to use CAS / atomics. */
1282 void proc_incref(struct proc *p, size_t count)
1283 {
1284         spin_lock_irqsave(&p->proc_lock);
1285         if (p->env_refcnt)
1286                 p->env_refcnt += count;
1287         else
1288                 panic("Tried to incref a proc with no existing references!");
1289         spin_unlock_irqsave(&p->proc_lock);
1290 }
1291
1292 /* When the kernel is done with a process, it decrements its reference count.
1293  * When the count hits 0, no one is using it and it should be freed.  "Last one
1294  * out" actually finalizes the death of the process.  This is tightly coupled
1295  * with the previous function (incref)
1296  *
1297  * TODO: (REF) change to use CAS.  Note that when we do so, we may be holding
1298  * the process lock when calling __proc_free().  Think about what order to do
1299  * those calls in (unlock, then decref?), and the race with someone unlocking
1300  * while someone else is __proc_free()ing. */
1301 void proc_decref(struct proc *p, size_t count)
1302 {
1303         spin_lock_irqsave(&p->proc_lock);
1304         p->env_refcnt -= count;
1305         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
1306         spin_unlock_irqsave(&p->proc_lock);
1307         // if we hit 0, no one else will increment and we can check outside the lock
1308         if (!refcnt)
1309                 __proc_free(p);
1310         if (refcnt < 0)
1311                 panic("Too many decrefs!");
1312 }
1313
1314 /* Kernel message handler to start a process's context on this core.  Tightly
1315  * coupled with proc_run().  Interrupts are disabled. */
1316 void __startcore(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1317 {
1318         uint32_t pcoreid = core_id(), vcoreid;
1319         struct proc *p_to_run = (struct proc *CT(1))a0;
1320         struct trapframe local_tf;
1321         struct preempt_data *vcpd;
1322
1323         assert(p_to_run);
1324         /* the sender of the amsg increfed, thinking we weren't running current. */
1325         if (p_to_run == current)
1326                 proc_decref(p_to_run, 1);
1327         vcoreid = get_vcoreid(p_to_run, pcoreid);
1328         vcpd = &p_to_run->procdata->vcore_preempt_data[vcoreid];
1329         printd("[kernel] startcore on physical core %d for process %d's vcore %d\n",
1330                pcoreid, p_to_run->pid, vcoreid);
1331
1332         if (seq_is_locked(vcpd->preempt_tf_valid)) {
1333                 __seq_end_write(&vcpd->preempt_tf_valid); /* mark tf as invalid */
1334                 restore_fp_state(&vcpd->preempt_anc);
1335                 /* notif_pending and enabled means the proc wants to receive the IPI,
1336                  * but might have missed it.  copy over the tf so they can restart it
1337                  * later, and give them a fresh vcore. */
1338                 if (vcpd->notif_pending && vcpd->notif_enabled) {
1339                         vcpd->notif_tf = vcpd->preempt_tf; // could memset
1340                         proc_init_trapframe(&local_tf, vcoreid, p_to_run->env_entry,
1341                                             vcpd->transition_stack);
1342                         vcpd->notif_enabled = FALSE;
1343                         vcpd->notif_pending = FALSE;
1344                 } else {
1345                         /* copy-in the tf we'll pop, then set all security-related fields */
1346                         local_tf = vcpd->preempt_tf;
1347                         proc_secure_trapframe(&local_tf);
1348                 }
1349         } else { /* not restarting from a preemption, use a fresh vcore */
1350                 proc_init_trapframe(&local_tf, vcoreid, p_to_run->env_entry,
1351                                     vcpd->transition_stack);
1352                 /* Disable/mask active notifications for fresh vcores */
1353                 vcpd->notif_enabled = FALSE;
1354         }
1355         __proc_startcore(p_to_run, &local_tf); // TODO: (HSS) pass silly state *?
1356 }
1357
1358 /* Bail out if it's the wrong process, or if they no longer want a notif.  Make
1359  * sure that you are passing in a user tf (otherwise, it's a bug).  Try not to
1360  * grab locks or write access to anything that isn't per-core in here. */
1361 void __notify(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1362 {
1363         struct user_trapframe local_tf;
1364         struct preempt_data *vcpd;
1365         uint32_t vcoreid;
1366         struct proc *p = (struct proc*)a0;
1367
1368         if (p != current)
1369                 return;
1370         assert(!in_kernel(tf));
1371         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1372          * mapping would only happen if the vcore was free, which it isn't until
1373          * after we unmap. */
1374         vcoreid = get_vcoreid(p, core_id());
1375         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1376         printd("received active notification for proc %d's vcore %d on pcore %d\n",
1377                p->procinfo->pid, vcoreid, core_id());
1378         /* sort signals.  notifs are now masked, like an interrupt gate */
1379         if (!vcpd->notif_enabled)
1380                 return;
1381         vcpd->notif_enabled = FALSE;
1382         vcpd->notif_pending = FALSE; // no longer pending - it made it here
1383         /* save the old tf in the notify slot, build and pop a new one.  Note that
1384          * silly state isn't our business for a notification. */
1385         // TODO: this is assuming the struct user_tf is the same as a regular TF
1386         vcpd->notif_tf = *tf;
1387         memset(&local_tf, 0, sizeof(local_tf));
1388         proc_init_trapframe(&local_tf, vcoreid, p->env_entry,
1389                             vcpd->transition_stack);
1390         __proc_startcore(p, &local_tf);
1391 }
1392
1393 /* Stop running whatever context is on this core, load a known-good cr3, and
1394  * 'idle'.  Note this leaves no trace of what was running. This "leaves the
1395  * process's context. */
1396 void abandon_core(void)
1397 {
1398         if (current)
1399                 __abandon_core();
1400         smp_idle();
1401 }
1402
1403 void __preempt(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1404 {
1405         struct preempt_data *vcpd;
1406         uint32_t vcoreid, coreid = core_id();
1407         struct proc *p = (struct proc*)a0;
1408
1409         if (p != current)
1410                 warn("__preempt arrived for a process that was not current!");
1411         assert(!in_kernel(tf));
1412         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1413          * mapping would only happen if the vcore was free, which it isn't until
1414          * after we unmap. */
1415         vcoreid = get_vcoreid(p, coreid);
1416         p->procinfo->vcoremap[vcoreid].preempt_served = FALSE;
1417         /* either __preempt or proc_yield() ends the preempt phase. */
1418         p->procinfo->vcoremap[vcoreid].preempt_pending = 0;
1419         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1420         printk("[kernel] received __preempt for proc %d's vcore %d on pcore %d\n",
1421                p->procinfo->pid, vcoreid, core_id());
1422
1423         /* save the old tf in the preempt slot, save the silly state, and signal the
1424          * state is a valid tf.  when it is 'written,' it is valid.  Using the
1425          * seq_ctrs so userspace can tell between different valid versions.  If the
1426          * TF was already valid, it will panic (if CONFIGed that way). */
1427         // TODO: this is assuming the struct user_tf is the same as a regular TF
1428         vcpd->preempt_tf = *tf;
1429         save_fp_state(&vcpd->preempt_anc);
1430         __seq_start_write(&vcpd->preempt_tf_valid);
1431         __unmap_vcore(p, vcoreid);
1432         abandon_core();
1433 }
1434
1435 /* Kernel message handler to clean up the core when a process is dying.
1436  * Note this leaves no trace of what was running.
1437  * It's okay if death comes to a core that's already idling and has no current.
1438  * It could happen if a process decref'd before __proc_startcore could incref. */
1439 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
1440              void *SNT a2)
1441 {
1442         uint32_t vcoreid, coreid = core_id();
1443         if (current) {
1444                 vcoreid = get_vcoreid(current, coreid);
1445                 printd("[kernel] death on physical core %d for process %d's vcore %d\n",
1446                        coreid, current->pid, vcoreid);
1447                 __unmap_vcore(current, vcoreid);
1448         }
1449         abandon_core();
1450 }
1451
1452 void print_idlecoremap(void)
1453 {
1454         spin_lock(&idle_lock);
1455         printk("There are %d idle cores.\n", num_idlecores);
1456         for (int i = 0; i < num_idlecores; i++)
1457                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
1458         spin_unlock(&idle_lock);
1459 }
1460
1461 void print_allpids(void)
1462 {
1463         spin_lock(&pid_hash_lock);
1464         if (hashtable_count(pid_hash)) {
1465                 hashtable_itr_t *phtable_i = hashtable_iterator(pid_hash);
1466                 printk("PID      STATE    \n");
1467                 printk("------------------\n");
1468                 do {
1469                         struct proc *p = hashtable_iterator_value(phtable_i);
1470                         printk("%8d %s\n", hashtable_iterator_key(phtable_i),
1471                                p ? procstate2str(p->state) : "(null)");
1472                 } while (hashtable_iterator_advance(phtable_i));
1473         }
1474         spin_unlock(&pid_hash_lock);
1475 }
1476
1477 void print_proc_info(pid_t pid)
1478 {
1479         int j = 0;
1480         struct proc *p = pid2proc(pid);
1481         // not concerned with a race on the state...
1482         if (!p) {
1483                 printk("Bad PID.\n");
1484                 return;
1485         }
1486         spinlock_debug(&p->proc_lock);
1487         spin_lock(&p->proc_lock);
1488         printk("struct proc: %p\n", p);
1489         printk("PID: %d\n", p->pid);
1490         printk("PPID: %d\n", p->ppid);
1491         printk("State: 0x%08x\n", p->state);
1492         printk("Refcnt: %d\n", p->env_refcnt - 1); // don't report our ref
1493         printk("Flags: 0x%08x\n", p->env_flags);
1494         printk("CR3(phys): 0x%08x\n", p->env_cr3);
1495         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
1496         printk("Vcoremap:\n");
1497         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1498                 j = get_busy_vcoreid(p, j);
1499                 printk("\tVcore %d: Pcore %d\n", j, p->procinfo->vcoremap[j].pcoreid);
1500                 j++;
1501         }
1502         printk("Resources:\n");
1503         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
1504                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
1505                        p->resources[i].amt_wanted, p->resources[i].amt_granted);
1506         printk("Vcore 0's Last Trapframe:\n");
1507         print_trapframe(&p->env_tf);
1508         spin_unlock(&p->proc_lock);
1509         proc_decref(p, 1); /* decref for the pid2proc reference */
1510 }