d176b65a91eaa2f8861dde82a0212b5b0559dc9c
[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 #ifdef __CONFIG_OSDI__ /* for experiment coordination */
474         extern struct proc *mgr_p1, *mgr_p2;
475         /* Signal to the monitor we're done */
476         if (p == mgr_p1)
477                 mgr_p1 = 0;
478         if (p == mgr_p2)
479                 mgr_p2 = 0;
480         printk("[T]:004:E:%llu\n", read_tsc());
481 #endif /* __CONFIG_EXPER_TRADPROC__ */
482 }
483
484 /* Whether or not actor can control target.  Note we currently don't need
485  * locking for this. TODO: think about that, esp wrt proc's dying. */
486 bool proc_controls(struct proc *actor, struct proc *target)
487 {
488         return ((actor == target) || (target->ppid == actor->pid));
489 }
490
491 /* Dispatches a process to run, either on the current core in the case of a
492  * RUNNABLE_S, or on its partition in the case of a RUNNABLE_M.  This should
493  * never be called to "restart" a core.  This expects that the "instructions"
494  * for which core(s) to run this on will be in the vcoremap, which needs to be
495  * set externally.
496  *
497  * When a process goes from RUNNABLE_M to RUNNING_M, its vcoremap will be
498  * "packed" (no holes in the vcore->pcore mapping), vcore0 will continue to run
499  * it's old core0 context, and the other cores will come in at the entry point.
500  * Including in the case of preemption.
501  *
502  * This won't return if the current core is going to be one of the processes
503  * cores (either for _S mode or for _M if it's in the vcoremap).  proc_run will
504  * eat your reference if it does not return. */
505 void proc_run(struct proc *p)
506 {
507         bool self_ipi_pending = FALSE;
508         spin_lock(&p->proc_lock);
509
510 #ifdef __CONFIG_EXPER_TRADPROC__
511         /* this filth is so the state won't affect how it's run.  whenever we call
512          * proc_run, we think we are RUNNABLE_S.  prob issues with DYING. */
513         switch (p->state) {
514                 case (PROC_DYING):
515                         spin_unlock(&p->proc_lock);
516                         printk("Process %d not starting due to async death\n", p->pid);
517                         if (!management_core())
518                                 smp_idle(); // this never returns
519                         return;
520                 case (PROC_RUNNABLE_S):
521                         assert(current != p);
522                         __proc_set_state(p, PROC_RUNNING_S);
523                         __seq_start_write(&p->procinfo->coremap_seqctr);
524                         p->procinfo->num_vcores = 0;
525                         __map_vcore(p, p->vcoreid, core_id());
526                         __seq_end_write(&p->procinfo->coremap_seqctr);
527                         // fallthru
528                 case (PROC_RUNNING_M):
529                         if (p == current)
530                                 p->env_refcnt--; // TODO: (REF) use incref
531                         spin_unlock(&p->proc_lock);
532                         // TODO: HSS!!
533                         // restore fp state from the preempt slot?
534                         disable_irq();
535                         __proc_startcore(p, &p->env_tf);
536                         break;
537                 default:
538                         panic("Weird state(%s) in %s()", procstate2str(p->state),
539                               __FUNCTION__);
540         }
541         return;
542 #endif /* __CONFIG_EXPER_TRADPROC__ */
543
544         switch (p->state) {
545                 case (PROC_DYING):
546                         spin_unlock(&p->proc_lock);
547                         printk("Process %d not starting due to async death\n", p->pid);
548                         // if we're a worker core, smp_idle, o/w return
549                         if (!management_core())
550                                 smp_idle(); // this never returns
551                         return;
552                 case (PROC_RUNNABLE_S):
553                         assert(current != p);
554                         __proc_set_state(p, PROC_RUNNING_S);
555                         /* We will want to know where this process is running, even if it is
556                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
557                          * Also, this is the signal used in trap.c to know to save the tf in
558                          * env_tf. */
559                         __seq_start_write(&p->procinfo->coremap_seqctr);
560                         p->procinfo->num_vcores = 0;
561                         __map_vcore(p, 0, core_id()); // sort of.  this needs work.
562                         __seq_end_write(&p->procinfo->coremap_seqctr);
563                         /* __proc_startcore assumes the reference we give it is for current.
564                          * Decref if current is already properly set. */
565                         if (p == current)
566                                 p->env_refcnt--; // TODO: (REF) use incref
567                         /* We don't want to process routine messages here, since it's a bit
568                          * different than when we perform a syscall in this process's
569                          * context.  We want interrupts disabled so that if there was a
570                          * routine message on the way, we'll get the interrupt once we pop
571                          * back to userspace.  */
572                         spin_unlock(&p->proc_lock);
573                         disable_irq();
574                         __proc_startcore(p, &p->env_tf);
575                         break;
576                 case (PROC_RUNNABLE_M):
577                         /* vcoremap[i] holds the coreid of the physical core allocated to
578                          * this process.  It is set outside proc_run.  For the kernel
579                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
580                         if (p->procinfo->num_vcores) {
581                                 __proc_set_state(p, PROC_RUNNING_M);
582                                 /* Up the refcnt, since num_vcores are going to start using this
583                                  * process and have it loaded in their 'current'. */
584                                 p->env_refcnt += p->procinfo->num_vcores; // TODO: (REF) use incref
585                                 /* If the core we are running on is in the vcoremap, we will get
586                                  * an IPI (once we reenable interrupts) and never return. */
587                                 if (is_mapped_vcore(p, core_id()))
588                                         self_ipi_pending = TRUE;
589                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
590                                         send_kernel_message(p->procinfo->vcoremap[i].pcoreid,
591                                                             (void *)__startcore, (void *)p, 0, 0,
592                                                             KMSG_ROUTINE);
593                         } else {
594                                 warn("Tried to proc_run() an _M with no vcores!");
595                         }
596                         /* Unlock and decref/wait for the IPI if one is pending.  This will
597                          * eat the reference if we aren't returning.
598                          *
599                          * There a subtle race avoidance here.  __proc_startcore can handle
600                          * a death message, but we can't have the startcore come after the
601                          * death message.  Otherwise, it would look like a new process.  So
602                          * we hold the lock til after we send our message, which prevents a
603                          * possible death message.
604                          * - Note there is no guarantee this core's interrupts were on, so
605                          *   it may not get the message for a while... */
606                         spin_unlock(&p->proc_lock);
607                         __proc_kmsg_pending(p, self_ipi_pending);
608                         break;
609                 default:
610                         spin_unlock(&p->proc_lock);
611                         panic("Invalid process state %p in proc_run()!!", p->state);
612         }
613 }
614
615 /* Actually runs the given context (trapframe) of process p on the core this
616  * code executes on.  This is called directly by __startcore, which needs to
617  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
618  *
619  * A note on refcnting: this function will not return, and your proc reference
620  * will end up stored in current.  This will make no changes to p's refcnt, so
621  * do your accounting such that there is only the +1 for current.  This means if
622  * it is already in current (like in the trap return path), don't up it.  If
623  * it's already in current and you have another reference (like pid2proc or from
624  * an IPI), then down it (which is what happens in __startcore()).  If it's not
625  * in current and you have one reference, like proc_run(non_current_p), then
626  * also do nothing.  The refcnt for your *p will count for the reference stored
627  * in current. */
628 static void __proc_startcore(struct proc *p, trapframe_t *tf)
629 {
630         assert(!irq_is_enabled());
631         /* If the process wasn't here, then we need to load its address space. */
632         if (p != current) {
633                 /* Do not incref here.  We were given the reference to current,
634                  * pre-upped. */
635                 lcr3(p->env_cr3);
636                 /* This is "leaving the process context" of the previous proc.  The
637                  * previous lcr3 unloaded the previous proc's context.  This should
638                  * rarely happen, since we usually proactively leave process context,
639                  * but is the fallback. */
640                 if (current)
641                         proc_decref(current, 1);
642                 set_current_proc(p);
643         }
644         /* need to load our silly state, preferably somewhere other than here so we
645          * can avoid the case where the context was just running here.  it's not
646          * sufficient to do it in the "new process" if-block above (could be things
647          * like page faults that cause us to keep the same process, but want a
648          * different context.
649          * for now, we load this silly state here. (TODO) (HSS)
650          * We also need this to be per trapframe, and not per process...
651          * For now / OSDI, only load it when in _S mode.  _M mode was handled in
652          * __startcore.  */
653         if (p->state == PROC_RUNNING_S)
654                 env_pop_ancillary_state(p);
655         env_pop_tf(tf);
656 }
657
658 /* Restarts the given context (trapframe) of process p on the core this code
659  * executes on.  Calls an internal function to do the work.
660  *
661  * In case there are pending routine messages, like __death, __preempt, or
662  * __notify, we need to run them.  Alternatively, if there are any, we could
663  * self_ipi, and run the messages immediately after popping back to userspace,
664  * but that would have crappy overhead.
665  *
666  * Refcnting: this will not return, and it assumes that you've accounted for
667  * your reference as if it was the ref for "current" (which is what happens when
668  * returning from local traps and such. */
669 void proc_restartcore(struct proc *p, trapframe_t *tf)
670 {
671         /* Need ints disabled when we return from processing (race) */
672         disable_irq();
673         process_routine_kmsg();
674         __proc_startcore(p, tf);
675 }
676
677 /*
678  * Destroys the given process.  This may be called from another process, a light
679  * kernel thread (no real process context), asynchronously/cross-core, or from
680  * the process on its own core.
681  *
682  * Here's the way process death works:
683  * 0. grab the lock (protects state transition and core map)
684  * 1. set state to dying.  that keeps the kernel from doing anything for the
685  * process (like proc_running it).
686  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
687  * 3. IPI to clean up those cores (decref, etc).
688  * 4. Unlock
689  * 5. Clean up your core, if applicable
690  * (Last core/kernel thread to decref cleans up and deallocates resources.)
691  *
692  * Note that some cores can be processing async calls, but will eventually
693  * decref.  Should think about this more, like some sort of callback/revocation.
694  *
695  * This will eat your reference if it won't return.  Note that this function
696  * needs to change anyways when we make __death more like __preempt.  (TODO) */
697 void proc_destroy(struct proc *p)
698 {
699         bool self_ipi_pending = FALSE;
700
701 #ifdef __CONFIG_EXPER_TRADPROC__
702         /* in case a fake proc tries to kill themselves directly */
703         if (!is_real_proc(p)) {
704                 printd("Trying to destroy a fake proc, will kill true proc\n");
705                 proc_destroy(p->true_proc);
706                 return;
707         }
708 #endif /* __CONFIG_EXPER_TRADPROC__ */
709
710         spin_lock(&p->proc_lock);
711
712         /* TODO: (DEATH) look at this again when we sort the __death IPI */
713 #ifdef __CONFIG_EXPER_TRADPROC__
714         if ((current == p) || (current && (current->true_proc == p)))
715 #else
716         if (current == p)
717 #endif /* __CONFIG_EXPER_TRADPROC__ */
718                 self_ipi_pending = TRUE;
719
720         switch (p->state) {
721                 case PROC_DYING: // someone else killed this already.
722                         spin_unlock(&p->proc_lock);
723                         __proc_kmsg_pending(p, self_ipi_pending);
724                         return;
725                 case PROC_RUNNABLE_M:
726                         /* Need to reclaim any cores this proc might have, even though it's
727                          * not running yet. */
728                         __proc_take_allcores(p, NULL, NULL, NULL, NULL);
729                         // fallthrough
730                 case PROC_RUNNABLE_S:
731                         // Think about other lists, like WAITING, or better ways to do this
732                         deschedule_proc(p);
733                         break;
734                 case PROC_RUNNING_S:
735                         #if 0
736                         // here's how to do it manually
737                         if (current == p) {
738                                 lcr3(boot_cr3);
739                                 proc_decref(p, 1); // this decref is for the cr3
740                                 current = NULL;
741                         }
742                         #endif
743                         send_kernel_message(p->procinfo->vcoremap[0].pcoreid, __death,
744                                            (void *SNT)0, (void *SNT)0, (void *SNT)0,
745                                            KMSG_ROUTINE);
746                         __seq_start_write(&p->procinfo->coremap_seqctr);
747                         // TODO: might need to sort num_vcores too later (VC#)
748                         /* vcore is unmapped on the receive side */
749                         __seq_end_write(&p->procinfo->coremap_seqctr);
750                         #if 0
751                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
752                          * managed by the idlecoremap.  so don't do this yet. */
753                         put_idle_core(p->procinfo->vcoremap[0].pcoreid);
754                         #endif
755                         break;
756                 case PROC_RUNNING_M:
757                         /* Send the DEATH message to every core running this process, and
758                          * deallocate the cores.
759                          * The rule is that the vcoremap is set before proc_run, and reset
760                          * within proc_destroy */
761                         __proc_take_allcores(p, __death, (void *SNT)0, (void *SNT)0,
762                                              (void *SNT)0);
763                         break;
764                 default:
765                         panic("Weird state(%s) in %s()", procstate2str(p->state),
766                               __FUNCTION__);
767         }
768         __proc_set_state(p, PROC_DYING);
769         /* this decref is for the process in general */
770         p->env_refcnt--; // TODO (REF)
771         //proc_decref(p, 1);
772
773         /* Unlock and possible decref and wait.  A death IPI should be on its way,
774          * either from the RUNNING_S one, or from proc_take_cores with a __death.
775          * in general, interrupts should be on when you call proc_destroy locally,
776          * but currently aren't for all things (like traphandlers). */
777         spin_unlock(&p->proc_lock);
778         __proc_kmsg_pending(p, self_ipi_pending);
779         return;
780 }
781
782 /* Helper function.  Starting from prev, it will find the next free vcoreid,
783  * which is the next vcore that is not valid.
784  * You better hold the lock before calling this. */
785 static uint32_t get_free_vcoreid(struct proc *SAFE p, uint32_t prev)
786 {
787         uint32_t i;
788         for (i = prev; i < MAX_NUM_CPUS; i++)
789                 if (!p->procinfo->vcoremap[i].valid)
790                         break;
791         if (i + 1 >= MAX_NUM_CPUS)
792                 warn("At the end of the vcorelist.  Might want to check that out.");
793         return i;
794 }
795
796 /* Helper function.  Starting from prev, it will find the next busy vcoreid,
797  * which is the next vcore that is valid.
798  * You better hold the lock before calling this. */
799 static uint32_t get_busy_vcoreid(struct proc *SAFE p, uint32_t prev)
800 {
801         uint32_t i;
802         for (i = prev; i < MAX_NUM_CPUS; i++)
803                 if (p->procinfo->vcoremap[i].valid)
804                         break;
805         if (i + 1 >= MAX_NUM_CPUS)
806                 warn("At the end of the vcorelist.  Might want to check that out.");
807         return i;
808 }
809
810 /* Helper function.  Is the given pcore a mapped vcore?  Hold the lock before
811  * calling. */
812 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
813 {
814         return p->procinfo->pcoremap[pcoreid].valid;
815 }
816
817 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
818  * You better hold the lock before calling this.  Panics on failure. */
819 static uint32_t get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
820 {
821         assert(is_mapped_vcore(p, pcoreid));
822         return p->procinfo->pcoremap[pcoreid].vcoreid;
823 }
824
825 /* Yields the calling core.  Must be called locally (not async) for now.
826  * - If RUNNING_S, you just give up your time slice and will eventually return.
827  * - If RUNNING_M, you give up the current vcore (which never returns), and
828  *   adjust the amount of cores wanted/granted.
829  * - If you have only one vcore, you switch to RUNNABLE_M.  When you run again,
830  *   you'll have one guaranteed core, starting from the entry point.
831  *
832  * - RES_CORES amt_wanted will be the amount running after taking away the
833  *   yielder, unless there are none left, in which case it will be 1.
834  *
835  * If the call is being nice, it means that it is in response to a preemption
836  * (which needs to be checked).  If there is no preemption pending, just return.
837  * No matter what, don't adjust the number of cores wanted.
838  *
839  * This usually does not return (abandon_core()), so it will eat your reference.
840  * */
841 void proc_yield(struct proc *SAFE p, bool being_nice)
842 {
843         uint32_t vcoreid = get_vcoreid(p, core_id());
844         struct vcore *vc = &p->procinfo->vcoremap[vcoreid];
845
846 #ifdef __CONFIG_OSDI__
847         bool new_idle_core = FALSE;
848 #endif /* __CONFIG_OSDI__ */
849
850         /* no reason to be nice, return */
851         if (being_nice && !vc->preempt_pending)
852                 return;
853
854 #ifdef __CONFIG_EXPER_TRADPROC__
855         if (p->state & (PROC_RUNNING_M | PROC_DYING))
856                 return;
857 #endif /* __CONFIG_EXPER_TRADPROC__ */
858
859         spin_lock(&p->proc_lock); /* horrible scalability.  =( */
860
861         /* fate is sealed, return and take the preempt message on the way out.
862          * we're making this check while holding the lock, since the preemptor
863          * should hold the lock when sending messages. */
864         if (vc->preempt_served) {
865                 spin_unlock(&p->proc_lock);
866                 return;
867         }
868         /* no need to preempt later, since we are yielding (nice or otherwise) */
869         if (vc->preempt_pending)
870                 vc->preempt_pending = 0;
871
872         switch (p->state) {
873                 case (PROC_RUNNING_S):
874                         p->env_tf= *current_tf;
875                         env_push_ancillary_state(p); // TODO: (HSS)
876                         __proc_set_state(p, PROC_RUNNABLE_S);
877                         schedule_proc(p);
878                         break;
879                 case (PROC_RUNNING_M):
880                         printd("[K] Process %d (%p) is yielding on vcore %d\n", p->pid, p,
881                                get_vcoreid(p, core_id()));
882                         /* TODO: (RMS) the Scheduler cannot handle the Runnable Ms (RMS), so
883                          * don't yield the last vcore.  It's ghetto and for OSDI, but it
884                          * needs to be fixed for all builds, not just CONFIG_OSDI. */
885                         if (p->procinfo->num_vcores == 1) {
886                                 spin_unlock(&p->proc_lock);
887                                 return;
888                         }
889                         __seq_start_write(&p->procinfo->coremap_seqctr);
890                         // give up core
891                         __unmap_vcore(p, get_vcoreid(p, core_id()));
892                         p->resources[RES_CORES].amt_granted = --(p->procinfo->num_vcores);
893                         if (!being_nice)
894                                 p->resources[RES_CORES].amt_wanted = p->procinfo->num_vcores;
895                         __seq_end_write(&p->procinfo->coremap_seqctr);
896                         // add to idle list
897                         put_idle_core(core_id());
898 #ifdef __CONFIG_OSDI__
899                         new_idle_core = TRUE;
900 #endif /* __CONFIG_OSDI__ */
901                         // last vcore?  then we really want 1, and to yield the gang
902                         // TODO: (RMS) will actually do this.
903                         if (p->procinfo->num_vcores == 0) {
904                                 p->resources[RES_CORES].amt_wanted = 1;
905                                 __proc_set_state(p, PROC_RUNNABLE_M);
906                                 schedule_proc(p);
907                         }
908                         break;
909                 default:
910                         // there are races that can lead to this (async death, preempt, etc)
911                         panic("Weird state(%s) in %s()", procstate2str(p->state),
912                               __FUNCTION__);
913         }
914         spin_unlock(&p->proc_lock);
915         proc_decref(p, 1); // need to eat the ref passed in.
916 #ifdef __CONFIG_OSDI__
917         /* If there was a change to the idle cores, try and give our core to someone who was
918          * preempted.  core_request likely won't return.  if that happens, p's
919          * context ought to be cleaned up in the proc_startcore of the new guy. (if
920          * we actually yielded)
921          * TODO: (RMS) do this more intelligently e.g.: kick_scheduler(); */
922         extern struct proc *victim;
923         if (new_idle_core && victim) {
924                 /* this ghetto victim pointer is not an edible reference, and core
925                  * request will eat it when it doesn't return. */
926                 proc_incref(victim, 1);
927                 core_request(victim);
928                 proc_decref(victim, 1);
929         }
930 #endif /* __CONFIG_OSDI__ */
931         /* Clean up the core and idle.  For mgmt cores, they will ultimately call
932          * manager, which will call schedule() and will repick the yielding proc. */
933         abandon_core();
934 }
935
936 /* If you expect to notify yourself, cleanup state and process_routine_kmsg() */
937 void do_notify(struct proc *p, uint32_t vcoreid, unsigned int notif,
938                struct notif_event *ne)
939 {
940         printd("sending notif %d to proc %p\n", notif, p);
941         assert(notif < MAX_NR_NOTIF);
942         if (ne)
943                 assert(notif == ne->ne_type);
944
945         struct notif_method *nm = &p->procdata->notif_methods[notif];
946         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
947
948         printd("nm = %p, vcpd = %p\n", nm, vcpd);
949         /* enqueue notif message or toggle bits */
950         if (ne && nm->flags & NOTIF_MSG) {
951                 if (bcq_enqueue(&vcpd->notif_evts, ne, NR_PERCORE_EVENTS, 4)) {
952                         atomic_inc((atomic_t)&vcpd->event_overflows); // careful here
953                         SET_BITMASK_BIT_ATOMIC(vcpd->notif_bmask, notif);
954                 }
955         } else {
956                 SET_BITMASK_BIT_ATOMIC(vcpd->notif_bmask, notif);
957         }
958
959         /* Active notification */
960         /* TODO: Currently, there is a race for notif_pending, and multiple senders
961          * can send an IPI.  Worst thing is that the process gets interrupted
962          * briefly and the kernel immediately returns back once it realizes notifs
963          * are masked.  To fix it, we'll need atomic_swapb() (right answer), or not
964          * use a bool. (wrong answer). */
965         if (nm->flags & NOTIF_IPI && !vcpd->notif_pending) {
966                 vcpd->notif_pending = TRUE;
967                 if (vcpd->notif_enabled) {
968                         /* GIANT WARNING: we aren't using the proc-lock to protect the
969                          * vcoremap.  We want to be able to use this from interrupt context,
970                          * and don't want the proc_lock to be an irqsave.
971                          */
972                         if ((p->state & PROC_RUNNING_M) && // TODO: (VC#) (_S state)
973                                       (p->procinfo->vcoremap[vcoreid].valid)) {
974                                 printd("[kernel] sending notif to vcore %d\n", vcoreid);
975                                 send_kernel_message(p->procinfo->vcoremap[vcoreid].pcoreid,
976                                                     __notify, p, 0, 0, KMSG_ROUTINE);
977                         } else { // TODO: think about this, fallback, etc
978                                 warn("Vcore unmapped, not receiving an active notif");
979                         }
980                 }
981         }
982 }
983
984 /* Sends notification number notif to proc p.  Meant for generic notifications /
985  * reference implementation.  do_notify does the real work.  This one mostly
986  * just determines where the notif should be sent, other checks, etc.
987  * Specifically, it handles the parameters of notif_methods.  If you happen to
988  * notify yourself, make sure you process routine kmsgs. */
989 void proc_notify(struct proc *p, unsigned int notif, struct notif_event *ne)
990 {
991         assert(notif < MAX_NR_NOTIF); // notifs start at 0
992         struct notif_method *nm = &p->procdata->notif_methods[notif];
993         struct notif_event local_ne;
994
995         /* Caller can opt to not send an NE, in which case we use the notif */
996         if (!ne) {
997                 ne = &local_ne;
998                 ne->ne_type = notif;
999         }
1000
1001         if (!(nm->flags & NOTIF_WANTED))
1002                 return;
1003         do_notify(p, nm->vcoreid, ne->ne_type, ne);
1004 }
1005
1006 /************************  Preemption Functions  ******************************
1007  * Don't rely on these much - I'll be sure to change them up a bit.
1008  *
1009  * Careful about what takes a vcoreid and what takes a pcoreid.  Also, there may
1010  * be weird glitches with setting the state to RUNNABLE_M.  It is somewhat in
1011  * flux.  The num_vcores is changed after take_cores, but some of the messages
1012  * (or local traps) may not yet be ready to handle seeing their future state.
1013  * But they should be, so fix those when they pop up.
1014  *
1015  * TODO: (RMS) we need to actually make the scheduler handle RUNNABLE_Ms and
1016  * then schedule these, or change proc_destroy to not assume they need to be
1017  * descheduled.
1018  *
1019  * Another thing to do would be to make the _core functions take a pcorelist,
1020  * and not just one pcoreid. */
1021
1022 /* Sets a preempt_pending warning for p's vcore, to go off 'when'.  If you care
1023  * about locking, do it before calling.  Takes a vcoreid! */
1024 void __proc_preempt_warn(struct proc *p, uint32_t vcoreid, uint64_t when)
1025 {
1026         /* danger with doing this unlocked: preempt_pending is set, but never 0'd,
1027          * since it is unmapped and not dealt with (TODO)*/
1028         p->procinfo->vcoremap[vcoreid].preempt_pending = when;
1029         /* notify, if they want to hear about this event.  regardless of how they
1030          * want it, we can send this as a bit.  Subject to change. */
1031         if (p->procdata->notif_methods[NE_PREEMPT_PENDING].flags | NOTIF_WANTED)
1032                 do_notify(p, vcoreid, NE_PREEMPT_PENDING, 0);
1033         /* TODO: consider putting in some lookup place for the alarm to find it.
1034          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1035 }
1036
1037 /* Warns all active vcores of an impending preemption.  Hold the lock if you
1038  * care about the mapping (and you should). */
1039 void __proc_preempt_warnall(struct proc *p, uint64_t when)
1040 {
1041         uint32_t active_vcoreid = 0;
1042         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1043                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1044                 __proc_preempt_warn(p, active_vcoreid, when);
1045                 active_vcoreid++;
1046         }
1047         /* TODO: consider putting in some lookup place for the alarm to find it.
1048          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1049 }
1050
1051 // TODO: function to set an alarm, if none is outstanding
1052
1053 /* Raw function to preempt a single core.  Returns TRUE if the calling core will
1054  * get a kmsg.  If you care about locking, do it before calling. */
1055 bool __proc_preempt_core(struct proc *p, uint32_t pcoreid)
1056 {
1057         uint32_t vcoreid = get_vcoreid(p, pcoreid);
1058
1059         p->procinfo->vcoremap[vcoreid].preempt_served = TRUE;
1060         // expects a pcorelist.  assumes pcore is mapped and running_m
1061         return __proc_take_cores(p, &pcoreid, 1, __preempt, p, 0, 0);
1062 }
1063
1064 /* Raw function to preempt every vcore.  Returns TRUE if the calling core will
1065  * get a kmsg.  If you care about locking, do it before calling. */
1066 bool __proc_preempt_all(struct proc *p)
1067 {
1068         /* instead of doing this, we could just preempt_served all possible vcores,
1069          * and not just the active ones.  We would need to sort out a way to deal
1070          * with stale preempt_serveds first.  This might be just as fast anyways. */
1071         uint32_t active_vcoreid = 0;
1072         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1073                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1074                 p->procinfo->vcoremap[active_vcoreid].preempt_served = TRUE;
1075                 active_vcoreid++;
1076         }
1077         return __proc_take_allcores(p, __preempt, p, 0, 0);
1078 }
1079
1080 /* Warns and preempts a vcore from p.  No delaying / alarming, or anything.  The
1081  * warning will be for u usec from now. */
1082 void proc_preempt_core(struct proc *p, uint32_t pcoreid, uint64_t usec)
1083 {
1084         bool self_ipi_pending = FALSE;
1085         uint64_t warn_time = read_tsc() + usec * 1000000 / system_timing.tsc_freq;
1086
1087         /* DYING could be okay */
1088         if (p->state != PROC_RUNNING_M) {
1089                 warn("Tried to preempt from a non RUNNING_M proc!");
1090                 return;
1091         }
1092         spin_lock(&p->proc_lock);
1093         if (is_mapped_vcore(p, pcoreid)) {
1094                 __proc_preempt_warn(p, get_vcoreid(p, pcoreid), warn_time);
1095                 self_ipi_pending = __proc_preempt_core(p, pcoreid);
1096         } else {
1097                 warn("Pcore doesn't belong to the process!!");
1098         }
1099         /* TODO: (RMS) do this once a scheduler can handle RUNNABLE_M, and make sure
1100          * to schedule it */
1101         #if 0
1102         if (!p->procinfo->num_vcores) {
1103                 __proc_set_state(p, PROC_RUNNABLE_M);
1104                 schedule_proc(p);
1105         }
1106         #endif
1107         spin_unlock(&p->proc_lock);
1108         __proc_kmsg_pending(p, self_ipi_pending);
1109 }
1110
1111 /* Warns and preempts all from p.  No delaying / alarming, or anything.  The
1112  * warning will be for u usec from now. */
1113 void proc_preempt_all(struct proc *p, uint64_t usec)
1114 {
1115         bool self_ipi_pending = FALSE;
1116         uint64_t warn_time = read_tsc() + usec * 1000000 / system_timing.tsc_freq;
1117
1118         spin_lock(&p->proc_lock);
1119         /* DYING could be okay */
1120         if (p->state != PROC_RUNNING_M) {
1121                 warn("Tried to preempt from a non RUNNING_M proc!");
1122                 spin_unlock(&p->proc_lock);
1123                 return;
1124         }
1125         __proc_preempt_warnall(p, warn_time);
1126         self_ipi_pending = __proc_preempt_all(p);
1127         assert(!p->procinfo->num_vcores);
1128         /* TODO: (RMS) do this once a scheduler can handle RUNNABLE_M, and make sure
1129          * to schedule it */
1130         #if 0
1131         __proc_set_state(p, PROC_RUNNABLE_M);
1132         schedule_proc(p);
1133         #endif
1134         spin_unlock(&p->proc_lock);
1135         __proc_kmsg_pending(p, self_ipi_pending);
1136 }
1137
1138 /* Give the specific pcore to proc p.  Lots of assumptions, so don't really use
1139  * this.  The proc needs to be _M and prepared for it.  the pcore needs to be
1140  * free, etc. */
1141 void proc_give(struct proc *p, uint32_t pcoreid)
1142 {
1143         bool self_ipi_pending = FALSE;
1144
1145         spin_lock(&p->proc_lock);
1146         // expects a pcorelist, we give it a list of one
1147         self_ipi_pending = __proc_give_cores(p, &pcoreid, 1);
1148         spin_unlock(&p->proc_lock);
1149         __proc_kmsg_pending(p, self_ipi_pending);
1150 }
1151
1152 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
1153  * out). */
1154 uint32_t proc_get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
1155 {
1156         uint32_t vcoreid;
1157         // TODO: the code currently doesn't track the vcoreid properly for _S (VC#)
1158         spin_lock(&p->proc_lock);
1159         switch (p->state) {
1160                 case PROC_RUNNING_S:
1161                         spin_unlock(&p->proc_lock);
1162                         return 0; // TODO: here's the ugly part
1163                 case PROC_RUNNING_M:
1164                         vcoreid = get_vcoreid(p, pcoreid);
1165                         spin_unlock(&p->proc_lock);
1166                         return vcoreid;
1167                 case PROC_DYING: // death message is on the way
1168                         spin_unlock(&p->proc_lock);
1169                         return 0;
1170                 default:
1171                         spin_unlock(&p->proc_lock);
1172                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1173                               __FUNCTION__);
1174         }
1175 }
1176
1177 /* Gives process p the additional num cores listed in pcorelist.  You must be
1178  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
1179  * startup your new cores at the entry point with their virtual IDs (or restore
1180  * a preemption).  If you're RUNNABLE_M, you should call proc_run after this so
1181  * that the process can start to use its cores.
1182  *
1183  * If you're *_S, make sure your core0's TF is set (which is done when coming in
1184  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
1185  * Then call proc_run().
1186  *
1187  * The reason I didn't bring the _S cases from core_request over here is so we
1188  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
1189  * this is called from another core, and to avoid the need_to_idle business.
1190  * The other way would be to have this function have the side effect of changing
1191  * state, and finding another way to do the need_to_idle.
1192  *
1193  * The returned bool signals whether or not a stack-crushing IPI will come in
1194  * once you unlock after this function.
1195  *
1196  * WARNING: You must hold the proc_lock before calling this! */
1197 bool __proc_give_cores(struct proc *SAFE p, uint32_t *pcorelist, size_t num)
1198 { TRUSTEDBLOCK
1199 #ifdef __CONFIG_EXPER_TRADPROC__
1200         assert(is_real_proc(p));
1201 #endif /* __CONFIG_EXPER_TRADPROC__ */
1202         bool self_ipi_pending = FALSE;
1203         uint32_t free_vcoreid = 0;
1204         switch (p->state) {
1205                 case (PROC_RUNNABLE_S):
1206                 case (PROC_RUNNING_S):
1207                         panic("Don't give cores to a process in a *_S state!\n");
1208                         break;
1209                 case (PROC_DYING):
1210                         panic("Attempted to give cores to a DYING process.\n");
1211                         break;
1212                 case (PROC_RUNNABLE_M):
1213                         // set up vcoremap.  list should be empty, but could be called
1214                         // multiple times before proc_running (someone changed their mind?)
1215                         if (p->procinfo->num_vcores) {
1216                                 printk("[kernel] Yaaaaaarrrrr!  Giving extra cores, are we?\n");
1217                                 // debugging: if we aren't packed, then there's a problem
1218                                 // somewhere, like someone forgot to take vcores after
1219                                 // preempting.
1220                                 for (int i = 0; i < p->procinfo->num_vcores; i++)
1221                                         assert(p->procinfo->vcoremap[i].valid);
1222                         }
1223                         // add new items to the vcoremap
1224 #ifdef __CONFIG_EXPER_TRADPROC__
1225                         __proc_set_state(p, PROC_RUNNING_M);
1226 #endif /* __CONFIG_EXPER_TRADPROC__ */
1227                         __seq_start_write(&p->procinfo->coremap_seqctr);
1228                         for (int i = 0; i < num; i++) {
1229                                 // find the next free slot, which should be the next one
1230                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
1231                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
1232                                        pcorelist[i]);
1233                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
1234                                 p->procinfo->num_vcores++;
1235 #ifdef __CONFIG_EXPER_TRADPROC__
1236                                 struct proc *fake_proc;
1237                                 /* every vcore is a fake proc */
1238                                 fake_proc_alloc(&fake_proc, p, free_vcoreid);
1239                                 local_schedule_proc(pcorelist[i], fake_proc);
1240 #endif /* __CONFIG_EXPER_TRADPROC__ */
1241                         }
1242                         __seq_end_write(&p->procinfo->coremap_seqctr);
1243                         break;
1244                 case (PROC_RUNNING_M):
1245                         /* Up the refcnt, since num cores are going to start using this
1246                          * process and have it loaded in their 'current'. */
1247                         // TODO: (REF) use proc_incref once we have atomics
1248 #ifndef __CONFIG_EXPER_TRADPROC__ // the refcnt is done in fake_proc_alloc
1249                         p->env_refcnt += num;
1250 #endif /* __CONFIG_EXPER_TRADPROC__ */
1251                         __seq_start_write(&p->procinfo->coremap_seqctr);
1252                         for (int i = 0; i < num; i++) {
1253                                 free_vcoreid = get_free_vcoreid(p, free_vcoreid);
1254                                 printd("setting vcore %d to pcore %d\n", free_vcoreid,
1255                                        pcorelist[i]);
1256                                 __map_vcore(p, free_vcoreid, pcorelist[i]);
1257                                 p->procinfo->num_vcores++;
1258 #ifdef __CONFIG_EXPER_TRADPROC__
1259                                 struct proc *fake_proc;
1260                                 fake_proc_alloc(&fake_proc, p, free_vcoreid);
1261                                 local_schedule_proc(pcorelist[i], fake_proc);
1262 #else
1263                                 send_kernel_message(pcorelist[i], __startcore, p, 0, 0,
1264                                                     KMSG_ROUTINE);
1265 #endif /* __CONFIG_EXPER_TRADPROC__ */
1266                                 if (pcorelist[i] == core_id())
1267                                         self_ipi_pending = TRUE;
1268                         }
1269                         __seq_end_write(&p->procinfo->coremap_seqctr);
1270                         break;
1271                 default:
1272                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1273                               __FUNCTION__);
1274         }
1275         p->resources[RES_CORES].amt_granted += num;
1276         return self_ipi_pending;
1277 }
1278
1279 /* Makes process p's coremap look like pcorelist (add, remove, etc).  Caller
1280  * needs to know what cores are free after this call (removed, failed, etc).
1281  * This info will be returned via corelist and *num.  This will send message to
1282  * any cores that are getting removed.
1283  *
1284  * Before implementing this, we should probably think about when this will be
1285  * used.  Implies preempting for the message.  The more that I think about this,
1286  * the less I like it.  For now, don't use this, and think hard before
1287  * implementing it.
1288  *
1289  * WARNING: You must hold the proc_lock before calling this! */
1290 bool __proc_set_allcores(struct proc *SAFE p, uint32_t *pcorelist,
1291                          size_t *num, amr_t message,TV(a0t) arg0,
1292                          TV(a1t) arg1, TV(a2t) arg2)
1293 {
1294         panic("Set all cores not implemented.\n");
1295 }
1296
1297 /* Takes from process p the num cores listed in pcorelist, using the given
1298  * message for the kernel message (__death, __preempt, etc).  Like the others
1299  * in this function group, bool signals whether or not an IPI is pending.
1300  *
1301  * WARNING: You must hold the proc_lock before calling this! */
1302 bool __proc_take_cores(struct proc *SAFE p, uint32_t *pcorelist,
1303                        size_t num, amr_t message, TV(a0t) arg0,
1304                        TV(a1t) arg1, TV(a2t) arg2)
1305 { TRUSTEDBLOCK
1306 #ifdef __CONFIG_EXPER_TRADPROC__
1307         assert(is_real_proc(p));
1308         assert(0);
1309 #endif /* __CONFIG_EXPER_TRADPROC__ */
1310         uint32_t vcoreid, pcoreid;
1311         bool self_ipi_pending = FALSE;
1312         switch (p->state) {
1313                 case (PROC_RUNNABLE_M):
1314                         assert(!message);
1315                         break;
1316                 case (PROC_RUNNING_M):
1317                         assert(message);
1318                         break;
1319                 default:
1320                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1321                               __FUNCTION__);
1322         }
1323         spin_lock(&idle_lock);
1324         assert((num <= p->procinfo->num_vcores) &&
1325                (num_idlecores + num <= num_cpus));
1326         spin_unlock(&idle_lock);
1327         __seq_start_write(&p->procinfo->coremap_seqctr);
1328         for (int i = 0; i < num; i++) {
1329                 vcoreid = get_vcoreid(p, pcorelist[i]);
1330                 // while ugly, this is done to facilitate merging with take_all_cores
1331                 pcoreid = p->procinfo->vcoremap[vcoreid].pcoreid;
1332                 assert(pcoreid == pcorelist[i]);
1333                 if (message) {
1334                         if (pcoreid == core_id())
1335                                 self_ipi_pending = TRUE;
1336                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
1337                                             KMSG_ROUTINE);
1338                 } else {
1339                         /* if there was a msg, the vcore is unmapped on the receive side.
1340                          * o/w, we need to do it here. */
1341                         __unmap_vcore(p, vcoreid);
1342                 }
1343                 // give the pcore back to the idlecoremap
1344                 put_idle_core(pcoreid);
1345         }
1346         p->procinfo->num_vcores -= num;
1347         __seq_end_write(&p->procinfo->coremap_seqctr);
1348         p->resources[RES_CORES].amt_granted -= num;
1349         return self_ipi_pending;
1350 }
1351
1352 /* Takes all cores from a process, which must be in an _M state.  Cores are
1353  * placed back in the idlecoremap.  If there's a message, such as __death or
1354  * __preempt, it will be sent to the cores.  The bool signals whether or not an
1355  * IPI is coming in once you unlock.
1356  *
1357  * WARNING: You must hold the proc_lock before calling this! */
1358 bool __proc_take_allcores(struct proc *SAFE p, amr_t message,
1359                           TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
1360 {
1361 #ifdef __CONFIG_EXPER_TRADPROC__
1362         assert(is_real_proc(p));
1363 #endif /* __CONFIG_EXPER_TRADPROC__ */
1364         uint32_t active_vcoreid = 0, pcoreid;
1365         bool self_ipi_pending = FALSE;
1366         switch (p->state) {
1367                 case (PROC_RUNNABLE_M):
1368                         assert(!message);
1369                         break;
1370                 case (PROC_RUNNING_M):
1371                         assert(message);
1372                         break;
1373                 default:
1374                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1375                               __FUNCTION__);
1376         }
1377         spin_lock(&idle_lock);
1378         assert(num_idlecores + p->procinfo->num_vcores <= num_cpus); // sanity
1379         spin_unlock(&idle_lock);
1380         __seq_start_write(&p->procinfo->coremap_seqctr);
1381 #ifdef __CONFIG_EXPER_TRADPROC__
1382         /* Decref each child, so they will free themselves when they unmap */
1383         for (int i = 0; i < MAX_NUM_CPUS; i++) {
1384                 if (p->vcore_procs[i])
1385                         proc_decref(p->vcore_procs[i], 1);
1386         }
1387 #endif /* __CONFIG_EXPER_TRADPROC__ */
1388         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1389                 // find next active vcore
1390                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1391                 pcoreid = p->procinfo->vcoremap[active_vcoreid].pcoreid;
1392                 if (message) {
1393                         if (pcoreid == core_id())
1394                                 self_ipi_pending = TRUE;
1395                         send_kernel_message(pcoreid, message, arg0, arg1, arg2,
1396                                             KMSG_ROUTINE);
1397                 } else {
1398                         /* if there was a msg, the vcore is unmapped on the receive side.
1399                          * o/w, we need to do it here. */
1400                         __unmap_vcore(p, active_vcoreid);
1401                 }
1402                 // give the pcore back to the idlecoremap
1403                 put_idle_core(pcoreid);
1404                 active_vcoreid++; // for the next loop, skip the one we just used
1405         }
1406         p->procinfo->num_vcores = 0;
1407         __seq_end_write(&p->procinfo->coremap_seqctr);
1408         p->resources[RES_CORES].amt_granted = 0;
1409         return self_ipi_pending;
1410 }
1411
1412 /* Helper, to be used when a proc management kmsg should be on its way.  This
1413  * used to also unlock and then handle the message, back when the proc_lock was
1414  * an irqsave, and we had an IPI pending.  Now we use routine kmsgs.  If a msg
1415  * is pending, this needs to decref (to eat the reference of the caller) and
1416  * then process the message.  Unlock before calling this, since you might not
1417  * return.
1418  *
1419  * There should already be a kmsg waiting for us, since when we checked state to
1420  * see a message was coming, the message had already been sent before unlocking.
1421  * Note we do not need interrupts enabled for this to work (you can receive a
1422  * message before its IPI by polling), though in most cases they will be.
1423  *
1424  * TODO: consider inlining this, so __FUNCTION__ works (will require effort in
1425  * core_request(). */
1426 void __proc_kmsg_pending(struct proc *p, bool ipi_pending)
1427 {
1428         if (ipi_pending) {
1429                 proc_decref(p, 1);
1430                 process_routine_kmsg();
1431                 panic("stack-killing kmsg not found in %s!!!", __FUNCTION__);
1432         }
1433 }
1434
1435 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
1436  * calling. */
1437 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
1438 {
1439         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
1440         p->procinfo->vcoremap[vcoreid].valid = TRUE;
1441         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
1442         p->procinfo->pcoremap[pcoreid].valid = TRUE;
1443 }
1444
1445 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
1446  * calling. */
1447 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
1448 {
1449         p->procinfo->vcoremap[vcoreid].valid = FALSE;
1450         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid = FALSE;
1451 }
1452
1453 /* This takes a referenced process and ups the refcnt by count.  If the refcnt
1454  * was already 0, then someone has a bug, so panic.  Check out the Documentation
1455  * for brutal details about refcnting.
1456  *
1457  * Implementation aside, the important thing is that we atomically increment
1458  * only if it wasn't already 0.  If it was 0, panic.
1459  *
1460  * TODO: (REF) change to use CAS / atomics. */
1461 void proc_incref(struct proc *p, size_t count)
1462 {
1463         spin_lock_irqsave(&p->proc_lock);
1464         if (p->env_refcnt)
1465                 p->env_refcnt += count;
1466         else
1467                 panic("Tried to incref a proc with no existing references!");
1468         spin_unlock_irqsave(&p->proc_lock);
1469 }
1470
1471 /* When the kernel is done with a process, it decrements its reference count.
1472  * When the count hits 0, no one is using it and it should be freed.  "Last one
1473  * out" actually finalizes the death of the process.  This is tightly coupled
1474  * with the previous function (incref)
1475  *
1476  * TODO: (REF) change to use CAS.  Note that when we do so, we may be holding
1477  * the process lock when calling __proc_free().  Think about what order to do
1478  * those calls in (unlock, then decref?), and the race with someone unlocking
1479  * while someone else is __proc_free()ing. */
1480 void proc_decref(struct proc *p, size_t count)
1481 {
1482         spin_lock_irqsave(&p->proc_lock);
1483         p->env_refcnt -= count;
1484         size_t refcnt = p->env_refcnt; // need to copy this in so it's not reloaded
1485         spin_unlock_irqsave(&p->proc_lock);
1486         // if we hit 0, no one else will increment and we can check outside the lock
1487         if (!refcnt)
1488                 __proc_free(p);
1489         if (refcnt < 0)
1490                 panic("Too many decrefs!");
1491 }
1492
1493 /* Stop running whatever context is on this core, load a known-good cr3, and
1494  * 'idle'.  Note this leaves no trace of what was running. This "leaves the
1495  * process's context. */
1496 void abandon_core(void)
1497 {
1498         if (current)
1499                 __abandon_core();
1500         smp_idle();
1501 }
1502
1503 /* Will send a TLB shootdown message to every vcore in the main address space
1504  * (aka, all vcores for now).  The message will take the start and end virtual
1505  * addresses as well, in case we want to be more clever about how much we
1506  * shootdown and batching our messages.  Should do the sanity about rounding up
1507  * and down in this function too.
1508  *
1509  * Hold the proc_lock before calling this.
1510  *
1511  * Would be nice to have a broadcast kmsg at this point.  Note this may send a
1512  * message to the calling core (interrupting it, possibly while holding the
1513  * proc_lock).  We don't need to process routine messages since it's an
1514  * immediate message. */
1515 void __proc_tlbshootdown(struct proc *p, uintptr_t start, uintptr_t end)
1516 {
1517         uint32_t active_vcoreid = 0, pcoreid;
1518         /* TODO: (TLB) sanity checks and rounding on the ranges */
1519         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1520                 /* find next active vcore */
1521                 active_vcoreid = get_busy_vcoreid(p, active_vcoreid);
1522                 pcoreid = p->procinfo->vcoremap[active_vcoreid].pcoreid;
1523                 send_kernel_message(pcoreid, __tlbshootdown, (void*)start, (void*)end,
1524                                     (void*)0, KMSG_IMMEDIATE);
1525                 active_vcoreid++; /* for the next loop, skip the one we just used */
1526         }
1527 }
1528
1529 /* Kernel message handler to start a process's context on this core.  Tightly
1530  * coupled with proc_run().  Interrupts are disabled. */
1531 void __startcore(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1532 {
1533         uint32_t pcoreid = core_id(), vcoreid;
1534         struct proc *p_to_run = (struct proc *CT(1))a0;
1535         struct trapframe local_tf;
1536         struct preempt_data *vcpd;
1537
1538         assert(p_to_run);
1539         /* the sender of the amsg increfed, thinking we weren't running current. */
1540         if (p_to_run == current)
1541                 proc_decref(p_to_run, 1);
1542         vcoreid = get_vcoreid(p_to_run, pcoreid);
1543         vcpd = &p_to_run->procdata->vcore_preempt_data[vcoreid];
1544         printd("[kernel] startcore on physical core %d for process %d's vcore %d\n",
1545                pcoreid, p_to_run->pid, vcoreid);
1546
1547         if (seq_is_locked(vcpd->preempt_tf_valid)) {
1548                 __seq_end_write(&vcpd->preempt_tf_valid); /* mark tf as invalid */
1549                 restore_fp_state(&vcpd->preempt_anc);
1550                 /* notif_pending and enabled means the proc wants to receive the IPI,
1551                  * but might have missed it.  copy over the tf so they can restart it
1552                  * later, and give them a fresh vcore. */
1553                 if (vcpd->notif_pending && vcpd->notif_enabled) {
1554                         vcpd->notif_tf = vcpd->preempt_tf; // could memset
1555                         proc_init_trapframe(&local_tf, vcoreid, p_to_run->env_entry,
1556                                             vcpd->transition_stack);
1557                         vcpd->notif_enabled = FALSE;
1558                         vcpd->notif_pending = FALSE;
1559                 } else {
1560                         /* copy-in the tf we'll pop, then set all security-related fields */
1561                         local_tf = vcpd->preempt_tf;
1562                         proc_secure_trapframe(&local_tf);
1563                 }
1564         } else { /* not restarting from a preemption, use a fresh vcore */
1565                 proc_init_trapframe(&local_tf, vcoreid, p_to_run->env_entry,
1566                                     vcpd->transition_stack);
1567                 /* Disable/mask active notifications for fresh vcores */
1568                 vcpd->notif_enabled = FALSE;
1569         }
1570         __proc_startcore(p_to_run, &local_tf); // TODO: (HSS) pass silly state *?
1571 }
1572
1573 /* Bail out if it's the wrong process, or if they no longer want a notif.  Make
1574  * sure that you are passing in a user tf (otherwise, it's a bug).  Try not to
1575  * grab locks or write access to anything that isn't per-core in here. */
1576 void __notify(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1577 {
1578         struct user_trapframe local_tf;
1579         struct preempt_data *vcpd;
1580         uint32_t vcoreid;
1581         struct proc *p = (struct proc*)a0;
1582
1583         if (p != current)
1584                 return;
1585         assert(!in_kernel(tf));
1586         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1587          * mapping would only happen if the vcore was free, which it isn't until
1588          * after we unmap. */
1589         vcoreid = get_vcoreid(p, core_id());
1590         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1591         printd("received active notification for proc %d's vcore %d on pcore %d\n",
1592                p->procinfo->pid, vcoreid, core_id());
1593         /* sort signals.  notifs are now masked, like an interrupt gate */
1594         if (!vcpd->notif_enabled)
1595                 return;
1596         vcpd->notif_enabled = FALSE;
1597         vcpd->notif_pending = FALSE; // no longer pending - it made it here
1598         /* save the old tf in the notify slot, build and pop a new one.  Note that
1599          * silly state isn't our business for a notification. */
1600         // TODO: this is assuming the struct user_tf is the same as a regular TF
1601         vcpd->notif_tf = *tf;
1602         memset(&local_tf, 0, sizeof(local_tf));
1603         proc_init_trapframe(&local_tf, vcoreid, p->env_entry,
1604                             vcpd->transition_stack);
1605         __proc_startcore(p, &local_tf);
1606 }
1607
1608 void __preempt(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2)
1609 {
1610         struct preempt_data *vcpd;
1611         uint32_t vcoreid, coreid = core_id();
1612         struct proc *p = (struct proc*)a0;
1613
1614         if (p != current)
1615                 panic("__preempt arrived for a process (%p) that was not current (%p)!",
1616                       p, current);
1617         assert(!in_kernel(tf));
1618         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1619          * mapping would only happen if the vcore was free, which it isn't until
1620          * after we unmap. */
1621         vcoreid = get_vcoreid(p, coreid);
1622         p->procinfo->vcoremap[vcoreid].preempt_served = FALSE;
1623         /* either __preempt or proc_yield() ends the preempt phase. */
1624         p->procinfo->vcoremap[vcoreid].preempt_pending = 0;
1625         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1626         printd("[kernel] received __preempt for proc %d's vcore %d on pcore %d\n",
1627                p->procinfo->pid, vcoreid, core_id());
1628
1629         /* save the old tf in the preempt slot, save the silly state, and signal the
1630          * state is a valid tf.  when it is 'written,' it is valid.  Using the
1631          * seq_ctrs so userspace can tell between different valid versions.  If the
1632          * TF was already valid, it will panic (if CONFIGed that way). */
1633         // TODO: this is assuming the struct user_tf is the same as a regular TF
1634         vcpd->preempt_tf = *tf;
1635         save_fp_state(&vcpd->preempt_anc);
1636         __seq_start_write(&vcpd->preempt_tf_valid);
1637         __unmap_vcore(p, vcoreid);
1638         abandon_core();
1639 }
1640
1641 /* Kernel message handler to clean up the core when a process is dying.
1642  * Note this leaves no trace of what was running.
1643  * It's okay if death comes to a core that's already idling and has no current.
1644  * It could happen if a process decref'd before __proc_startcore could incref. */
1645 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
1646              void *SNT a2)
1647 {
1648         uint32_t vcoreid, coreid = core_id();
1649         if (current) {
1650                 vcoreid = get_vcoreid(current, coreid);
1651                 printd("[kernel] death on physical core %d for process %d's vcore %d\n",
1652                        coreid, current->pid, vcoreid);
1653                 __unmap_vcore(current, vcoreid);
1654         }
1655         abandon_core();
1656 }
1657
1658 /* Kernel message handler, usually sent IMMEDIATE, to shoot down virtual
1659  * addresses from a0 to a1. */
1660 void __tlbshootdown(struct trapframe *tf, uint32_t srcid, void *a0, void *a1,
1661                     void *a2)
1662 {
1663         /* TODO: (TLB) something more intelligent with the range */
1664         tlbflush();
1665 }
1666
1667 void print_idlecoremap(void)
1668 {
1669         spin_lock(&idle_lock);
1670         printk("There are %d idle cores.\n", num_idlecores);
1671         for (int i = 0; i < num_idlecores; i++)
1672                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
1673         spin_unlock(&idle_lock);
1674 }
1675
1676 void print_allpids(void)
1677 {
1678         spin_lock(&pid_hash_lock);
1679         if (hashtable_count(pid_hash)) {
1680                 hashtable_itr_t *phtable_i = hashtable_iterator(pid_hash);
1681                 printk("PID      STATE    \n");
1682                 printk("------------------\n");
1683                 do {
1684                         struct proc *p = hashtable_iterator_value(phtable_i);
1685                         printk("%8d %s\n", hashtable_iterator_key(phtable_i),
1686                                p ? procstate2str(p->state) : "(null)");
1687                 } while (hashtable_iterator_advance(phtable_i));
1688         }
1689         spin_unlock(&pid_hash_lock);
1690 }
1691
1692 void print_proc_info(pid_t pid)
1693 {
1694         int j = 0;
1695         /* Doing this without the incref! careful! (avoiding deadlocks) TODO (REF)*/
1696         //struct proc *p = pid2proc(pid);
1697         spin_lock(&pid_hash_lock);
1698         struct proc *p = hashtable_search(pid_hash, (void*)pid);
1699         spin_unlock(&pid_hash_lock);
1700         // not concerned with a race on the state...
1701         if (!p) {
1702                 printk("Bad PID.\n");
1703                 return;
1704         }
1705         spinlock_debug(&p->proc_lock);
1706         //spin_lock(&p->proc_lock); // No locking!!
1707         printk("struct proc: %p\n", p);
1708         printk("PID: %d\n", p->pid);
1709         printk("PPID: %d\n", p->ppid);
1710         printk("State: 0x%08x\n", p->state);
1711         printk("Refcnt: %d\n", p->env_refcnt);
1712         printk("Flags: 0x%08x\n", p->env_flags);
1713         printk("CR3(phys): 0x%08x\n", p->env_cr3);
1714         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
1715         printk("Vcoremap:\n");
1716         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1717                 j = get_busy_vcoreid(p, j);
1718                 printk("\tVcore %d: Pcore %d\n", j, p->procinfo->vcoremap[j].pcoreid);
1719                 j++;
1720         }
1721         printk("Resources:\n");
1722         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
1723                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
1724                        p->resources[i].amt_wanted, p->resources[i].amt_granted);
1725 #ifdef __CONFIG_EXPER_TRADPROC__
1726         void print_chain(struct proc *p)
1727         {
1728                 if (!is_real_proc(p)) {
1729                         printk("P is not a true_proc, parent is %p\n", p->true_proc);
1730                         print_chain(p);
1731                 } else {
1732                         printk("P is a true_proc\n");
1733                         for (int i = 0; i < p->procinfo->num_vcores; i++) {
1734                                 printk("%p's child %d is %p\n", p, i, p->vcore_procs[i]);
1735                                 if (p->vcore_procs[i])
1736                                         for (int j = 0; j < MAX_NUM_CPUS; j++)
1737                                                 if (p->vcore_procs[i]->vcore_procs[j])
1738                                                         printk("Crap, child %p has its own child %p!!\n",
1739                                                                p->vcore_procs[i],
1740                                                                p->vcore_procs[i]->vcore_procs[j]);
1741                         }
1742                 }
1743         }
1744         print_chain(p);
1745 #endif /* __CONFIG_EXPER_TRADPROC__ */
1746         /* No one cares, and it clutters the terminal */
1747         //printk("Vcore 0's Last Trapframe:\n");
1748         //print_trapframe(&p->env_tf);
1749         /* no locking / unlocking or refcnting */
1750         // spin_unlock(&p->proc_lock);
1751         // proc_decref(p, 1); /* decref for the pid2proc reference */
1752 }