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