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