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