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