Removes the dumb version of take_allcores
[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 <elf.h>
29 #include <arsc_server.h>
30 #include <devfs.h>
31
32 struct kmem_cache *proc_cache;
33
34 /* Other helpers, implemented later. */
35 static void __proc_startcore(struct proc *p, trapframe_t *tf);
36 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid);
37 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid);
38 static uint32_t try_get_pcoreid(struct proc *p, uint32_t vcoreid);
39 static uint32_t get_pcoreid(struct proc *p, uint32_t vcoreid);
40 static void __proc_free(struct kref *kref);
41
42 /* PID management. */
43 #define PID_MAX 32767 // goes from 0 to 32767, with 0 reserved
44 static DECL_BITMASK(pid_bmask, PID_MAX + 1);
45 spinlock_t pid_bmask_lock = SPINLOCK_INITIALIZER;
46 struct hashtable *pid_hash;
47 spinlock_t pid_hash_lock; // initialized in proc_init
48
49 /* Finds the next free entry (zero) entry in the pid_bitmask.  Set means busy.
50  * PID 0 is reserved (in proc_init).  A return value of 0 is a failure (and
51  * you'll also see a warning, for now).  Consider doing this with atomics. */
52 static pid_t get_free_pid(void)
53 {
54         static pid_t next_free_pid = 1;
55         pid_t my_pid = 0;
56
57         spin_lock(&pid_bmask_lock);
58         // atomically (can lock for now, then change to atomic_and_return
59         FOR_CIRC_BUFFER(next_free_pid, PID_MAX + 1, i) {
60                 // always points to the next to test
61                 next_free_pid = (next_free_pid + 1) % (PID_MAX + 1);
62                 if (!GET_BITMASK_BIT(pid_bmask, i)) {
63                         SET_BITMASK_BIT(pid_bmask, i);
64                         my_pid = i;
65                         break;
66                 }
67         }
68         spin_unlock(&pid_bmask_lock);
69         if (!my_pid)
70                 warn("Shazbot!  Unable to find a PID!  You need to deal with this!\n");
71         return my_pid;
72 }
73
74 /* Return a pid to the pid bitmask */
75 static void put_free_pid(pid_t pid)
76 {
77         spin_lock(&pid_bmask_lock);
78         CLR_BITMASK_BIT(pid_bmask, pid);
79         spin_unlock(&pid_bmask_lock);
80 }
81
82 /* While this could be done with just an assignment, this gives us the
83  * opportunity to check for bad transitions.  Might compile these out later, so
84  * we shouldn't rely on them for sanity checking from userspace.  */
85 int __proc_set_state(struct proc *p, uint32_t state)
86 {
87         uint32_t curstate = p->state;
88         /* Valid transitions:
89          * C   -> RBS
90          * C   -> D
91          * RBS -> RGS
92          * RGS -> RBS
93          * RGS -> W
94          * RGM -> W
95          * W   -> RBS
96          * W   -> RBM
97          * RGS -> RBM
98          * RBM -> RGM
99          * RGM -> RBM
100          * RGM -> RBS
101          * RGS -> D
102          * RGM -> D
103          *
104          * These ought to be implemented later (allowed, not thought through yet).
105          * RBS -> D
106          * RBM -> D
107          */
108         #if 1 // some sort of correctness flag
109         switch (curstate) {
110                 case PROC_CREATED:
111                         if (!(state & (PROC_RUNNABLE_S | PROC_DYING)))
112                                 panic("Invalid State Transition! PROC_CREATED to %02x", state);
113                         break;
114                 case PROC_RUNNABLE_S:
115                         if (!(state & (PROC_RUNNING_S | PROC_DYING)))
116                                 panic("Invalid State Transition! PROC_RUNNABLE_S to %02x", state);
117                         break;
118                 case PROC_RUNNING_S:
119                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
120                                        PROC_DYING)))
121                                 panic("Invalid State Transition! PROC_RUNNING_S to %02x", state);
122                         break;
123                 case PROC_WAITING:
124                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M)))
125                                 panic("Invalid State Transition! PROC_WAITING to %02x", state);
126                         break;
127                 case PROC_DYING:
128                         if (state != PROC_CREATED) // when it is reused (TODO)
129                                 panic("Invalid State Transition! PROC_DYING to %02x", state);
130                         break;
131                 case PROC_RUNNABLE_M:
132                         if (!(state & (PROC_RUNNING_M | PROC_DYING)))
133                                 panic("Invalid State Transition! PROC_RUNNABLE_M to %02x", state);
134                         break;
135                 case PROC_RUNNING_M:
136                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
137                                        PROC_DYING)))
138                                 panic("Invalid State Transition! PROC_RUNNING_M to %02x", state);
139                         break;
140         }
141         #endif
142         p->state = state;
143         return 0;
144 }
145
146 /* Returns a pointer to the proc with the given pid, or 0 if there is none.
147  * This uses get_not_zero, since it is possible the refcnt is 0, which means the
148  * process is dying and we should not have the ref (and thus return 0).  We need
149  * to lock to protect us from getting p, (someone else removes and frees p),
150  * then get_not_zero() on p.
151  * Don't push the locking into the hashtable without dealing with this. */
152 struct proc *pid2proc(pid_t pid)
153 {
154         spin_lock(&pid_hash_lock);
155         struct proc *p = hashtable_search(pid_hash, (void*)(long)pid);
156         if (p)
157                 if (!kref_get_not_zero(&p->p_kref, 1))
158                         p = 0;
159         spin_unlock(&pid_hash_lock);
160         return p;
161 }
162
163 /* Performs any initialization related to processes, such as create the proc
164  * cache, prep the scheduler, etc.  When this returns, we should be ready to use
165  * any process related function. */
166 void proc_init(void)
167 {
168         /* Catch issues with the vcoremap and TAILQ_ENTRY sizes */
169         static_assert(sizeof(TAILQ_ENTRY(vcore)) == sizeof(void*) * 2);
170         proc_cache = kmem_cache_create("proc", sizeof(struct proc),
171                      MAX(HW_CACHE_ALIGN, __alignof__(struct proc)), 0, 0, 0);
172         /* Init PID mask and hash.  pid 0 is reserved. */
173         SET_BITMASK_BIT(pid_bmask, 0);
174         spinlock_init(&pid_hash_lock);
175         spin_lock(&pid_hash_lock);
176         pid_hash = create_hashtable(100, __generic_hash, __generic_eq);
177         spin_unlock(&pid_hash_lock);
178         schedule_init();
179
180         atomic_init(&num_envs, 0);
181 }
182
183 /* Be sure you init'd the vcore lists before calling this. */
184 static void proc_init_procinfo(struct proc* p)
185 {
186         p->procinfo->pid = p->pid;
187         p->procinfo->ppid = p->ppid;
188         p->procinfo->max_vcores = max_vcores(p);
189         p->procinfo->tsc_freq = system_timing.tsc_freq;
190         p->procinfo->heap_bottom = (void*)UTEXT;
191         /* 0'ing the arguments.  Some higher function will need to set them */
192         memset(p->procinfo->argp, 0, sizeof(p->procinfo->argp));
193         memset(p->procinfo->argbuf, 0, sizeof(p->procinfo->argbuf));
194         memset(p->procinfo->res_grant, 0, sizeof(p->procinfo->res_grant));
195         /* 0'ing the vcore/pcore map.  Will link the vcores later. */
196         memset(&p->procinfo->vcoremap, 0, sizeof(p->procinfo->vcoremap));
197         memset(&p->procinfo->pcoremap, 0, sizeof(p->procinfo->pcoremap));
198         p->procinfo->num_vcores = 0;
199         p->procinfo->is_mcp = FALSE;
200         p->procinfo->coremap_seqctr = SEQCTR_INITIALIZER;
201         /* For now, we'll go up to the max num_cpus (at runtime).  In the future,
202          * there may be cases where we can have more vcores than num_cpus, but for
203          * now we'll leave it like this. */
204         for (int i = 0; i < num_cpus; i++) {
205                 TAILQ_INSERT_TAIL(&p->inactive_vcs, &p->procinfo->vcoremap[i], list);
206         }
207 }
208
209 static void proc_init_procdata(struct proc *p)
210 {
211         memset(p->procdata, 0, sizeof(struct procdata));
212 }
213
214 /* Allocates and initializes a process, with the given parent.  Currently
215  * writes the *p into **pp, and returns 0 on success, < 0 for an error.
216  * Errors include:
217  *  - ENOFREEPID if it can't get a PID
218  *  - ENOMEM on memory exhaustion */
219 error_t proc_alloc(struct proc **pp, struct proc *parent)
220 {
221         error_t r;
222         struct proc *p;
223
224         if (!(p = kmem_cache_alloc(proc_cache, 0)))
225                 return -ENOMEM;
226
227         { INITSTRUCT(*p)
228
229         /* one reference for the proc existing, and one for the ref we pass back. */
230         kref_init(&p->p_kref, __proc_free, 2);
231         // Setup the default map of where to get cache colors from
232         p->cache_colors_map = global_cache_colors_map;
233         p->next_cache_color = 0;
234         /* Initialize the address space */
235         if ((r = env_setup_vm(p)) < 0) {
236                 kmem_cache_free(proc_cache, p);
237                 return r;
238         }
239         if (!(p->pid = get_free_pid())) {
240                 kmem_cache_free(proc_cache, p);
241                 return -ENOFREEPID;
242         }
243         /* Set the basic status variables. */
244         spinlock_init(&p->proc_lock);
245         p->exitcode = 1337;     /* so we can see processes killed by the kernel */
246         p->ppid = parent ? parent->pid : 0;
247         p->state = PROC_CREATED; /* shouldn't go through state machine for init */
248         p->env_flags = 0;
249         p->env_entry = 0; // cheating.  this really gets set later
250         p->heap_top = (void*)UTEXT;     /* heap_bottom set in proc_init_procinfo */
251         memset(&p->env_ancillary_state, 0, sizeof(p->env_ancillary_state));
252         memset(&p->env_tf, 0, sizeof(p->env_tf));
253         spinlock_init(&p->mm_lock);
254         TAILQ_INIT(&p->vm_regions); /* could init this in the slab */
255         /* Initialize the vcore lists, we'll build the inactive list so that it includes
256          * all vcores when we initialize procinfo.  Do this before initing procinfo. */
257         TAILQ_INIT(&p->online_vcs);
258         TAILQ_INIT(&p->bulk_preempted_vcs);
259         TAILQ_INIT(&p->inactive_vcs);
260         /* Init procinfo/procdata.  Procinfo's argp/argb are 0'd */
261         proc_init_procinfo(p);
262         proc_init_procdata(p);
263
264         /* Initialize the generic sysevent ring buffer */
265         SHARED_RING_INIT(&p->procdata->syseventring);
266         /* Initialize the frontend of the sysevent ring buffer */
267         FRONT_RING_INIT(&p->syseventfrontring,
268                         &p->procdata->syseventring,
269                         SYSEVENTRINGSIZE);
270
271         /* Init FS structures TODO: cleanup (might pull this out) */
272         kref_get(&default_ns.kref, 1);
273         p->ns = &default_ns;
274         spinlock_init(&p->fs_env.lock);
275         p->fs_env.umask = parent ? parent->fs_env.umask : S_IWGRP | S_IWOTH;
276         p->fs_env.root = p->ns->root->mnt_root;
277         kref_get(&p->fs_env.root->d_kref, 1);
278         p->fs_env.pwd = parent ? parent->fs_env.pwd : p->fs_env.root;
279         kref_get(&p->fs_env.pwd->d_kref, 1);
280         memset(&p->open_files, 0, sizeof(p->open_files));       /* slightly ghetto */
281         spinlock_init(&p->open_files.lock);
282         p->open_files.max_files = NR_OPEN_FILES_DEFAULT;
283         p->open_files.max_fdset = NR_FILE_DESC_DEFAULT;
284         p->open_files.fd = p->open_files.fd_array;
285         p->open_files.open_fds = (struct fd_set*)&p->open_files.open_fds_init;
286         /* Init the ucq hash lock */
287         p->ucq_hashlock = (struct hashlock*)&p->ucq_hl_noref;
288         hashlock_init(p->ucq_hashlock, HASHLOCK_DEFAULT_SZ);
289
290         atomic_inc(&num_envs);
291         frontend_proc_init(p);
292         printd("[%08x] new process %08x\n", current ? current->pid : 0, p->pid);
293         } // INIT_STRUCT
294         *pp = p;
295         return 0;
296 }
297
298 /* We have a bunch of different ways to make processes.  Call this once the
299  * process is ready to be used by the rest of the system.  For now, this just
300  * means when it is ready to be named via the pidhash.  In the future, we might
301  * push setting the state to CREATED into here. */
302 void __proc_ready(struct proc *p)
303 {
304         spin_lock(&pid_hash_lock);
305         hashtable_insert(pid_hash, (void*)(long)p->pid, p);
306         spin_unlock(&pid_hash_lock);
307 }
308
309 /* Creates a process from the specified file, argvs, and envps.  Tempted to get
310  * rid of proc_alloc's style, but it is so quaint... */
311 struct proc *proc_create(struct file *prog, char **argv, char **envp)
312 {
313         struct proc *p;
314         error_t r;
315         if ((r = proc_alloc(&p, current)) < 0)
316                 panic("proc_create: %e", r);    /* one of 3 quaint usages of %e */
317         procinfo_pack_args(p->procinfo, argv, envp);
318         assert(load_elf(p, prog) == 0);
319         /* Connect to stdin, stdout, stderr */
320         assert(insert_file(&p->open_files, dev_stdin,  0) == 0);
321         assert(insert_file(&p->open_files, dev_stdout, 0) == 1);
322         assert(insert_file(&p->open_files, dev_stderr, 0) == 2);
323         __proc_ready(p);
324         return p;
325 }
326
327 /* This is called by kref_put(), once the last reference to the process is
328  * gone.  Don't call this otherwise (it will panic).  It will clean up the
329  * address space and deallocate any other used memory. */
330 static void __proc_free(struct kref *kref)
331 {
332         struct proc *p = container_of(kref, struct proc, p_kref);
333         physaddr_t pa;
334
335         printd("[PID %d] freeing proc: %d\n", current ? current->pid : 0, p->pid);
336         // All parts of the kernel should have decref'd before __proc_free is called
337         assert(kref_refcnt(&p->p_kref) == 0);
338
339         kref_put(&p->fs_env.root->d_kref);
340         kref_put(&p->fs_env.pwd->d_kref);
341         destroy_vmrs(p);
342         frontend_proc_free(p);  /* TODO: please remove me one day */
343         /* Free any colors allocated to this process */
344         if (p->cache_colors_map != global_cache_colors_map) {
345                 for(int i = 0; i < llc_cache->num_colors; i++)
346                         cache_color_free(llc_cache, p->cache_colors_map);
347                 cache_colors_map_free(p->cache_colors_map);
348         }
349         /* Remove us from the pid_hash and give our PID back (in that order). */
350         spin_lock(&pid_hash_lock);
351         if (!hashtable_remove(pid_hash, (void*)(long)p->pid))
352                 panic("Proc not in the pid table in %s", __FUNCTION__);
353         spin_unlock(&pid_hash_lock);
354         put_free_pid(p->pid);
355         /* Flush all mapped pages in the user portion of the address space */
356         env_user_mem_free(p, 0, UVPT);
357         /* These need to be free again, since they were allocated with a refcnt. */
358         free_cont_pages(p->procinfo, LOG2_UP(PROCINFO_NUM_PAGES));
359         free_cont_pages(p->procdata, LOG2_UP(PROCDATA_NUM_PAGES));
360
361         env_pagetable_free(p);
362         p->env_pgdir = 0;
363         p->env_cr3 = 0;
364
365         atomic_dec(&num_envs);
366
367         /* Dealloc the struct proc */
368         kmem_cache_free(proc_cache, p);
369 }
370
371 /* Whether or not actor can control target.  Note we currently don't need
372  * locking for this. TODO: think about that, esp wrt proc's dying. */
373 bool proc_controls(struct proc *actor, struct proc *target)
374 {
375         return ((actor == target) || (target->ppid == actor->pid));
376 }
377
378 /* Helper to incref by val.  Using the helper to help debug/interpose on proc
379  * ref counting.  Note that pid2proc doesn't use this interface. */
380 void proc_incref(struct proc *p, unsigned int val)
381 {
382         kref_get(&p->p_kref, val);
383 }
384
385 /* Helper to decref for debugging.  Don't directly kref_put() for now. */
386 void proc_decref(struct proc *p)
387 {
388         kref_put(&p->p_kref);
389 }
390
391 /* Helper, makes p the 'current' process, dropping the old current/cr3.  This no
392  * longer assumes the passed in reference already counted 'current'.  It will
393  * incref internally when needed. */
394 static void __set_proc_current(struct proc *p)
395 {
396         /* We use the pcpui to access 'current' to cut down on the core_id() calls,
397          * though who know how expensive/painful they are. */
398         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
399         /* If the process wasn't here, then we need to load its address space. */
400         if (p != pcpui->cur_proc) {
401                 proc_incref(p, 1);
402                 lcr3(p->env_cr3);
403                 /* This is "leaving the process context" of the previous proc.  The
404                  * previous lcr3 unloaded the previous proc's context.  This should
405                  * rarely happen, since we usually proactively leave process context,
406                  * but this is the fallback. */
407                 if (pcpui->cur_proc)
408                         proc_decref(pcpui->cur_proc);
409                 pcpui->cur_proc = p;
410         }
411 }
412
413 /* Dispatches a _S process to run on the current core.  This should never be
414  * called to "restart" a core.   
415  *
416  * This will always return, regardless of whether or not the calling core is
417  * being given to a process. (it used to pop the tf directly, before we had
418  * cur_tf).
419  *
420  * Since it always returns, it will never "eat" your reference (old
421  * documentation talks about this a bit). */
422 void proc_run_s(struct proc *p)
423 {
424         spin_lock(&p->proc_lock);
425         switch (p->state) {
426                 case (PROC_DYING):
427                         spin_unlock(&p->proc_lock);
428                         printk("Process %d not starting due to async death\n", p->pid);
429                         return;
430                 case (PROC_RUNNABLE_S):
431                         assert(current != p);
432                         __proc_set_state(p, PROC_RUNNING_S);
433                         /* We will want to know where this process is running, even if it is
434                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
435                          * Also, this is the signal used in trap.c to know to save the tf in
436                          * env_tf. */
437                         __seq_start_write(&p->procinfo->coremap_seqctr);
438                         p->procinfo->num_vcores = 0;    /* TODO (VC#) */
439                         /* TODO: For now, we won't count this as an active vcore (on the
440                          * lists).  This gets unmapped in resource.c and yield_s, and needs
441                          * work. */
442                         __map_vcore(p, 0, core_id()); // sort of.  this needs work.
443                         __seq_end_write(&p->procinfo->coremap_seqctr);
444                         /* incref, since we're saving a reference in owning proc */
445                         proc_incref(p, 1);
446                         /* redundant with proc_startcore, might be able to remove that one*/
447                         __set_proc_current(p);
448                         /* We restartcore, instead of startcore, since startcore is a bit
449                          * lower level and we want a chance to process kmsgs before starting
450                          * the process. */
451                         spin_unlock(&p->proc_lock);
452                         disable_irq();          /* before mucking with cur_tf / owning_proc */
453                         /* this is one of the few times cur_tf != &actual_tf */
454                         current_tf = &p->env_tf;        /* no need for irq disable yet */
455                         /* storing the passed in ref of p in owning_proc */
456                         per_cpu_info[core_id()].owning_proc = p;
457                         /* When the calling core idles, it'll call restartcore and run the
458                          * _S process's context. */
459                         return;
460                 default:
461                         spin_unlock(&p->proc_lock);
462                         panic("Invalid process state %p in %s()!!", p->state, __FUNCTION__);
463         }
464 }
465
466 /* Helper: sends preempt messages to all vcores on the bulk preempt list, and
467  * moves them to the inactive list. */
468 static void __send_bulkp_events(struct proc *p)
469 {
470         struct vcore *vc_i, *vc_temp;
471         struct event_msg preempt_msg = {0};
472         /* Send preempt messages for any left on the BP list.  No need to set any
473          * flags, it all was done on the real preempt.  Now we're just telling the
474          * process about any that didn't get restarted and are still preempted. */
475         TAILQ_FOREACH_SAFE(vc_i, &p->bulk_preempted_vcs, list, vc_temp) {
476                 /* Note that if there are no active vcores, send_k_e will post to our
477                  * own vcore, the last of which will be put on the inactive list and be
478                  * the first to be started.  We could have issues with deadlocking,
479                  * since send_k_e() could grab the proclock (if there are no active
480                  * vcores) */
481                 preempt_msg.ev_type = EV_VCORE_PREEMPT;
482                 preempt_msg.ev_arg2 = vcore2vcoreid(p, vc_i);   /* arg2 is 32 bits */
483                 send_kernel_event(p, &preempt_msg, 0);
484                 /* TODO: we may want a TAILQ_CONCAT_HEAD, or something that does that.
485                  * We need a loop for the messages, but not necessarily for the list
486                  * changes.  */
487                 TAILQ_REMOVE(&p->bulk_preempted_vcs, vc_i, list);
488                 TAILQ_INSERT_HEAD(&p->inactive_vcs, vc_i, list);
489         }
490 }
491
492 /* Run an _M.  Can be called safely on one that is already running.  Hold the
493  * lock before calling.  Other than state checks, this just starts up the _M's
494  * vcores, much like the second part of give_cores_running.  More specifically,
495  * give_cores_runnable puts cores on the online list, which this then sends
496  * messages to.  give_cores_running immediately puts them on the list and sends
497  * the message.  the two-step style may go out of fashion soon.
498  *
499  * This expects that the "instructions" for which core(s) to run this on will be
500  * in the vcoremap, which needs to be set externally (give_cores()). */
501 void __proc_run_m(struct proc *p)
502 {
503         struct vcore *vc_i;
504         switch (p->state) {
505                 case (PROC_DYING):
506                         printk("Process %d not starting due to async death\n", p->pid);
507                         return;
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                                 __send_bulkp_events(p);
514                                 __proc_set_state(p, PROC_RUNNING_M);
515                                 /* Up the refcnt, to avoid the n refcnt upping on the
516                                  * destination cores.  Keep in sync with __startcore */
517                                 proc_incref(p, p->procinfo->num_vcores * 2);
518                                 /* Send kernel messages to all online vcores (which were added
519                                  * to the list and mapped in __proc_give_cores()), making them
520                                  * turn online */
521                                 TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
522                                         send_kernel_message(vc_i->pcoreid, __startcore, (long)p,
523                                                             0, 0, KMSG_IMMEDIATE);
524                                 }
525                         } else {
526                                 warn("Tried to proc_run() an _M with no vcores!");
527                         }
528                         /* There a subtle race avoidance here (when we unlock after sending
529                          * the message).  __proc_startcore can handle a death message, but
530                          * we can't have the startcore come after the death message.
531                          * Otherwise, it would look like a new process.  So we hold the lock
532                          * til after we send our message, which prevents a possible death
533                          * message.
534                          * - Note there is no guarantee this core's interrupts were on, so
535                          *   it may not get the message for a while... */
536                         return;
537                 case (PROC_RUNNING_M):
538                 case (PROC_WAITING):
539                         return;
540                 default:
541                         /* unlock just so the monitor can call something that might lock*/
542                         spin_unlock(&p->proc_lock);
543                         panic("Invalid process state %p in %s()!!", p->state, __FUNCTION__);
544         }
545 }
546
547 /* Actually runs the given context (trapframe) of process p on the core this
548  * code executes on.  This is called directly by __startcore, which needs to
549  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
550  *
551  * A note on refcnting: this function will not return, and your proc reference
552  * will end up stored in current.  This will make no changes to p's refcnt, so
553  * do your accounting such that there is only the +1 for current.  This means if
554  * it is already in current (like in the trap return path), don't up it.  If
555  * it's already in current and you have another reference (like pid2proc or from
556  * an IPI), then down it (which is what happens in __startcore()).  If it's not
557  * in current and you have one reference, like proc_run(non_current_p), then
558  * also do nothing.  The refcnt for your *p will count for the reference stored
559  * in current. */
560 static void __proc_startcore(struct proc *p, trapframe_t *tf)
561 {
562         assert(!irq_is_enabled());
563         __set_proc_current(p);
564         /* need to load our silly state, preferably somewhere other than here so we
565          * can avoid the case where the context was just running here.  it's not
566          * sufficient to do it in the "new process" if-block above (could be things
567          * like page faults that cause us to keep the same process, but want a
568          * different context.
569          * for now, we load this silly state here. (TODO) (HSS)
570          * We also need this to be per trapframe, and not per process...
571          * For now / OSDI, only load it when in _S mode.  _M mode was handled in
572          * __startcore.  */
573         if (p->state == PROC_RUNNING_S)
574                 env_pop_ancillary_state(p);
575         /* Clear the current_tf, since it is no longer used */
576         current_tf = 0; /* TODO: might not need this... */
577         env_pop_tf(tf);
578 }
579
580 /* Restarts/runs the current_tf, which must be for the current process, on the
581  * core this code executes on.  Calls an internal function to do the work.
582  *
583  * In case there are pending routine messages, like __death, __preempt, or
584  * __notify, we need to run them.  Alternatively, if there are any, we could
585  * self_ipi, and run the messages immediately after popping back to userspace,
586  * but that would have crappy overhead.
587  *
588  * Refcnting: this will not return, and it assumes that you've accounted for
589  * your reference as if it was the ref for "current" (which is what happens when
590  * returning from local traps and such. */
591 void proc_restartcore(void)
592 {
593         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
594         assert(!pcpui->cur_sysc);
595         /* Try and get any interrupts before we pop back to userspace.  If we didn't
596          * do this, we'd just get them in userspace, but this might save us some
597          * effort/overhead. */
598         enable_irq();
599         /* Need ints disabled when we return from processing (race on missing
600          * messages/IPIs) */
601         disable_irq();
602         process_routine_kmsg(pcpui->cur_tf);
603         /* If there is no owning process, just idle, since we don't know what to do.
604          * This could be because the process had been restarted a long time ago and
605          * has since left the core, or due to a KMSG like __preempt or __death. */
606         if (!pcpui->owning_proc) {
607                 abandon_core();
608                 smp_idle();
609         }
610         assert(pcpui->cur_tf);
611         __proc_startcore(pcpui->owning_proc, pcpui->cur_tf);
612 }
613
614 /*
615  * Destroys the given process.  This may be called from another process, a light
616  * kernel thread (no real process context), asynchronously/cross-core, or from
617  * the process on its own core.
618  *
619  * Here's the way process death works:
620  * 0. grab the lock (protects state transition and core map)
621  * 1. set state to dying.  that keeps the kernel from doing anything for the
622  * process (like proc_running it).
623  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
624  * 3. IPI to clean up those cores (decref, etc).
625  * 4. Unlock
626  * 5. Clean up your core, if applicable
627  * (Last core/kernel thread to decref cleans up and deallocates resources.)
628  *
629  * Note that some cores can be processing async calls, but will eventually
630  * decref.  Should think about this more, like some sort of callback/revocation.
631  *
632  * This function will now always return (it used to not return if the calling
633  * core was dying).  However, when it returns, a kernel message will eventually
634  * come in, making you abandon_core, as if you weren't running.  It may be that
635  * the only reference to p is the one you passed in, and when you decref, it'll
636  * get __proc_free()d. */
637 void proc_destroy(struct proc *p)
638 {
639         uint32_t num_revoked = 0;
640         spin_lock(&p->proc_lock);
641         /* storage for pc_arr is alloced at decl, which is after grabbing the lock*/
642         uint32_t pc_arr[p->procinfo->num_vcores];
643         switch (p->state) {
644                 case PROC_DYING: // someone else killed this already.
645                         spin_unlock(&p->proc_lock);
646                         return;
647                 case PROC_RUNNABLE_M:
648                         /* Need to reclaim any cores this proc might have, even though it's
649                          * not running yet. */
650                         num_revoked = __proc_take_allcores(p, pc_arr, FALSE);
651                         // fallthrough
652                 case PROC_RUNNABLE_S:
653                         /* might need to pull from lists, though i'm currently a fan of the
654                          * model where external refs notice DYING (if it matters to them)
655                          * and decref when they are done.  the ksched will notice the proc
656                          * is dying and handle it accordingly (which delay the reaping til
657                          * the next call to schedule()) */
658                         break;
659                 case PROC_RUNNING_S:
660                         #if 0
661                         // here's how to do it manually
662                         if (current == p) {
663                                 lcr3(boot_cr3);
664                                 proc_decref(p);         /* this decref is for the cr3 */
665                                 current = NULL;
666                         }
667                         #endif
668                         send_kernel_message(get_pcoreid(p, 0), __death, 0, 0, 0,
669                                             KMSG_IMMEDIATE);
670                         __seq_start_write(&p->procinfo->coremap_seqctr);
671                         // TODO: might need to sort num_vcores too later (VC#)
672                         /* vcore is unmapped on the receive side */
673                         __seq_end_write(&p->procinfo->coremap_seqctr);
674                         /* If we ever have RUNNING_S run on non-mgmt cores, we'll need to
675                          * tell the ksched about this now-idle core (after unlocking) */
676                         break;
677                 case PROC_RUNNING_M:
678                         /* Send the DEATH message to every core running this process, and
679                          * deallocate the cores.
680                          * The rule is that the vcoremap is set before proc_run, and reset
681                          * within proc_destroy */
682                         num_revoked = __proc_take_allcores(p, pc_arr, FALSE);
683                         break;
684                 case PROC_CREATED:
685                         break;
686                 default:
687                         panic("Weird state(%s) in %s()", procstate2str(p->state),
688                               __FUNCTION__);
689         }
690         __proc_set_state(p, PROC_DYING);
691         /* This prevents processes from accessing their old files while dying, and
692          * will help if these files (or similar objects in the future) hold
693          * references to p (preventing a __proc_free()). */
694         close_all_files(&p->open_files, FALSE);
695         /* This decref is for the process's existence. */
696         proc_decref(p);
697         /* Unlock.  A death IPI should be on its way, either from the RUNNING_S one,
698          * or from proc_take_cores with a __death.  in general, interrupts should be
699          * on when you call proc_destroy locally, but currently aren't for all
700          * things (like traphandlers). */
701         spin_unlock(&p->proc_lock);
702         /* Return the cores to the ksched */
703         if (num_revoked)
704                 put_idle_cores(pc_arr, num_revoked);
705         return;
706 }
707
708 /* Turns *p into an MCP.  Needs to be called from a local syscall of a RUNNING_S
709  * process.  Currently, this ignores whether or not you are an _M already.  You
710  * should hold the lock before calling. */
711 void __proc_change_to_m(struct proc *p)
712 {
713         int8_t state = 0;
714         switch (p->state) {
715                 case (PROC_RUNNING_S):
716                         /* issue with if we're async or not (need to preempt it)
717                          * either of these should trip it. TODO: (ACR) async core req
718                          * TODO: relies on vcore0 being the caller (VC#) */
719                         if ((current != p) || (get_pcoreid(p, 0) != core_id()))
720                                 panic("We don't handle async RUNNING_S core requests yet.");
721                         /* save the tf so userspace can restart it.  Like in __notify,
722                          * this assumes a user tf is the same as a kernel tf.  We save
723                          * it in the preempt slot so that we can also save the silly
724                          * state. */
725                         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
726                         disable_irqsave(&state);        /* protect cur_tf */
727                         /* Note this won't play well with concurrent proc kmsgs, but
728                          * since we're _S and locked, we shouldn't have any. */
729                         assert(current_tf);
730                         /* Copy uthread0's context to the notif slot */
731                         vcpd->notif_tf = *current_tf;
732                         clear_owning_proc(core_id());   /* so we don't restart */
733                         save_fp_state(&vcpd->preempt_anc);
734                         enable_irqsave(&state);
735                         /* Userspace needs to not fuck with notif_disabled before
736                          * transitioning to _M. */
737                         if (vcpd->notif_disabled) {
738                                 printk("[kernel] user bug: notifs disabled for vcore 0\n");
739                                 vcpd->notif_disabled = FALSE;
740                         }
741                         /* in the async case, we'll need to remotely stop and bundle
742                          * vcore0's TF.  this is already done for the sync case (local
743                          * syscall). */
744                         /* this process no longer runs on its old location (which is
745                          * this core, for now, since we don't handle async calls) */
746                         __seq_start_write(&p->procinfo->coremap_seqctr);
747                         // TODO: (VC#) might need to adjust num_vcores
748                         // TODO: (ACR) will need to unmap remotely (receive-side)
749                         __unmap_vcore(p, 0);    /* VC# keep in sync with proc_run_s */
750                         __seq_end_write(&p->procinfo->coremap_seqctr);
751                         /* change to runnable_m (it's TF is already saved) */
752                         __proc_set_state(p, PROC_RUNNABLE_M);
753                         p->procinfo->is_mcp = TRUE;
754                         break;
755                 case (PROC_RUNNABLE_S):
756                         /* Issues: being on the runnable_list, proc_set_state not liking
757                          * it, and not clearly thinking through how this would happen.
758                          * Perhaps an async call that gets serviced after you're
759                          * descheduled? */
760                         panic("Not supporting RUNNABLE_S -> RUNNABLE_M yet.\n");
761                         break;
762                 case (PROC_DYING):
763                         warn("Dying, core request coming from %d\n", core_id());
764                 default:
765                         break;
766         }
767 }
768
769 /* Old code to turn a RUNNING_M to a RUNNING_S, with the calling context
770  * becoming the new 'thread0'.  Don't use this.  Caller needs to send in a
771  * pc_arr big enough for all vcores.  Will return the number of cores given up
772  * by the proc. */
773 uint32_t __proc_change_to_s(struct proc *p, uint32_t *pc_arr)
774 {
775         int8_t state = 0;
776         uint32_t num_revoked;
777         printk("[kernel] trying to transition _M -> _S (deprecated)!\n");
778         assert(p->state == PROC_RUNNING_M); // TODO: (ACR) async core req
779         /* save the context, to be restarted in _S mode */
780         disable_irqsave(&state);        /* protect cur_tf */
781         assert(current_tf);
782         p->env_tf = *current_tf;
783         clear_owning_proc(core_id());   /* so we don't restart */
784         enable_irqsave(&state);
785         env_push_ancillary_state(p); // TODO: (HSS)
786         /* sending death, since it's not our job to save contexts or anything in
787          * this case. */
788         num_revoked = __proc_take_allcores(p, pc_arr, FALSE);
789         __proc_set_state(p, PROC_RUNNABLE_S);
790         return num_revoked;
791 }
792
793 /* Helper function.  Is the given pcore a mapped vcore?  No locking involved, be
794  * careful. */
795 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
796 {
797         return p->procinfo->pcoremap[pcoreid].valid;
798 }
799
800 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
801  * No locking involved, be careful.  Panics on failure. */
802 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid)
803 {
804         assert(is_mapped_vcore(p, pcoreid));
805         return p->procinfo->pcoremap[pcoreid].vcoreid;
806 }
807
808 /* Helper function.  Try to find the pcoreid for a given virtual core id for
809  * proc p.  No locking involved, be careful.  Use this when you can tolerate a
810  * stale or otherwise 'wrong' answer. */
811 static uint32_t try_get_pcoreid(struct proc *p, uint32_t vcoreid)
812 {
813         return p->procinfo->vcoremap[vcoreid].pcoreid;
814 }
815
816 /* Helper function.  Find the pcoreid for a given virtual core id for proc p.
817  * No locking involved, be careful.  Panics on failure. */
818 static uint32_t get_pcoreid(struct proc *p, uint32_t vcoreid)
819 {
820         assert(vcore_is_mapped(p, vcoreid));
821         return try_get_pcoreid(p, vcoreid);
822 }
823
824 /* Helper function: yields / wraps up current_tf and schedules the _S */
825 void __proc_yield_s(struct proc *p, struct trapframe *tf)
826 {
827         assert(p->state == PROC_RUNNING_S);
828         p->env_tf= *tf;
829         env_push_ancillary_state(p);                    /* TODO: (HSS) */
830         __unmap_vcore(p, 0);    /* VC# keep in sync with proc_run_s */
831         __proc_set_state(p, PROC_RUNNABLE_S);
832         schedule_scp(p);
833 }
834
835 /* Yields the calling core.  Must be called locally (not async) for now.
836  * - If RUNNING_S, you just give up your time slice and will eventually return.
837  * - If RUNNING_M, you give up the current vcore (which never returns), and
838  *   adjust the amount of cores wanted/granted.
839  * - If you have only one vcore, you switch to RUNNABLE_M.  When you run again,
840  *   you'll have one guaranteed core, starting from the entry point.
841  *
842  * If the call is being nice, it means that it is in response to a preemption
843  * (which needs to be checked).  If there is no preemption pending, just return.
844  * No matter what, don't adjust the number of cores wanted.
845  *
846  * This usually does not return (smp_idle()), so it will eat your reference.
847  * Also note that it needs a non-current/edible reference, since it will abandon
848  * and continue to use the *p (current == 0, no cr3, etc).
849  *
850  * We disable interrupts for most of it too, since we need to protect current_tf
851  * and not race with __notify (which doesn't play well with concurrent
852  * yielders). */
853 void proc_yield(struct proc *SAFE p, bool being_nice)
854 {
855         uint32_t vcoreid, pcoreid = core_id();
856         struct vcore *vc;
857         struct preempt_data *vcpd;
858         int8_t state = 0;
859         /* Need to disable before even reading vcoreid, since we could be unmapped
860          * by a __preempt or __death.  _S also needs ints disabled, so we'll just do
861          * it immediately. */
862         disable_irqsave(&state);
863         /* Need to lock before checking the vcoremap to find out who we are, in case
864          * we're getting __preempted and __startcored, from a remote core (in which
865          * case we might have come in thinking we were vcore X, but had X preempted
866          * and Y restarted on this pcore, and we suddenly are the wrong vcore
867          * yielding).  Arguably, this is incredibly rare, since you'd need to
868          * preempt the core, then decide to give it back with another grant in
869          * between. */
870         spin_lock(&p->proc_lock); /* horrible scalability.  =( */
871         switch (p->state) {
872                 case (PROC_RUNNING_S):
873                         __proc_yield_s(p, current_tf);  /* current_tf 0'd in abandon core */
874                         goto out_yield_core;
875                 case (PROC_RUNNING_M):
876                         break;                          /* will handle this stuff below */
877                 case (PROC_DYING):              /* incoming __death */
878                 case (PROC_RUNNABLE_M): /* incoming (bulk) preempt/myield TODO:(BULK) */
879                         goto out_failed;
880                 default:
881                         panic("Weird state(%s) in %s()", procstate2str(p->state),
882                               __FUNCTION__);
883         }
884         /* If we're already unmapped (__preempt or a __death hit us), bail out.
885          * Note that if a __death hit us, we should have bailed when we saw
886          * PROC_DYING. */
887         if (!is_mapped_vcore(p, pcoreid))
888                 goto out_failed;
889         vcoreid = get_vcoreid(p, pcoreid);
890         vc = vcoreid2vcore(p, vcoreid);
891         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
892         /* no reason to be nice, return */
893         if (being_nice && !vc->preempt_pending)
894                 goto out_failed;
895         /* Fate is sealed, return and take the preempt message when we enable_irqs.
896          * Note this keeps us from mucking with our lists, since we were already
897          * removed from the online_list.  We have a similar concern with __death,
898          * but we check for DYING to handle that. */
899         if (vc->preempt_served)
900                 goto out_failed;
901         /* At this point, AFAIK there should be no preempt/death messages on the
902          * way, and we're on the online list.  So we'll go ahead and do the yielding
903          * business. */
904         /* no need to preempt later, since we are yielding (nice or otherwise) */
905         if (vc->preempt_pending)
906                 vc->preempt_pending = 0;
907         /* Don't let them yield if they are missing a notification.  Userspace must
908          * not leave vcore context without dealing with notif_pending.  pop_ros_tf()
909          * handles leaving via uthread context.  This handles leaving via a yield.
910          *
911          * This early check is an optimization.  The real check is below when it
912          * works with the online_vcs list (syncing with event.c and INDIR/IPI
913          * posting). */
914         if (vcpd->notif_pending)
915                 goto out_failed;
916         /* Now we'll actually try to yield */
917         printd("[K] Process %d (%p) is yielding on vcore %d\n", p->pid, p,
918                get_vcoreid(p, coreid));
919         /* Remove from the online list, add to the yielded list, and unmap
920          * the vcore, which gives up the core. */
921         TAILQ_REMOVE(&p->online_vcs, vc, list);
922         /* Now that we're off the online list, check to see if an alert made
923          * it through (event.c sets this) */
924         wrmb(); /* prev write must hit before reading notif_pending */
925         /* Note we need interrupts disabled, since a __notify can come in
926          * and set pending to FALSE */
927         if (vcpd->notif_pending) {
928                 /* We lost, put it back on the list and abort the yield */
929                 TAILQ_INSERT_TAIL(&p->online_vcs, vc, list); /* could go HEAD */
930                 goto out_failed;
931         }
932         /* We won the race with event sending, we can safely yield */
933         TAILQ_INSERT_HEAD(&p->inactive_vcs, vc, list);
934         /* Note this protects stuff userspace should look at, which doesn't
935          * include the TAILQs. */
936         __seq_start_write(&p->procinfo->coremap_seqctr);
937         /* Next time the vcore starts, it starts fresh */
938         vcpd->notif_disabled = FALSE;
939         __unmap_vcore(p, vcoreid);
940         p->procinfo->num_vcores--;
941         p->procinfo->res_grant[RES_CORES] = p->procinfo->num_vcores;
942         __seq_end_write(&p->procinfo->coremap_seqctr);
943         /* Hand the now-idle core to the ksched */
944         put_idle_core(pcoreid);
945         /* No more vcores?  Then we wait on an event */
946         if (p->procinfo->num_vcores == 0) {
947                 /* consider a ksched op to tell it about us WAITING */
948                 __proc_set_state(p, PROC_WAITING);
949         }
950         goto out_yield_core;
951 out_failed:
952         /* for some reason we just want to return, either to take a KMSG that cleans
953          * us up, or because we shouldn't yield (ex: notif_pending). */
954         spin_unlock(&p->proc_lock);
955         enable_irqsave(&state);
956         return;
957 out_yield_core:                 /* successfully yielded the core */
958         spin_unlock(&p->proc_lock);
959         proc_decref(p);                 /* need to eat the ref passed in */
960         /* Clean up the core and idle.  Need to do this before enabling interrupts,
961          * since once we put_idle_core() and unlock, we could get a startcore. */
962         clear_owning_proc(pcoreid);     /* so we don't restart */
963         abandon_core();
964         smp_idle();                             /* will reenable interrupts */
965 }
966
967 /* Sends a notification (aka active notification, aka IPI) to p's vcore.  We
968  * only send a notification if one they are enabled.  There's a bunch of weird
969  * cases with this, and how pending / enabled are signals between the user and
970  * kernel - check the documentation.  Note that pending is more about messages.
971  * The process needs to be in vcore_context, and the reason is usually a
972  * message.  We set pending here in case we were called to prod them into vcore
973  * context (like via a sys_self_notify. */
974 void proc_notify(struct proc *p, uint32_t vcoreid)
975 {
976         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
977         vcpd->notif_pending = TRUE;
978         wrmb(); /* must write notif_pending before reading notif_disabled */
979         if (!vcpd->notif_disabled) {
980                 /* GIANT WARNING: we aren't using the proc-lock to protect the
981                  * vcoremap.  We want to be able to use this from interrupt context,
982                  * and don't want the proc_lock to be an irqsave.  Spurious
983                  * __notify() kmsgs are okay (it checks to see if the right receiver
984                  * is current). */
985                 if ((p->state & PROC_RUNNING_M) && // TODO: (VC#) (_S state)
986                               vcore_is_mapped(p, vcoreid)) {
987                         printd("[kernel] sending notif to vcore %d\n", vcoreid);
988                         /* This use of try_get_pcoreid is racy, might be unmapped */
989                         send_kernel_message(try_get_pcoreid(p, vcoreid), __notify, (long)p,
990                                             0, 0, KMSG_IMMEDIATE);
991                 }
992         }
993 }
994
995 /* Hold the lock before calling this.  If the process is WAITING, it will wake
996  * it up and schedule it. */
997 void __proc_wakeup(struct proc *p)
998 {
999         if (p->state != PROC_WAITING)
1000                 return;
1001         if (__proc_is_mcp(p)) {
1002                 /* Need to make sure they want at least 1 vcore, so the ksched gives
1003                  * them something.  Might do this via short handler later. */
1004                 if (!p->procdata->res_req[RES_CORES].amt_wanted)
1005                         p->procdata->res_req[RES_CORES].amt_wanted = 1;
1006                 __proc_set_state(p, PROC_RUNNABLE_M);
1007                 /* TODO: consider poke_ksched() here */
1008         } else {
1009                 printk("[kernel] FYI, waking up an _S proc\n");
1010                 __proc_set_state(p, PROC_RUNNABLE_S);
1011                 schedule_scp(p);
1012         }
1013 }
1014
1015 /* Is the process in multi_mode / is an MCP or not?  */
1016 bool __proc_is_mcp(struct proc *p)
1017 {
1018         /* in lieu of using the amount of cores requested, or having a bunch of
1019          * states (like PROC_WAITING_M and _S), I'll just track it with a bool. */
1020         return p->procinfo->is_mcp;
1021 }
1022
1023 /************************  Preemption Functions  ******************************
1024  * Don't rely on these much - I'll be sure to change them up a bit.
1025  *
1026  * Careful about what takes a vcoreid and what takes a pcoreid.  Also, there may
1027  * be weird glitches with setting the state to RUNNABLE_M.  It is somewhat in
1028  * flux.  The num_vcores is changed after take_cores, but some of the messages
1029  * (or local traps) may not yet be ready to handle seeing their future state.
1030  * But they should be, so fix those when they pop up.
1031  *
1032  * Another thing to do would be to make the _core functions take a pcorelist,
1033  * and not just one pcoreid. */
1034
1035 /* Sets a preempt_pending warning for p's vcore, to go off 'when'.  If you care
1036  * about locking, do it before calling.  Takes a vcoreid! */
1037 void __proc_preempt_warn(struct proc *p, uint32_t vcoreid, uint64_t when)
1038 {
1039         struct event_msg local_msg = {0};
1040         /* danger with doing this unlocked: preempt_pending is set, but never 0'd,
1041          * since it is unmapped and not dealt with (TODO)*/
1042         p->procinfo->vcoremap[vcoreid].preempt_pending = when;
1043
1044         /* Send the event (which internally checks to see how they want it) */
1045         local_msg.ev_type = EV_PREEMPT_PENDING;
1046         local_msg.ev_arg1 = vcoreid;
1047         send_kernel_event(p, &local_msg, vcoreid);
1048
1049         /* TODO: consider putting in some lookup place for the alarm to find it.
1050          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1051 }
1052
1053 /* Warns all active vcores of an impending preemption.  Hold the lock if you
1054  * care about the mapping (and you should). */
1055 void __proc_preempt_warnall(struct proc *p, uint64_t when)
1056 {
1057         struct vcore *vc_i;
1058         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1059                 __proc_preempt_warn(p, vcore2vcoreid(p, vc_i), when);
1060         /* TODO: consider putting in some lookup place for the alarm to find it.
1061          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1062 }
1063
1064 // TODO: function to set an alarm, if none is outstanding
1065
1066 /* Raw function to preempt a single core.  If you care about locking, do it
1067  * before calling. */
1068 void __proc_preempt_core(struct proc *p, uint32_t pcoreid)
1069 {
1070         uint32_t vcoreid = get_vcoreid(p, pcoreid);
1071         struct event_msg preempt_msg = {0};
1072         p->procinfo->vcoremap[vcoreid].preempt_served = TRUE;
1073         // expects a pcorelist.  assumes pcore is mapped and running_m
1074         __proc_take_corelist(p, &pcoreid, 1, TRUE);
1075         /* Send a message about the preemption. */
1076         preempt_msg.ev_type = EV_VCORE_PREEMPT;
1077         preempt_msg.ev_arg2 = vcoreid;
1078         send_kernel_event(p, &preempt_msg, 0);
1079 }
1080
1081 /* Raw function to preempt every vcore.  If you care about locking, do it before
1082  * calling. */
1083 uint32_t __proc_preempt_all(struct proc *p, uint32_t *pc_arr)
1084 {
1085         /* instead of doing this, we could just preempt_served all possible vcores,
1086          * and not just the active ones.  We would need to sort out a way to deal
1087          * with stale preempt_serveds first.  This might be just as fast anyways. */
1088         struct vcore *vc_i;
1089         /* TODO:(BULK) PREEMPT - don't bother with this, set a proc wide flag, or
1090          * just make us RUNNABLE_M. */
1091         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1092                 vc_i->preempt_served = TRUE;
1093         return __proc_take_allcores(p, pc_arr, TRUE);
1094 }
1095
1096 /* Warns and preempts a vcore from p.  No delaying / alarming, or anything.  The
1097  * warning will be for u usec from now. */
1098 void proc_preempt_core(struct proc *p, uint32_t pcoreid, uint64_t usec)
1099 {
1100         uint64_t warn_time = read_tsc() + usec2tsc(usec);
1101
1102         /* DYING could be okay */
1103         if (p->state != PROC_RUNNING_M) {
1104                 warn("Tried to preempt from a non RUNNING_M proc!");
1105                 return;
1106         }
1107         spin_lock(&p->proc_lock);
1108         if (is_mapped_vcore(p, pcoreid)) {
1109                 __proc_preempt_warn(p, get_vcoreid(p, pcoreid), warn_time);
1110                 __proc_preempt_core(p, pcoreid);
1111                 put_idle_core(pcoreid);
1112         } else {
1113                 warn("Pcore doesn't belong to the process!!");
1114         }
1115         if (!p->procinfo->num_vcores) {
1116                 __proc_set_state(p, PROC_RUNNABLE_M);
1117         }
1118         spin_unlock(&p->proc_lock);
1119 }
1120
1121 /* Warns and preempts all from p.  No delaying / alarming, or anything.  The
1122  * warning will be for u usec from now. */
1123 void proc_preempt_all(struct proc *p, uint64_t usec)
1124 {
1125         uint64_t warn_time = read_tsc() + usec2tsc(usec);
1126         uint32_t num_revoked = 0;
1127         spin_lock(&p->proc_lock);
1128         /* storage for pc_arr is alloced at decl, which is after grabbing the lock*/
1129         uint32_t pc_arr[p->procinfo->num_vcores];
1130         /* DYING could be okay */
1131         if (p->state != PROC_RUNNING_M) {
1132                 warn("Tried to preempt from a non RUNNING_M proc!");
1133                 spin_unlock(&p->proc_lock);
1134                 return;
1135         }
1136         __proc_preempt_warnall(p, warn_time);
1137         num_revoked = __proc_preempt_all(p, pc_arr);
1138         assert(!p->procinfo->num_vcores);
1139         __proc_set_state(p, PROC_RUNNABLE_M);
1140         spin_unlock(&p->proc_lock);
1141         /* Return the cores to the ksched */
1142         if (num_revoked)
1143                 put_idle_cores(pc_arr, num_revoked);
1144 }
1145
1146 /* Give the specific pcore to proc p.  Lots of assumptions, so don't really use
1147  * this.  The proc needs to be _M and prepared for it.  the pcore needs to be
1148  * free, etc. */
1149 void proc_give(struct proc *p, uint32_t pcoreid)
1150 {
1151         warn("Your idlecoremap is now screwed up");     /* TODO (IDLE) */
1152         spin_lock(&p->proc_lock);
1153         // expects a pcorelist, we give it a list of one
1154         __proc_give_cores(p, &pcoreid, 1);
1155         spin_unlock(&p->proc_lock);
1156 }
1157
1158 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
1159  * out). */
1160 uint32_t proc_get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
1161 {
1162         uint32_t vcoreid;
1163         // TODO: the code currently doesn't track the vcoreid properly for _S (VC#)
1164         spin_lock(&p->proc_lock);
1165         switch (p->state) {
1166                 case PROC_RUNNING_S:
1167                         spin_unlock(&p->proc_lock);
1168                         return 0; // TODO: here's the ugly part
1169                 case PROC_RUNNING_M:
1170                         vcoreid = get_vcoreid(p, pcoreid);
1171                         spin_unlock(&p->proc_lock);
1172                         return vcoreid;
1173                 case PROC_DYING: // death message is on the way
1174                         spin_unlock(&p->proc_lock);
1175                         return 0;
1176                 default:
1177                         spin_unlock(&p->proc_lock);
1178                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1179                               __FUNCTION__);
1180         }
1181 }
1182
1183 /* TODO: make all of these static inlines when we gut the env crap */
1184 bool vcore_is_mapped(struct proc *p, uint32_t vcoreid)
1185 {
1186         return p->procinfo->vcoremap[vcoreid].valid;
1187 }
1188
1189 /* Can do this, or just create a new field and save it in the vcoremap */
1190 uint32_t vcore2vcoreid(struct proc *p, struct vcore *vc)
1191 {
1192         return (vc - p->procinfo->vcoremap);
1193 }
1194
1195 struct vcore *vcoreid2vcore(struct proc *p, uint32_t vcoreid)
1196 {
1197         return &p->procinfo->vcoremap[vcoreid];
1198 }
1199
1200 /********** Core granting (bulk and single) ***********/
1201
1202 /* Helper: gives pcore to the process, mapping it to the next available vcore
1203  * from list vc_list.  Returns TRUE if we succeeded (non-empty). */
1204 static bool __proc_give_a_pcore(struct proc *p, uint32_t pcore,
1205                                 struct vcore_tailq *vc_list)
1206 {
1207         struct vcore *new_vc;
1208         new_vc = TAILQ_FIRST(vc_list);
1209         if (!new_vc)
1210                 return FALSE;
1211         printd("setting vcore %d to pcore %d\n", vcore2vcoreid(p, new_vc),
1212                pcorelist[i]);
1213         TAILQ_REMOVE(vc_list, new_vc, list);
1214         TAILQ_INSERT_TAIL(&p->online_vcs, new_vc, list);
1215         __map_vcore(p, vcore2vcoreid(p, new_vc), pcore);
1216         return TRUE;
1217 }
1218
1219 static void __proc_give_cores_runnable(struct proc *p, uint32_t *pc_arr,
1220                                        uint32_t num)
1221 {
1222         assert(p->state == PROC_RUNNABLE_M);
1223         assert(num);    /* catch bugs */
1224         /* add new items to the vcoremap */
1225         __seq_start_write(&p->procinfo->coremap_seqctr);/* unncessary if offline */
1226         p->procinfo->num_vcores += num;
1227         for (int i = 0; i < num; i++) {
1228                 /* Try from the bulk list first */
1229                 if (__proc_give_a_pcore(p, pc_arr[i], &p->bulk_preempted_vcs))
1230                         continue;
1231                 /* o/w, try from the inactive list.  at one point, i thought there might
1232                  * be a legit way in which the inactive list could be empty, but that i
1233                  * wanted to catch it via an assert. */
1234                 assert(__proc_give_a_pcore(p, pc_arr[i], &p->inactive_vcs));
1235         }
1236         __seq_end_write(&p->procinfo->coremap_seqctr);
1237 }
1238
1239 static void __proc_give_cores_running(struct proc *p, uint32_t *pc_arr,
1240                                       uint32_t num)
1241 {
1242         /* Up the refcnt, since num cores are going to start using this
1243          * process and have it loaded in their owning_proc and 'current'. */
1244         proc_incref(p, num * 2);        /* keep in sync with __startcore */
1245         __seq_start_write(&p->procinfo->coremap_seqctr);
1246         p->procinfo->num_vcores += num;
1247         assert(TAILQ_EMPTY(&p->bulk_preempted_vcs));
1248         for (int i = 0; i < num; i++) {
1249                 assert(__proc_give_a_pcore(p, pc_arr[i], &p->inactive_vcs));
1250                 send_kernel_message(pc_arr[i], __startcore, (long)p, 0, 0,
1251                                     KMSG_IMMEDIATE);
1252         }
1253         __seq_end_write(&p->procinfo->coremap_seqctr);
1254 }
1255
1256 /* Gives process p the additional num cores listed in pcorelist.  You must be
1257  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
1258  * startup your new cores at the entry point with their virtual IDs (or restore
1259  * a preemption).  If you're RUNNABLE_M, you should call __proc_run_m after this
1260  * so that the process can start to use its cores.
1261  *
1262  * If you're *_S, make sure your core0's TF is set (which is done when coming in
1263  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
1264  * Then call __proc_run_m().
1265  *
1266  * The reason I didn't bring the _S cases from core_request over here is so we
1267  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
1268  * this is called from another core, and to avoid the _S -> _M transition.
1269  *
1270  * WARNING: You must hold the proc_lock before calling this! */
1271 void __proc_give_cores(struct proc *p, uint32_t *pc_arr, uint32_t num)
1272 {
1273         /* should never happen: */
1274         assert(num + p->procinfo->num_vcores <= MAX_NUM_CPUS);
1275         switch (p->state) {
1276                 case (PROC_RUNNABLE_S):
1277                 case (PROC_RUNNING_S):
1278                         panic("Don't give cores to a process in a *_S state!\n");
1279                         break;
1280                 case (PROC_DYING):
1281                 case (PROC_WAITING):
1282                         /* can't accept, give the cores back to the ksched and return */
1283                         for (int i = 0; i < num; i++)
1284                                 put_idle_core(pc_arr[i]);
1285                         return;
1286                 case (PROC_RUNNABLE_M):
1287                         __proc_give_cores_runnable(p, pc_arr, num);
1288                         break;
1289                 case (PROC_RUNNING_M):
1290                         __proc_give_cores_running(p, pc_arr, num);
1291                         break;
1292                 default:
1293                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1294                               __FUNCTION__);
1295         }
1296         /* TODO: move me to the ksched */
1297         p->procinfo->res_grant[RES_CORES] += num;
1298 }
1299
1300 /********** Core revocation (bulk and single) ***********/
1301
1302 /* Revokes a single vcore from a process (unmaps or sends a KMSG to unmap). */
1303 static void __proc_revoke_core(struct proc *p, uint32_t vcoreid, bool preempt)
1304 {
1305         uint32_t pcoreid = get_pcoreid(p, vcoreid);
1306         struct preempt_data *vcpd;
1307         if (preempt) {
1308                 /* Lock the vcore's state (necessary for preemption recovery) */
1309                 vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1310                 atomic_or(&vcpd->flags, VC_K_LOCK);
1311                 send_kernel_message(pcoreid, __preempt, (long)p, 0, 0, KMSG_IMMEDIATE);
1312         } else {
1313                 send_kernel_message(pcoreid, __death, 0, 0, 0, KMSG_IMMEDIATE);
1314         }
1315 }
1316
1317 /* Revokes all cores from the process (unmaps or sends a KMSGS). */
1318 static void __proc_revoke_allcores(struct proc *p, bool preempt)
1319 {
1320         struct vcore *vc_i;
1321         /* TODO: if we ever get broadcast messaging, use it here (still need to lock
1322          * the vcores' states for preemption) */
1323         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1324                 __proc_revoke_core(p, vcore2vcoreid(p, vc_i), preempt);
1325 }
1326
1327 /* Might be faster to scan the vcoremap than to walk the list... */
1328 static void __proc_unmap_allcores(struct proc *p)
1329 {
1330         struct vcore *vc_i;
1331         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1332                 __unmap_vcore(p, vcore2vcoreid(p, vc_i));
1333 }
1334
1335 /* Takes (revoke via kmsg or unmap) from process p the num cores listed in
1336  * pc_arr.  Will preempt if 'preempt' is set.  o/w, no state will be saved, etc.
1337  * Don't use this for taking all of a process's cores.
1338  *
1339  * Make sure you hold the lock when you call this, and make sure that the pcore
1340  * actually belongs to the proc, non-trivial due to other __preempt messages. */
1341 void __proc_take_corelist(struct proc *p, uint32_t *pc_arr, uint32_t num,
1342                           bool preempt)
1343 {
1344         struct vcore *vc;
1345         uint32_t vcoreid;
1346         __seq_start_write(&p->procinfo->coremap_seqctr);
1347         for (int i = 0; i < num; i++) {
1348                 vcoreid = get_vcoreid(p, pc_arr[i]);
1349                 /* Sanity check */
1350                 assert(pc_arr[i] == get_pcoreid(p, vcoreid));
1351                 /* Revoke / unmap core */
1352                 if (p->state == PROC_RUNNING_M) {
1353                         __proc_revoke_core(p, vcoreid, preempt);
1354                 } else {
1355                         assert(p->state == PROC_RUNNABLE_M);
1356                         __unmap_vcore(p, vcoreid);
1357                 }
1358                 /* Change lists for the vcore.  Note, the messages are already in flight
1359                  * (or the vcore is already unmapped), if applicable.  The only code
1360                  * that looks at the lists without holding the lock is event code, and
1361                  * it doesn't care if the vcore was unmapped (it handles that) */
1362                 vc = vcoreid2vcore(p, vcoreid);
1363                 TAILQ_REMOVE(&p->online_vcs, vc, list);
1364                 /* even for single preempts, we use the inactive list.  bulk preempt is
1365                  * only used for when we take everything. */
1366                 TAILQ_INSERT_HEAD(&p->inactive_vcs, vc, list);
1367         }
1368         p->procinfo->num_vcores -= num;
1369         __seq_end_write(&p->procinfo->coremap_seqctr);
1370         p->procinfo->res_grant[RES_CORES] -= num;
1371 }
1372
1373 /* Takes all cores from a process (revoke via kmsg or unmap), putting them on
1374  * the appropriate vcore list, and fills pc_arr with the pcores revoked, and
1375  * returns the number of entries in pc_arr.
1376  *
1377  * Make sure pc_arr is big enough to handle num_vcores().
1378  * Make sure you hold the lock when you call this. */
1379 uint32_t __proc_take_allcores(struct proc *p, uint32_t *pc_arr, bool preempt)
1380 {
1381         struct vcore *vc_i, *vc_temp;
1382         uint32_t num = 0;
1383         __seq_start_write(&p->procinfo->coremap_seqctr);
1384         /* Write out which pcores we're going to take */
1385         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1386                 pc_arr[num++] = vc_i->pcoreid;
1387         /* Revoke if they are running, o/w unmap.  Both of these need the online
1388          * list to not be changed yet. */
1389         if (p->state == PROC_RUNNING_M) {
1390                 __proc_revoke_allcores(p, preempt);
1391         } else {
1392                 assert(p->state == PROC_RUNNABLE_M);
1393                 __proc_unmap_allcores(p);
1394         }
1395         /* Move the vcores from online to the head of the appropriate list */
1396         TAILQ_FOREACH_SAFE(vc_i, &p->online_vcs, list, vc_temp) {
1397                 /* TODO: we may want a TAILQ_CONCAT_HEAD, or something that does that */
1398                 TAILQ_REMOVE(&p->online_vcs, vc_i, list);
1399                 /* Put the cores on the appropriate list */
1400                 if (preempt)
1401                         TAILQ_INSERT_HEAD(&p->bulk_preempted_vcs, vc_i, list);
1402                 else
1403                         TAILQ_INSERT_HEAD(&p->inactive_vcs, vc_i, list);
1404         }
1405         assert(TAILQ_EMPTY(&p->online_vcs));
1406         assert(num == p->procinfo->num_vcores);
1407         p->procinfo->num_vcores = 0;
1408         __seq_end_write(&p->procinfo->coremap_seqctr);
1409         p->procinfo->res_grant[RES_CORES] = 0;
1410         return num;
1411 }
1412
1413 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
1414  * calling. */
1415 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
1416 {
1417         while (p->procinfo->vcoremap[vcoreid].valid)
1418                 cpu_relax();
1419         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
1420         wmb();
1421         p->procinfo->vcoremap[vcoreid].valid = TRUE;
1422         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
1423         wmb();
1424         p->procinfo->pcoremap[pcoreid].valid = TRUE;
1425 }
1426
1427 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
1428  * calling. */
1429 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
1430 {
1431         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid = FALSE;
1432         wmb();
1433         p->procinfo->vcoremap[vcoreid].valid = FALSE;
1434 }
1435
1436 /* Stop running whatever context is on this core and load a known-good cr3.
1437  * Note this leaves no trace of what was running. This "leaves the process's
1438  * context.  Also, we want interrupts disabled, to not conflict with kmsgs
1439  * (__launch_kthread, proc mgmt, etc).
1440  *
1441  * This does not clear the owning proc.  Use the other helper for that. */
1442 void abandon_core(void)
1443 {
1444         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1445         assert(!irq_is_enabled());
1446         /* Syscalls that don't return will ultimately call abadon_core(), so we need
1447          * to make sure we don't think we are still working on a syscall. */
1448         pcpui->cur_sysc = 0;
1449         if (pcpui->cur_proc)
1450                 __abandon_core();
1451 }
1452
1453 /* Helper to clear the core's owning processor and manage refcnting.  Pass in
1454  * core_id() to save a couple core_id() calls. */
1455 void clear_owning_proc(uint32_t coreid)
1456 {
1457         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1458         struct proc *p = pcpui->owning_proc;
1459         assert(!irq_is_enabled());
1460         pcpui->owning_proc = 0;
1461         pcpui->cur_tf = 0;                      /* catch bugs for now (will go away soon) */
1462         if (p);
1463                 proc_decref(p);
1464 }
1465
1466 /* Switches to the address space/context of new_p, doing nothing if we are
1467  * already in new_p.  This won't add extra refcnts or anything, and needs to be
1468  * paired with switch_back() at the end of whatever function you are in.  Don't
1469  * migrate cores in the middle of a pair.  Specifically, the uncounted refs are
1470  * one for the old_proc, which is passed back to the caller, and new_p is
1471  * getting placed in cur_proc. */
1472 struct proc *switch_to(struct proc *new_p)
1473 {
1474         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1475         struct proc *old_proc;
1476         int8_t irq_state = 0;
1477         disable_irqsave(&irq_state);
1478         old_proc = pcpui->cur_proc;                                     /* uncounted ref */
1479         /* If we aren't the proc already, then switch to it */
1480         if (old_proc != new_p) {
1481                 pcpui->cur_proc = new_p;                                /* uncounted ref */
1482                 lcr3(new_p->env_cr3);
1483         }
1484         enable_irqsave(&irq_state);
1485         return old_proc;
1486 }
1487
1488 /* This switches back to old_proc from new_p.  Pair it with switch_to(), and
1489  * pass in its return value for old_proc. */
1490 void switch_back(struct proc *new_p, struct proc *old_proc)
1491 {
1492         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1493         int8_t irq_state = 0;
1494         if (old_proc != new_p) {
1495                 disable_irqsave(&irq_state);
1496                 pcpui->cur_proc = old_proc;
1497                 if (old_proc)
1498                         lcr3(old_proc->env_cr3);
1499                 else
1500                         lcr3(boot_cr3);
1501                 enable_irqsave(&irq_state);
1502         }
1503 }
1504
1505 /* Will send a TLB shootdown message to every vcore in the main address space
1506  * (aka, all vcores for now).  The message will take the start and end virtual
1507  * addresses as well, in case we want to be more clever about how much we
1508  * shootdown and batching our messages.  Should do the sanity about rounding up
1509  * and down in this function too.
1510  *
1511  * Would be nice to have a broadcast kmsg at this point.  Note this may send a
1512  * message to the calling core (interrupting it, possibly while holding the
1513  * proc_lock).  We don't need to process routine messages since it's an
1514  * immediate message. */
1515 void proc_tlbshootdown(struct proc *p, uintptr_t start, uintptr_t end)
1516 {
1517         struct vcore *vc_i;
1518         /* TODO: we might be able to avoid locking here in the future (we must hit
1519          * all online, and we can check __mapped).  it'll be complicated. */
1520         spin_lock(&p->proc_lock);
1521         switch (p->state) {
1522                 case (PROC_RUNNING_S):
1523                         tlbflush();
1524                         break;
1525                 case (PROC_RUNNING_M):
1526                         /* TODO: (TLB) sanity checks and rounding on the ranges */
1527                         TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
1528                                 send_kernel_message(vc_i->pcoreid, __tlbshootdown, start, end,
1529                                                     0, KMSG_IMMEDIATE);
1530                         }
1531                         break;
1532                 case (PROC_DYING):
1533                         /* if it is dying, death messages are already on the way to all
1534                          * cores, including ours, which will clear the TLB. */
1535                         break;
1536                 default:
1537                         /* will probably get this when we have the short handlers */
1538                         warn("Unexpected case %s in %s", procstate2str(p->state),
1539                              __FUNCTION__);
1540         }
1541         spin_unlock(&p->proc_lock);
1542 }
1543
1544 /* Helper, used by __startcore and change_to_vcore, which sets up cur_tf to run
1545  * a given process's vcore.  Caller needs to set up things like owning_proc and
1546  * whatnot.  Note that we might not have p loaded as current. */
1547 static void __set_curtf_to_vcoreid(struct proc *p, uint32_t vcoreid)
1548 {
1549         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1550         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1551
1552         /* We could let userspace do this, though they come into vcore entry many
1553          * times, and we just need this to happen when the cores comes online the
1554          * first time.  That, and they want this turned on as soon as we know a
1555          * vcore *WILL* be online.  We could also do this earlier, when we map the
1556          * vcore to its pcore, though we don't always have current loaded or
1557          * otherwise mess with the VCPD in those code paths. */
1558         vcpd->can_rcv_msg = TRUE;
1559         /* Mark that this vcore as no longer preempted.  No danger of clobbering
1560          * other writes, since this would get turned on in __preempt (which can't be
1561          * concurrent with this function on this core), and the atomic is just
1562          * toggling the one bit (a concurrent VC_K_LOCK will work) */
1563         atomic_and(&vcpd->flags, ~VC_PREEMPTED);
1564         printd("[kernel] startcore on physical core %d for process %d's vcore %d\n",
1565                core_id(), p->pid, vcoreid);
1566         /* If notifs are disabled, the vcore was in vcore context and we need to
1567          * restart the preempt_tf.  o/w, we give them a fresh vcore (which is also
1568          * what happens the first time a vcore comes online).  No matter what,
1569          * they'll restart in vcore context.  It's just a matter of whether or not
1570          * it is the old, interrupted vcore context. */
1571         if (vcpd->notif_disabled) {
1572                 restore_fp_state(&vcpd->preempt_anc);
1573                 /* copy-in the tf we'll pop, then set all security-related fields */
1574                 pcpui->actual_tf = vcpd->preempt_tf;
1575                 proc_secure_trapframe(&pcpui->actual_tf);
1576         } else { /* not restarting from a preemption, use a fresh vcore */
1577                 assert(vcpd->transition_stack);
1578                 /* TODO: consider 0'ing the FP state.  We're probably leaking. */
1579                 proc_init_trapframe(&pcpui->actual_tf, vcoreid, p->env_entry,
1580                                     vcpd->transition_stack);
1581                 /* Disable/mask active notifications for fresh vcores */
1582                 vcpd->notif_disabled = TRUE;
1583         }
1584         /* cur_tf was built above (in actual_tf), now use it */
1585         pcpui->cur_tf = &pcpui->actual_tf;
1586         /* this cur_tf will get run when the kernel returns / idles */
1587 }
1588
1589 /* Changes calling vcore to be vcoreid.  enable_my_notif tells us about how the
1590  * state calling vcore wants to be left in.  It will look like caller_vcoreid
1591  * was preempted.  Note we don't care about notif_pending.  */
1592 void proc_change_to_vcore(struct proc *p, uint32_t new_vcoreid,
1593                           bool enable_my_notif)
1594 {
1595         uint32_t caller_vcoreid, pcoreid = core_id();
1596         struct preempt_data *caller_vcpd;
1597         struct vcore *caller_vc, *new_vc;
1598         struct event_msg preempt_msg = {0};
1599         int8_t state = 0;
1600         /* Need to disable before even reading caller_vcoreid, since we could be
1601          * unmapped by a __preempt or __death, like in yield. */
1602         disable_irqsave(&state);
1603         /* Need to lock before reading the vcoremap, like in yield */
1604         spin_lock(&p->proc_lock);
1605         /* new_vcoreid is already runing, abort */
1606         if (vcore_is_mapped(p, new_vcoreid))
1607                 goto out_failed;
1608         /* Need to make sure our vcore is allowed to switch.  We might have a
1609          * __preempt, __death, etc, coming in.  Similar to yield. */
1610         switch (p->state) {
1611                 case (PROC_RUNNING_M):
1612                         break;                          /* the only case we can proceed */
1613                 case (PROC_RUNNING_S):  /* user bug, just return */
1614                 case (PROC_DYING):              /* incoming __death */
1615                 case (PROC_RUNNABLE_M): /* incoming (bulk) preempt/myield TODO:(BULK) */
1616                         goto out_failed;
1617                 default:
1618                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1619                               __FUNCTION__);
1620         }
1621         /* Make sure we're still mapped in the proc. */
1622         if (!is_mapped_vcore(p, pcoreid))
1623                 goto out_failed;
1624         /* Get all our info */
1625         caller_vcoreid = get_vcoreid(p, pcoreid);
1626         caller_vcpd = &p->procdata->vcore_preempt_data[caller_vcoreid];
1627         caller_vc = vcoreid2vcore(p, caller_vcoreid);
1628         /* Should only call from vcore context */
1629         if (!caller_vcpd->notif_disabled) {
1630                 printk("[kernel] You tried to change vcores from uthread ctx\n");
1631                 goto out_failed;
1632         }
1633         /* Return and take the preempt message when we enable_irqs. */
1634         if (caller_vc->preempt_served)
1635                 goto out_failed;
1636         /* Ok, we're clear to do the switch.  Lets figure out who the new one is */
1637         new_vc = vcoreid2vcore(p, new_vcoreid);
1638         printd("[kernel] changing vcore %d to vcore %d\n", caller_vcoreid,
1639                new_vcoreid);
1640         /* enable_my_notif signals how we'll be restarted */
1641         if (enable_my_notif) {
1642                 /* if they set this flag, then the vcore can just restart from scratch,
1643                  * and we don't care about either the notif_tf or the preempt_tf. */
1644                 caller_vcpd->notif_disabled = FALSE;
1645         } else {
1646                 /* need to set up the calling vcore's tf so that it'll get restarted by
1647                  * __startcore, to make the caller look like it was preempted. */
1648                 caller_vcpd->preempt_tf = *current_tf;
1649                 save_fp_state(&caller_vcpd->preempt_anc);
1650                 /* Mark our core as preempted (for userspace recovery). */
1651                 atomic_or(&caller_vcpd->flags, VC_PREEMPTED);
1652         }
1653         /* Either way, unmap and offline our current vcore */
1654         /* Move the caller from online to inactive */
1655         TAILQ_REMOVE(&p->online_vcs, caller_vc, list);
1656         /* We don't bother with the notif_pending race.  note that notif_pending
1657          * could still be set.  this was a preempted vcore, and userspace will need
1658          * to deal with missed messages (preempt_recover() will handle that) */
1659         TAILQ_INSERT_HEAD(&p->inactive_vcs, caller_vc, list);
1660         /* Move the new one from inactive to online */
1661         TAILQ_REMOVE(&p->inactive_vcs, new_vc, list);
1662         TAILQ_INSERT_TAIL(&p->online_vcs, new_vc, list);
1663         /* Change the vcore map (TODO: might get rid of this seqctr) */
1664         __seq_start_write(&p->procinfo->coremap_seqctr);
1665         __unmap_vcore(p, caller_vcoreid);
1666         __map_vcore(p, new_vcoreid, pcoreid);
1667         __seq_end_write(&p->procinfo->coremap_seqctr);
1668         /* Send either a PREEMPT msg or a CHECK_MSGS msg.  If they said to
1669          * enable_my_notif, then all userspace needs is to check messages, not a
1670          * full preemption recovery. */
1671         preempt_msg.ev_type = (enable_my_notif ? EV_CHECK_MSGS : EV_VCORE_PREEMPT);
1672         preempt_msg.ev_arg2 = caller_vcoreid;   /* arg2 is 32 bits */
1673         send_kernel_event(p, &preempt_msg, new_vcoreid);
1674         /* Change cur_tf so we'll be the new vcoreid */
1675         __set_curtf_to_vcoreid(p, new_vcoreid);
1676         /* Fall through to exit (we didn't fail) */
1677 out_failed:
1678         spin_unlock(&p->proc_lock);
1679         enable_irqsave(&state);
1680 }
1681
1682 /* Kernel message handler to start a process's context on this core, when the
1683  * core next considers running a process.  Tightly coupled with __proc_run_m().
1684  * Interrupts are disabled. */
1685 void __startcore(struct trapframe *tf, uint32_t srcid, long a0, long a1, long a2)
1686 {
1687         uint32_t vcoreid, coreid = core_id();
1688         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1689         struct proc *p_to_run = (struct proc *CT(1))a0;
1690
1691         assert(p_to_run);
1692         /* Can not be any TF from a process here already */
1693         assert(!pcpui->owning_proc);
1694         /* the sender of the amsg increfed already for this saved ref to p_to_run */
1695         pcpui->owning_proc = p_to_run;
1696         /* sender increfed again, assuming we'd install to cur_proc.  only do this
1697          * if no one else is there.  this is an optimization, since we expect to
1698          * send these __startcores to idles cores, and this saves a scramble to
1699          * incref when all of the cores restartcore/startcore later.  Keep in sync
1700          * with __proc_give_cores() and __proc_run_m(). */
1701         if (!pcpui->cur_proc) {
1702                 pcpui->cur_proc = p_to_run;     /* install the ref to cur_proc */
1703                 lcr3(p_to_run->env_cr3);        /* load the page tables to match cur_proc */
1704         } else {
1705                 proc_decref(p_to_run);          /* can't install, decref the extra one */
1706         }
1707         /* Note we are not necessarily in the cr3 of p_to_run */
1708         vcoreid = get_vcoreid(p_to_run, coreid);
1709         /* Now that we sorted refcnts and know p / which vcore it should be, set up
1710          * pcpui->cur_tf so that it will run that particular vcore */
1711         __set_curtf_to_vcoreid(p_to_run, vcoreid);
1712 }
1713
1714 /* Bail out if it's the wrong process, or if they no longer want a notif.  Don't
1715  * use the TF we passed in, we care about cur_tf.  Try not to grab locks or
1716  * write access to anything that isn't per-core in here. */
1717 void __notify(struct trapframe *tf, uint32_t srcid, long a0, long a1, long a2)
1718 {
1719         uint32_t vcoreid, coreid = core_id();
1720         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1721         struct preempt_data *vcpd;
1722         struct proc *p = (struct proc*)a0;
1723
1724         /* Not the right proc */
1725         if (p != pcpui->owning_proc)
1726                 return;
1727         /* Common cur_tf sanity checks */
1728         assert(pcpui->cur_tf);
1729         assert(pcpui->cur_tf == &pcpui->actual_tf);
1730         assert(!in_kernel(pcpui->cur_tf));
1731         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1732          * mapping would only happen if the vcore was free, which it isn't until
1733          * after we unmap. */
1734         vcoreid = get_vcoreid(p, coreid);
1735         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1736         printd("received active notification for proc %d's vcore %d on pcore %d\n",
1737                p->procinfo->pid, vcoreid, coreid);
1738         /* sort signals.  notifs are now masked, like an interrupt gate */
1739         if (vcpd->notif_disabled)
1740                 return;
1741         vcpd->notif_disabled = TRUE;
1742         /* This bit shouldn't be important anymore */
1743         vcpd->notif_pending = FALSE; // no longer pending - it made it here
1744         /* save the old tf in the notify slot, build and pop a new one.  Note that
1745          * silly state isn't our business for a notification. */
1746         vcpd->notif_tf = *pcpui->cur_tf;
1747         memset(pcpui->cur_tf, 0, sizeof(struct trapframe));
1748         proc_init_trapframe(pcpui->cur_tf, vcoreid, p->env_entry,
1749                             vcpd->transition_stack);
1750         /* this cur_tf will get run when the kernel returns / idles */
1751 }
1752
1753 void __preempt(struct trapframe *tf, uint32_t srcid, long a0, long a1, long a2)
1754 {
1755         uint32_t vcoreid, coreid = core_id();
1756         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1757         struct preempt_data *vcpd;
1758         struct proc *p = (struct proc*)a0;
1759
1760         assert(p);
1761         if (p != pcpui->owning_proc) {
1762                 panic("__preempt arrived for a process (%p) that was not owning (%p)!",
1763                       p, pcpui->owning_proc);
1764         }
1765         /* Common cur_tf sanity checks */
1766         assert(pcpui->cur_tf);
1767         assert(pcpui->cur_tf == &pcpui->actual_tf);
1768         assert(!in_kernel(pcpui->cur_tf));
1769         /* We shouldn't need to lock here, since unmapping happens on the pcore and
1770          * mapping would only happen if the vcore was free, which it isn't until
1771          * after we unmap. */
1772         vcoreid = get_vcoreid(p, coreid);
1773         p->procinfo->vcoremap[vcoreid].preempt_served = FALSE;
1774         /* either __preempt or proc_yield() ends the preempt phase. */
1775         p->procinfo->vcoremap[vcoreid].preempt_pending = 0;
1776         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1777         printd("[kernel] received __preempt for proc %d's vcore %d on pcore %d\n",
1778                p->procinfo->pid, vcoreid, coreid);
1779         /* if notifs are disabled, the vcore is in vcore context (as far as we're
1780          * concerned), and we save it in the preempt slot. o/w, we save the
1781          * process's cur_tf in the notif slot, and it'll appear to the vcore when it
1782          * comes back up that it just took a notification. */
1783         if (vcpd->notif_disabled)
1784                 vcpd->preempt_tf = *pcpui->cur_tf;
1785         else
1786                 vcpd->notif_tf = *pcpui->cur_tf;
1787         /* either way, we save the silly state (FP) */
1788         save_fp_state(&vcpd->preempt_anc);
1789         /* Mark the vcore as preempted and unlock (was locked by the sender). */
1790         atomic_or(&vcpd->flags, VC_PREEMPTED);
1791         atomic_and(&vcpd->flags, ~VC_K_LOCK);
1792         wmb();  /* make sure everything else hits before we unmap */
1793         __unmap_vcore(p, vcoreid);
1794         /* We won't restart the process later.  current gets cleared later when we
1795          * notice there is no owning_proc and we have nothing to do (smp_idle,
1796          * restartcore, etc) */
1797         clear_owning_proc(coreid);
1798 }
1799
1800 /* Kernel message handler to clean up the core when a process is dying.
1801  * Note this leaves no trace of what was running.
1802  * It's okay if death comes to a core that's already idling and has no current.
1803  * It could happen if a process decref'd before __proc_startcore could incref. */
1804 void __death(struct trapframe *tf, uint32_t srcid, long a0, long a1, long a2)
1805 {
1806         uint32_t vcoreid, coreid = core_id();
1807         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1808         struct proc *p = pcpui->owning_proc;
1809         if (p) {
1810                 vcoreid = get_vcoreid(p, coreid);
1811                 printd("[kernel] death on physical core %d for process %d's vcore %d\n",
1812                        coreid, p->pid, vcoreid);
1813                 __unmap_vcore(p, vcoreid);
1814                 /* We won't restart the process later.  current gets cleared later when
1815                  * we notice there is no owning_proc and we have nothing to do
1816                  * (smp_idle, restartcore, etc) */
1817                 clear_owning_proc(coreid);
1818         }
1819 }
1820
1821 /* Kernel message handler, usually sent IMMEDIATE, to shoot down virtual
1822  * addresses from a0 to a1. */
1823 void __tlbshootdown(struct trapframe *tf, uint32_t srcid, long a0, long a1,
1824                     long a2)
1825 {
1826         /* TODO: (TLB) something more intelligent with the range */
1827         tlbflush();
1828 }
1829
1830 void print_allpids(void)
1831 {
1832         void print_proc_state(void *item)
1833         {
1834                 struct proc *p = (struct proc*)item;
1835                 assert(p);
1836                 printk("%8d %s\n", p->pid, procstate2str(p->state));
1837         }
1838         printk("PID      STATE    \n");
1839         printk("------------------\n");
1840         spin_lock(&pid_hash_lock);
1841         hash_for_each(pid_hash, print_proc_state);
1842         spin_unlock(&pid_hash_lock);
1843 }
1844
1845 void print_proc_info(pid_t pid)
1846 {
1847         int j = 0;
1848         struct proc *p = pid2proc(pid);
1849         struct vcore *vc_i;
1850         if (!p) {
1851                 printk("Bad PID.\n");
1852                 return;
1853         }
1854         spinlock_debug(&p->proc_lock);
1855         //spin_lock(&p->proc_lock); // No locking!!
1856         printk("struct proc: %p\n", p);
1857         printk("PID: %d\n", p->pid);
1858         printk("PPID: %d\n", p->ppid);
1859         printk("State: %s (%p)\n", procstate2str(p->state), p->state);
1860         printk("Refcnt: %d\n", atomic_read(&p->p_kref.refcount) - 1);
1861         printk("Flags: 0x%08x\n", p->env_flags);
1862         printk("CR3(phys): 0x%08x\n", p->env_cr3);
1863         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
1864         printk("Vcore Lists (may be in flux w/o locking):\n----------------------\n");
1865         printk("Online:\n");
1866         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1867                 printk("\tVcore %d -> Pcore %d\n", vcore2vcoreid(p, vc_i), vc_i->pcoreid);
1868         printk("Bulk Preempted:\n");
1869         TAILQ_FOREACH(vc_i, &p->bulk_preempted_vcs, list)
1870                 printk("\tVcore %d\n", vcore2vcoreid(p, vc_i));
1871         printk("Inactive / Yielded:\n");
1872         TAILQ_FOREACH(vc_i, &p->inactive_vcs, list)
1873                 printk("\tVcore %d\n", vcore2vcoreid(p, vc_i));
1874         printk("Resources:\n------------------------\n");
1875         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
1876                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
1877                        p->procdata->res_req[i].amt_wanted, p->procinfo->res_grant[i]);
1878         printk("Open Files:\n");
1879         struct files_struct *files = &p->open_files;
1880         spin_lock(&files->lock);
1881         for (int i = 0; i < files->max_files; i++)
1882                 if (files->fd_array[i].fd_file) {
1883                         printk("\tFD: %02d, File: %08p, File name: %s\n", i,
1884                                files->fd_array[i].fd_file,
1885                                file_name(files->fd_array[i].fd_file));
1886                 }
1887         spin_unlock(&files->lock);
1888         /* No one cares, and it clutters the terminal */
1889         //printk("Vcore 0's Last Trapframe:\n");
1890         //print_trapframe(&p->env_tf);
1891         /* no locking / unlocking or refcnting */
1892         // spin_unlock(&p->proc_lock);
1893         proc_decref(p);
1894 }
1895
1896 /* Debugging function, checks what (process, vcore) is supposed to run on this
1897  * pcore.  Meant to be called from smp_idle() before halting. */
1898 void check_my_owner(void)
1899 {
1900         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1901         void shazbot(void *item)
1902         {
1903                 struct proc *p = (struct proc*)item;
1904                 struct vcore *vc_i;
1905                 assert(p);
1906                 spin_lock(&p->proc_lock);
1907                 TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
1908                         /* this isn't true, a __startcore could be on the way and we're
1909                          * already "online" */
1910                         if (vc_i->pcoreid == core_id()) {
1911                                 /* Immediate message was sent, we should get it when we enable
1912                                  * interrupts, which should cause us to skip cpu_halt() */
1913                                 if (!STAILQ_EMPTY(&pcpui->immed_amsgs))
1914                                         continue;
1915                                 printk("Owned pcore (%d) has no owner, by %08p, vc %d!\n",
1916                                        core_id(), p, vcore2vcoreid(p, vc_i));
1917                                 spin_unlock(&p->proc_lock);
1918                                 spin_unlock(&pid_hash_lock);
1919                                 monitor(0);
1920                         }
1921                 }
1922                 spin_unlock(&p->proc_lock);
1923         }
1924         assert(!irq_is_enabled());
1925         extern int booting;
1926         if (!booting && !pcpui->owning_proc) {
1927                 spin_lock(&pid_hash_lock);
1928                 hash_for_each(pid_hash, shazbot);
1929                 spin_unlock(&pid_hash_lock);
1930         }
1931 }