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