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