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