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