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