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