proc_yield() no longer messes with amt_wanted
[akaros.git] / kern / src / process.c
1 /* Copyright (c) 2009, 2010 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details. */
4
5 #ifdef __SHARC__
6 #pragma nosharc
7 #endif
8
9 #include <ros/bcq.h>
10 #include <event.h>
11 #include <arch/arch.h>
12 #include <bitmask.h>
13 #include <process.h>
14 #include <atomic.h>
15 #include <smp.h>
16 #include <pmap.h>
17 #include <trap.h>
18 #include <schedule.h>
19 #include <manager.h>
20 #include <stdio.h>
21 #include <assert.h>
22 #include <time.h>
23 #include <hashtable.h>
24 #include <slab.h>
25 #include <sys/queue.h>
26 #include <frontend.h>
27 #include <monitor.h>
28 #include <resource.h>
29 #include <elf.h>
30 #include <arsc_server.h>
31 #include <devfs.h>
32
33 struct kmem_cache *proc_cache;
34
35 /* Other helpers, implemented later. */
36 static void __proc_startcore(struct proc *p, trapframe_t *tf);
37 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid);
38 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid);
39 static uint32_t try_get_pcoreid(struct proc *p, uint32_t vcoreid);
40 static uint32_t get_pcoreid(struct proc *p, uint32_t vcoreid);
41 static void __proc_free(struct kref *kref);
42
43 /* PID management. */
44 #define PID_MAX 32767 // goes from 0 to 32767, with 0 reserved
45 static DECL_BITMASK(pid_bmask, PID_MAX + 1);
46 spinlock_t pid_bmask_lock = SPINLOCK_INITIALIZER;
47 struct hashtable *pid_hash;
48 spinlock_t pid_hash_lock; // initialized in proc_init
49
50 /* Finds the next free entry (zero) entry in the pid_bitmask.  Set means busy.
51  * PID 0 is reserved (in proc_init).  A return value of 0 is a failure (and
52  * you'll also see a warning, for now).  Consider doing this with atomics. */
53 static pid_t get_free_pid(void)
54 {
55         static pid_t next_free_pid = 1;
56         pid_t my_pid = 0;
57
58         spin_lock(&pid_bmask_lock);
59         // atomically (can lock for now, then change to atomic_and_return
60         FOR_CIRC_BUFFER(next_free_pid, PID_MAX + 1, i) {
61                 // always points to the next to test
62                 next_free_pid = (next_free_pid + 1) % (PID_MAX + 1);
63                 if (!GET_BITMASK_BIT(pid_bmask, i)) {
64                         SET_BITMASK_BIT(pid_bmask, i);
65                         my_pid = i;
66                         break;
67                 }
68         }
69         spin_unlock(&pid_bmask_lock);
70         if (!my_pid)
71                 warn("Shazbot!  Unable to find a PID!  You need to deal with this!\n");
72         return my_pid;
73 }
74
75 /* Return a pid to the pid bitmask */
76 static void put_free_pid(pid_t pid)
77 {
78         spin_lock(&pid_bmask_lock);
79         CLR_BITMASK_BIT(pid_bmask, pid);
80         spin_unlock(&pid_bmask_lock);
81 }
82
83 /* While this could be done with just an assignment, this gives us the
84  * opportunity to check for bad transitions.  Might compile these out later, so
85  * we shouldn't rely on them for sanity checking from userspace.  */
86 int __proc_set_state(struct proc *p, uint32_t state)
87 {
88         uint32_t curstate = p->state;
89         /* Valid transitions:
90          * C   -> RBS
91          * C   -> D
92          * RBS -> RGS
93          * RGS -> RBS
94          * RGS -> W
95          * RGM -> W
96          * W   -> RBS
97          * W   -> RBM
98          * RGS -> RBM
99          * RBM -> RGM
100          * RGM -> RBM
101          * RGM -> RBS
102          * RGS -> D
103          * RGM -> D
104          *
105          * These ought to be implemented later (allowed, not thought through yet).
106          * RBS -> D
107          * RBM -> D
108          */
109         #if 1 // some sort of correctness flag
110         switch (curstate) {
111                 case PROC_CREATED:
112                         if (!(state & (PROC_RUNNABLE_S | PROC_DYING)))
113                                 panic("Invalid State Transition! PROC_CREATED to %02x", state);
114                         break;
115                 case PROC_RUNNABLE_S:
116                         if (!(state & (PROC_RUNNING_S | PROC_DYING)))
117                                 panic("Invalid State Transition! PROC_RUNNABLE_S to %02x", state);
118                         break;
119                 case PROC_RUNNING_S:
120                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
121                                        PROC_DYING)))
122                                 panic("Invalid State Transition! PROC_RUNNING_S to %02x", state);
123                         break;
124                 case PROC_WAITING:
125                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M)))
126                                 panic("Invalid State Transition! PROC_WAITING to %02x", state);
127                         break;
128                 case PROC_DYING:
129                         if (state != PROC_CREATED) // when it is reused (TODO)
130                                 panic("Invalid State Transition! PROC_DYING to %02x", state);
131                         break;
132                 case PROC_RUNNABLE_M:
133                         if (!(state & (PROC_RUNNING_M | PROC_DYING)))
134                                 panic("Invalid State Transition! PROC_RUNNABLE_M to %02x", state);
135                         break;
136                 case PROC_RUNNING_M:
137                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
138                                        PROC_DYING)))
139                                 panic("Invalid State Transition! PROC_RUNNING_M to %02x", state);
140                         break;
141         }
142         #endif
143         p->state = state;
144         return 0;
145 }
146
147 /* Returns a pointer to the proc with the given pid, or 0 if there is none.
148  * This uses get_not_zero, since it is possible the refcnt is 0, which means the
149  * process is dying and we should not have the ref (and thus return 0).  We need
150  * to lock to protect us from getting p, (someone else removes and frees p),
151  * then get_not_zero() on p.
152  * Don't push the locking into the hashtable without dealing with this. */
153 struct proc *pid2proc(pid_t pid)
154 {
155         spin_lock(&pid_hash_lock);
156         struct proc *p = hashtable_search(pid_hash, (void*)(long)pid);
157         if (p)
158                 if (!kref_get_not_zero(&p->p_kref, 1))
159                         p = 0;
160         spin_unlock(&pid_hash_lock);
161         return p;
162 }
163
164 /* Performs any initialization related to processes, such as create the proc
165  * cache, prep the scheduler, etc.  When this returns, we should be ready to use
166  * any process related function. */
167 void proc_init(void)
168 {
169         /* Catch issues with the vcoremap and TAILQ_ENTRY sizes */
170         static_assert(sizeof(TAILQ_ENTRY(vcore)) == sizeof(void*) * 2);
171         proc_cache = kmem_cache_create("proc", sizeof(struct proc),
172                      MAX(HW_CACHE_ALIGN, __alignof__(struct proc)), 0, 0, 0);
173         /* Init PID mask and hash.  pid 0 is reserved. */
174         SET_BITMASK_BIT(pid_bmask, 0);
175         spinlock_init(&pid_hash_lock);
176         spin_lock(&pid_hash_lock);
177         pid_hash = create_hashtable(100, __generic_hash, __generic_eq);
178         spin_unlock(&pid_hash_lock);
179         schedule_init();
180
181         atomic_init(&num_envs, 0);
182 }
183
184 /* Be sure you init'd the vcore lists before calling this. */
185 static void proc_init_procinfo(struct proc* p)
186 {
187         p->procinfo->pid = p->pid;
188         p->procinfo->ppid = p->ppid;
189         p->procinfo->max_vcores = max_vcores(p);
190         p->procinfo->tsc_freq = system_timing.tsc_freq;
191         p->procinfo->heap_bottom = (void*)UTEXT;
192         /* 0'ing the arguments.  Some higher function will need to set them */
193         memset(p->procinfo->argp, 0, sizeof(p->procinfo->argp));
194         memset(p->procinfo->argbuf, 0, sizeof(p->procinfo->argbuf));
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->resources, 0, sizeof(p->resources));
252         memset(&p->env_ancillary_state, 0, sizeof(p->env_ancillary_state));
253         memset(&p->env_tf, 0, sizeof(p->env_tf));
254         spinlock_init(&p->mm_lock);
255         TAILQ_INIT(&p->vm_regions); /* could init this in the slab */
256         /* Initialize the vcore lists, we'll build the inactive list so that it includes
257          * all vcores when we initialize procinfo.  Do this before initing procinfo. */
258         TAILQ_INIT(&p->online_vcs);
259         TAILQ_INIT(&p->bulk_preempted_vcs);
260         TAILQ_INIT(&p->inactive_vcs);
261         /* Init procinfo/procdata.  Procinfo's argp/argb are 0'd */
262         proc_init_procinfo(p);
263         proc_init_procdata(p);
264
265         /* Initialize the generic sysevent ring buffer */
266         SHARED_RING_INIT(&p->procdata->syseventring);
267         /* Initialize the frontend of the sysevent ring buffer */
268         FRONT_RING_INIT(&p->syseventfrontring,
269                         &p->procdata->syseventring,
270                         SYSEVENTRINGSIZE);
271
272         /* Init FS structures TODO: cleanup (might pull this out) */
273         kref_get(&default_ns.kref, 1);
274         p->ns = &default_ns;
275         spinlock_init(&p->fs_env.lock);
276         p->fs_env.umask = parent ? parent->fs_env.umask : S_IWGRP | S_IWOTH;
277         p->fs_env.root = p->ns->root->mnt_root;
278         kref_get(&p->fs_env.root->d_kref, 1);
279         p->fs_env.pwd = parent ? parent->fs_env.pwd : p->fs_env.root;
280         kref_get(&p->fs_env.pwd->d_kref, 1);
281         memset(&p->open_files, 0, sizeof(p->open_files));       /* slightly ghetto */
282         spinlock_init(&p->open_files.lock);
283         p->open_files.max_files = NR_OPEN_FILES_DEFAULT;
284         p->open_files.max_fdset = NR_FILE_DESC_DEFAULT;
285         p->open_files.fd = p->open_files.fd_array;
286         p->open_files.open_fds = (struct fd_set*)&p->open_files.open_fds_init;
287         /* Init the ucq hash lock */
288         p->ucq_hashlock = (struct hashlock*)&p->ucq_hl_noref;
289         hashlock_init(p->ucq_hashlock, HASHLOCK_DEFAULT_SZ);
290
291         atomic_inc(&num_envs);
292         frontend_proc_init(p);
293         printd("[%08x] new process %08x\n", current ? current->pid : 0, p->pid);
294         } // INIT_STRUCT
295         *pp = p;
296         return 0;
297 }
298
299 /* We have a bunch of different ways to make processes.  Call this once the
300  * process is ready to be used by the rest of the system.  For now, this just
301  * means when it is ready to be named via the pidhash.  In the future, we might
302  * push setting the state to CREATED into here. */
303 void __proc_ready(struct proc *p)
304 {
305         spin_lock(&pid_hash_lock);
306         hashtable_insert(pid_hash, (void*)(long)p->pid, p);
307         spin_unlock(&pid_hash_lock);
308 }
309
310 /* Creates a process from the specified file, argvs, and envps.  Tempted to get
311  * rid of proc_alloc's style, but it is so quaint... */
312 struct proc *proc_create(struct file *prog, char **argv, char **envp)
313 {
314         struct proc *p;
315         error_t r;
316         if ((r = proc_alloc(&p, current)) < 0)
317                 panic("proc_create: %e", r);    /* one of 3 quaint usages of %e */
318         procinfo_pack_args(p->procinfo, argv, envp);
319         assert(load_elf(p, prog) == 0);
320         /* Connect to stdin, stdout, stderr */
321         assert(insert_file(&p->open_files, dev_stdin,  0) == 0);
322         assert(insert_file(&p->open_files, dev_stdout, 0) == 1);
323         assert(insert_file(&p->open_files, dev_stderr, 0) == 2);
324         __proc_ready(p);
325         return p;
326 }
327
328 /* This is called by kref_put(), once the last reference to the process is
329  * gone.  Don't call this otherwise (it will panic).  It will clean up the
330  * address space and deallocate any other used memory. */
331 static void __proc_free(struct kref *kref)
332 {
333         struct proc *p = container_of(kref, struct proc, p_kref);
334         physaddr_t pa;
335
336         printd("[PID %d] freeing proc: %d\n", current ? current->pid : 0, p->pid);
337         // All parts of the kernel should have decref'd before __proc_free is called
338         assert(kref_refcnt(&p->p_kref) == 0);
339
340         kref_put(&p->fs_env.root->d_kref);
341         kref_put(&p->fs_env.pwd->d_kref);
342         destroy_vmrs(p);
343         frontend_proc_free(p);  /* TODO: please remove me one day */
344         /* Free any colors allocated to this process */
345         if (p->cache_colors_map != global_cache_colors_map) {
346                 for(int i = 0; i < llc_cache->num_colors; i++)
347                         cache_color_free(llc_cache, p->cache_colors_map);
348                 cache_colors_map_free(p->cache_colors_map);
349         }
350         /* Remove us from the pid_hash and give our PID back (in that order). */
351         spin_lock(&pid_hash_lock);
352         if (!hashtable_remove(pid_hash, (void*)(long)p->pid))
353                 panic("Proc not in the pid table in %s", __FUNCTION__);
354         spin_unlock(&pid_hash_lock);
355         put_free_pid(p->pid);
356         /* Flush all mapped pages in the user portion of the address space */
357         env_user_mem_free(p, 0, UVPT);
358         /* These need to be free again, since they were allocated with a refcnt. */
359         free_cont_pages(p->procinfo, LOG2_UP(PROCINFO_NUM_PAGES));
360         free_cont_pages(p->procdata, LOG2_UP(PROCDATA_NUM_PAGES));
361
362         env_pagetable_free(p);
363         p->env_pgdir = 0;
364         p->env_cr3 = 0;
365
366         atomic_dec(&num_envs);
367
368         /* Dealloc the struct proc */
369         kmem_cache_free(proc_cache, p);
370 }
371
372 /* Whether or not actor can control target.  Note we currently don't need
373  * locking for this. TODO: think about that, esp wrt proc's dying. */
374 bool proc_controls(struct proc *actor, struct proc *target)
375 {
376         return ((actor == target) || (target->ppid == actor->pid));
377 }
378
379 /* Helper to incref by val.  Using the helper to help debug/interpose on proc
380  * ref counting.  Note that pid2proc doesn't use this interface. */
381 void proc_incref(struct proc *p, unsigned int val)
382 {
383         kref_get(&p->p_kref, val);
384 }
385
386 /* Helper to decref for debugging.  Don't directly kref_put() for now. */
387 void proc_decref(struct proc *p)
388 {
389         kref_put(&p->p_kref);
390 }
391
392 /* Helper, makes p the 'current' process, dropping the old current/cr3.  This no
393  * longer assumes the passed in reference already counted 'current'.  It will
394  * incref internally when needed. */
395 static void __set_proc_current(struct proc *p)
396 {
397         /* We use the pcpui to access 'current' to cut down on the core_id() calls,
398          * though who know how expensive/painful they are. */
399         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
400         /* If the process wasn't here, then we need to load its address space. */
401         if (p != pcpui->cur_proc) {
402                 proc_incref(p, 1);
403                 lcr3(p->env_cr3);
404                 /* This is "leaving the process context" of the previous proc.  The
405                  * previous lcr3 unloaded the previous proc's context.  This should
406                  * rarely happen, since we usually proactively leave process context,
407                  * but this is the fallback. */
408                 if (pcpui->cur_proc)
409                         proc_decref(pcpui->cur_proc);
410                 pcpui->cur_proc = p;
411         }
412 }
413
414 /* Dispatches a _S process to run on the current core.  This should never be
415  * called to "restart" a core.   
416  *
417  * This will always return, regardless of whether or not the calling core is
418  * being given to a process. (it used to pop the tf directly, before we had
419  * cur_tf).
420  *
421  * Since it always returns, it will never "eat" your reference (old
422  * documentation talks about this a bit). */
423 void proc_run_s(struct proc *p)
424 {
425         spin_lock(&p->proc_lock);
426         switch (p->state) {
427                 case (PROC_DYING):
428                         spin_unlock(&p->proc_lock);
429                         printk("Process %d not starting due to async death\n", p->pid);
430                         return;
431                 case (PROC_RUNNABLE_S):
432                         assert(current != p);
433                         __proc_set_state(p, PROC_RUNNING_S);
434                         /* We will want to know where this process is running, even if it is
435                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
436                          * Also, this is the signal used in trap.c to know to save the tf in
437                          * env_tf. */
438                         __seq_start_write(&p->procinfo->coremap_seqctr);
439                         p->procinfo->num_vcores = 0;    /* TODO (VC#) */
440                         /* TODO: For now, we won't count this as an active vcore (on the
441                          * lists).  This gets unmapped in resource.c and yield_s, and needs
442                          * work. */
443                         __map_vcore(p, 0, core_id()); // sort of.  this needs work.
444                         __seq_end_write(&p->procinfo->coremap_seqctr);
445                         /* incref, since we're saving a reference in owning proc */
446                         proc_incref(p, 1);
447                         /* redundant with proc_startcore, might be able to remove that one*/
448                         __set_proc_current(p);
449                         /* We restartcore, instead of startcore, since startcore is a bit
450                          * lower level and we want a chance to process kmsgs before starting
451                          * the process. */
452                         spin_unlock(&p->proc_lock);
453                         disable_irq();          /* before mucking with cur_tf / owning_proc */
454                         /* this is one of the few times cur_tf != &actual_tf */
455                         current_tf = &p->env_tf;        /* no need for irq disable yet */
456                         /* storing the passed in ref of p in owning_proc */
457                         per_cpu_info[core_id()].owning_proc = p;
458                         /* When the calling core idles, it'll call restartcore and run the
459                          * _S process's context. */
460                         return;
461                 default:
462                         spin_unlock(&p->proc_lock);
463                         panic("Invalid process state %p in %s()!!", p->state, __FUNCTION__);
464         }
465 }
466
467 /* Helper: sends preempt messages to all vcores on the bulk preempt list, and
468  * moves them to the inactive list. */
469 static void __send_bulkp_events(struct proc *p)
470 {
471         struct vcore *vc_i, *vc_temp;
472         struct event_msg preempt_msg = {0};
473         /* Send preempt messages for any left on the BP list.  No need to set any
474          * flags, it all was done on the real preempt.  Now we're just telling the
475          * process about any that didn't get restarted and are still preempted. */
476         TAILQ_FOREACH_SAFE(vc_i, &p->bulk_preempted_vcs, list, vc_temp) {
477                 /* Note that if there are no active vcores, send_k_e will post to our
478                  * own vcore, the last of which will be put on the inactive list and be
479                  * the first to be started.  We could have issues with deadlocking,
480                  * since send_k_e() could grab the proclock (if there are no active
481                  * vcores) */
482                 preempt_msg.ev_type = EV_VCORE_PREEMPT;
483                 preempt_msg.ev_arg2 = vcore2vcoreid(p, vc_i);   /* arg2 is 32 bits */
484                 send_kernel_event(p, &preempt_msg, 0);
485                 /* TODO: we may want a TAILQ_CONCAT_HEAD, or something that does that.
486                  * We need a loop for the messages, but not necessarily for the list
487                  * changes.  */
488                 TAILQ_REMOVE(&p->bulk_preempted_vcs, vc_i, list);
489                 TAILQ_INSERT_HEAD(&p->inactive_vcs, vc_i, list);
490         }
491 }
492
493 /* Run an _M.  Can be called safely on one that is already running.  Hold the
494  * lock before calling.  Other than state checks, this just starts up the _M's
495  * vcores, much like the second part of give_cores_running.  More specifically,
496  * give_cores_runnable puts cores on the online list, which this then sends
497  * messages to.  give_cores_running immediately puts them on the list and sends
498  * the message.  the two-step style may go out of fashion soon.
499  *
500  * This expects that the "instructions" for which core(s) to run this on will be
501  * in the vcoremap, which needs to be set externally (give_cores()). */
502 void __proc_run_m(struct proc *p)
503 {
504         struct vcore *vc_i;
505         switch (p->state) {
506                 case (PROC_DYING):
507                         printk("Process %d not starting due to async death\n", p->pid);
508                         return;
509                 case (PROC_RUNNABLE_M):
510                         /* vcoremap[i] holds the coreid of the physical core allocated to
511                          * this process.  It is set outside proc_run.  For the kernel
512                          * message, a0 = struct proc*, a1 = struct trapframe*.   */
513                         if (p->procinfo->num_vcores) {
514                                 __send_bulkp_events(p);
515                                 __proc_set_state(p, PROC_RUNNING_M);
516                                 /* Up the refcnt, to avoid the n refcnt upping on the
517                                  * destination cores.  Keep in sync with __startcore */
518                                 proc_incref(p, p->procinfo->num_vcores * 2);
519                                 /* Send kernel messages to all online vcores (which were added
520                                  * to the list and mapped in __proc_give_cores()), making them
521                                  * turn online */
522                                 TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
523                                         send_kernel_message(vc_i->pcoreid, __startcore, (long)p,
524                                                             0, 0, KMSG_IMMEDIATE);
525                                 }
526                         } else {
527                                 warn("Tried to proc_run() an _M with no vcores!");
528                         }
529                         /* There a subtle race avoidance here (when we unlock after sending
530                          * the message).  __proc_startcore can handle a death message, but
531                          * we can't have the startcore come after the death message.
532                          * Otherwise, it would look like a new process.  So we hold the lock
533                          * til after we send our message, which prevents a possible death
534                          * message.
535                          * - Note there is no guarantee this core's interrupts were on, so
536                          *   it may not get the message for a while... */
537                         return;
538                 case (PROC_RUNNING_M):
539                 case (PROC_WAITING):
540                         return;
541                 default:
542                         /* unlock just so the monitor can call something that might lock*/
543                         spin_unlock(&p->proc_lock);
544                         panic("Invalid process state %p in %s()!!", p->state, __FUNCTION__);
545         }
546 }
547
548 /* Actually runs the given context (trapframe) of process p on the core this
549  * code executes on.  This is called directly by __startcore, which needs to
550  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
551  *
552  * A note on refcnting: this function will not return, and your proc reference
553  * will end up stored in current.  This will make no changes to p's refcnt, so
554  * do your accounting such that there is only the +1 for current.  This means if
555  * it is already in current (like in the trap return path), don't up it.  If
556  * it's already in current and you have another reference (like pid2proc or from
557  * an IPI), then down it (which is what happens in __startcore()).  If it's not
558  * in current and you have one reference, like proc_run(non_current_p), then
559  * also do nothing.  The refcnt for your *p will count for the reference stored
560  * in current. */
561 static void __proc_startcore(struct proc *p, trapframe_t *tf)
562 {
563         assert(!irq_is_enabled());
564         __set_proc_current(p);
565         /* need to load our silly state, preferably somewhere other than here so we
566          * can avoid the case where the context was just running here.  it's not
567          * sufficient to do it in the "new process" if-block above (could be things
568          * like page faults that cause us to keep the same process, but want a
569          * different context.
570          * for now, we load this silly state here. (TODO) (HSS)
571          * We also need this to be per trapframe, and not per process...
572          * For now / OSDI, only load it when in _S mode.  _M mode was handled in
573          * __startcore.  */
574         if (p->state == PROC_RUNNING_S)
575                 env_pop_ancillary_state(p);
576         /* Clear the current_tf, since it is no longer used */
577         current_tf = 0; /* TODO: might not need this... */
578         env_pop_tf(tf);
579 }
580
581 /* Restarts/runs the current_tf, which must be for the current process, on the
582  * core this code executes on.  Calls an internal function to do the work.
583  *
584  * In case there are pending routine messages, like __death, __preempt, or
585  * __notify, we need to run them.  Alternatively, if there are any, we could
586  * self_ipi, and run the messages immediately after popping back to userspace,
587  * but that would have crappy overhead.
588  *
589  * Refcnting: this will not return, and it assumes that you've accounted for
590  * your reference as if it was the ref for "current" (which is what happens when
591  * returning from local traps and such. */
592 void proc_restartcore(void)
593 {
594         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
595         assert(!pcpui->cur_sysc);
596         /* Try and get any interrupts before we pop back to userspace.  If we didn't
597          * do this, we'd just get them in userspace, but this might save us some
598          * effort/overhead. */
599         enable_irq();
600         /* Need ints disabled when we return from processing (race on missing
601          * messages/IPIs) */
602         disable_irq();
603         process_routine_kmsg(pcpui->cur_tf);
604         /* If there is no owning process, just idle, since we don't know what to do.
605          * This could be because the process had been restarted a long time ago and
606          * has since left the core, or due to a KMSG like __preempt or __death. */
607         if (!pcpui->owning_proc) {
608                 abandon_core();
609                 smp_idle();
610         }
611         assert(pcpui->cur_tf);
612         __proc_startcore(pcpui->owning_proc, pcpui->cur_tf);
613 }
614
615 /*
616  * Destroys the given process.  This may be called from another process, a light
617  * kernel thread (no real process context), asynchronously/cross-core, or from
618  * the process on its own core.
619  *
620  * Here's the way process death works:
621  * 0. grab the lock (protects state transition and core map)
622  * 1. set state to dying.  that keeps the kernel from doing anything for the
623  * process (like proc_running it).
624  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
625  * 3. IPI to clean up those cores (decref, etc).
626  * 4. Unlock
627  * 5. Clean up your core, if applicable
628  * (Last core/kernel thread to decref cleans up and deallocates resources.)
629  *
630  * Note that some cores can be processing async calls, but will eventually
631  * decref.  Should think about this more, like some sort of callback/revocation.
632  *
633  * This function will now always return (it used to not return if the calling
634  * core was dying).  However, when it returns, a kernel message will eventually
635  * come in, making you abandon_core, as if you weren't running.  It may be that
636  * the only reference to p is the one you passed in, and when you decref, it'll
637  * get __proc_free()d. */
638 void proc_destroy(struct proc *p)
639 {
640         spin_lock(&p->proc_lock);
641         switch (p->state) {
642                 case PROC_DYING: // someone else killed this already.
643                         spin_unlock(&p->proc_lock);
644                         return;
645                 case PROC_RUNNABLE_M:
646                         /* Need to reclaim any cores this proc might have, even though it's
647                          * not running yet. */
648                         __proc_take_allcores_dumb(p, FALSE);
649                         // fallthrough
650                 case PROC_RUNNABLE_S:
651                         /* might need to pull from lists, though i'm currently a fan of the
652                          * model where external refs notice DYING (if it matters to them)
653                          * and decref when they are done.  the ksched will notice the proc
654                          * is dying and handle it accordingly (which delay the reaping til
655                          * the next call to schedule()) */
656                         break;
657                 case PROC_RUNNING_S:
658                         #if 0
659                         // here's how to do it manually
660                         if (current == p) {
661                                 lcr3(boot_cr3);
662                                 proc_decref(p);         /* this decref is for the cr3 */
663                                 current = NULL;
664                         }
665                         #endif
666                         send_kernel_message(get_pcoreid(p, 0), __death, 0, 0, 0,
667                                             KMSG_IMMEDIATE);
668                         __seq_start_write(&p->procinfo->coremap_seqctr);
669                         // TODO: might need to sort num_vcores too later (VC#)
670                         /* vcore is unmapped on the receive side */
671                         __seq_end_write(&p->procinfo->coremap_seqctr);
672                         #if 0
673                         /* right now, RUNNING_S only runs on a mgmt core (0), not cores
674                          * managed by the idlecoremap.  so don't do this yet. */
675                         put_idle_core(get_pcoreid(p, 0));
676                         #endif
677                         break;
678                 case PROC_RUNNING_M:
679                         /* Send the DEATH message to every core running this process, and
680                          * deallocate the cores.
681                          * The rule is that the vcoremap is set before proc_run, and reset
682                          * within proc_destroy */
683                         __proc_take_allcores_dumb(p, FALSE);
684                         break;
685                 case PROC_CREATED:
686                         break;
687                 default:
688                         panic("Weird state(%s) in %s()", procstate2str(p->state),
689                               __FUNCTION__);
690         }
691         __proc_set_state(p, PROC_DYING);
692         /* This prevents processes from accessing their old files while dying, and
693          * will help if these files (or similar objects in the future) hold
694          * references to p (preventing a __proc_free()). */
695         close_all_files(&p->open_files, FALSE);
696         /* This decref is for the process's existence. */
697         proc_decref(p);
698         /* Unlock.  A death IPI should be on its way, either from the RUNNING_S one,
699          * or from proc_take_cores with a __death.  in general, interrupts should be
700          * on when you call proc_destroy locally, but currently aren't for all
701          * things (like traphandlers). */
702         spin_unlock(&p->proc_lock);
703         return;
704 }
705
706 /* Turns *p into an MCP.  Needs to be called from a local syscall of a RUNNING_S
707  * process.  Currently, this ignores whether or not you are an _M already.  You
708  * should hold the lock before calling. */
709 void __proc_switch_to_m(struct proc *p)
710 {
711         int8_t state = 0;
712         switch (p->state) {
713                 case (PROC_RUNNING_S):
714                         /* issue with if we're async or not (need to preempt it)
715                          * either of these should trip it. TODO: (ACR) async core req
716                          * TODO: relies on vcore0 being the caller (VC#) */
717                         if ((current != p) || (get_pcoreid(p, 0) != core_id()))
718                                 panic("We don't handle async RUNNING_S core requests yet.");
719                         /* save the tf so userspace can restart it.  Like in __notify,
720                          * this assumes a user tf is the same as a kernel tf.  We save
721                          * it in the preempt slot so that we can also save the silly
722                          * state. */
723                         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
724                         disable_irqsave(&state);        /* protect cur_tf */
725                         /* Note this won't play well with concurrent proc kmsgs, but
726                          * since we're _S and locked, we shouldn't have any. */
727                         assert(current_tf);
728                         /* Copy uthread0's context to the notif slot */
729                         vcpd->notif_tf = *current_tf;
730                         clear_owning_proc(core_id());   /* so we don't restart */
731                         save_fp_state(&vcpd->preempt_anc);
732                         enable_irqsave(&state);
733                         /* Userspace needs to not fuck with notif_disabled before
734                          * transitioning to _M. */
735                         if (vcpd->notif_disabled) {
736                                 printk("[kernel] user bug: notifs disabled for vcore 0\n");
737                                 vcpd->notif_disabled = FALSE;
738                         }
739                         /* in the async case, we'll need to remotely stop and bundle
740                          * vcore0's TF.  this is already done for the sync case (local
741                          * syscall). */
742                         /* this process no longer runs on its old location (which is
743                          * this core, for now, since we don't handle async calls) */
744                         __seq_start_write(&p->procinfo->coremap_seqctr);
745                         // TODO: (VC#) might need to adjust num_vcores
746                         // TODO: (ACR) will need to unmap remotely (receive-side)
747                         __unmap_vcore(p, 0);    /* VC# keep in sync with proc_run_s */
748                         __seq_end_write(&p->procinfo->coremap_seqctr);
749                         /* change to runnable_m (it's TF is already saved) */
750                         __proc_set_state(p, PROC_RUNNABLE_M);
751                         p->procinfo->is_mcp = TRUE;
752                         break;
753                 case (PROC_RUNNABLE_S):
754                         /* Issues: being on the runnable_list, proc_set_state not liking
755                          * it, and not clearly thinking through how this would happen.
756                          * Perhaps an async call that gets serviced after you're
757                          * descheduled? */
758                         panic("Not supporting RUNNABLE_S -> RUNNABLE_M yet.\n");
759                         break;
760                 case (PROC_DYING):
761                         warn("Dying, core request coming from %d\n", core_id());
762                 default:
763                         break;
764         }
765 }
766
767 /* Old code to turn a RUNNING_M to a RUNNING_S, with the calling context
768  * becoming the new 'thread0'.  Don't use this. */
769 void __proc_switch_to_s(struct proc *p)
770 {
771         int8_t state = 0;
772         printk("[kernel] trying to transition _M -> _S (deprecated)!\n");
773         assert(p->state == PROC_RUNNING_M); // TODO: (ACR) async core req
774         /* save the context, to be restarted in _S mode */
775         disable_irqsave(&state);        /* protect cur_tf */
776         assert(current_tf);
777         p->env_tf = *current_tf;
778         clear_owning_proc(core_id());   /* so we don't restart */
779         enable_irqsave(&state);
780         env_push_ancillary_state(p); // TODO: (HSS)
781         /* sending death, since it's not our job to save contexts or anything in
782          * this case.  also, if this returns true, we will not return down
783          * below, and need to eat the reference to p */
784         __proc_take_allcores_dumb(p, FALSE);
785         __proc_set_state(p, PROC_RUNNABLE_S);
786 }
787
788 /* Helper function.  Is the given pcore a mapped vcore?  No locking involved, be
789  * careful. */
790 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
791 {
792         return p->procinfo->pcoremap[pcoreid].valid;
793 }
794
795 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
796  * No locking involved, be careful.  Panics on failure. */
797 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid)
798 {
799         assert(is_mapped_vcore(p, pcoreid));
800         return p->procinfo->pcoremap[pcoreid].vcoreid;
801 }
802
803 /* Helper function.  Try to find the pcoreid for a given virtual core id for
804  * proc p.  No locking involved, be careful.  Use this when you can tolerate a
805  * stale or otherwise 'wrong' answer. */
806 static uint32_t try_get_pcoreid(struct proc *p, uint32_t vcoreid)
807 {
808         return p->procinfo->vcoremap[vcoreid].pcoreid;
809 }
810
811 /* Helper function.  Find the pcoreid for a given virtual core id for proc p.
812  * No locking involved, be careful.  Panics on failure. */
813 static uint32_t get_pcoreid(struct proc *p, uint32_t vcoreid)
814 {
815         assert(vcore_is_mapped(p, vcoreid));
816         return try_get_pcoreid(p, vcoreid);
817 }
818
819 /* Helper function: yields / wraps up current_tf and schedules the _S */
820 void __proc_yield_s(struct proc *p, struct trapframe *tf)
821 {
822         assert(p->state == PROC_RUNNING_S);
823         p->env_tf= *tf;
824         env_push_ancillary_state(p);                    /* TODO: (HSS) */
825         __unmap_vcore(p, 0);    /* VC# keep in sync with proc_run_s */
826         __proc_set_state(p, PROC_RUNNABLE_S);
827         schedule_scp(p);
828 }
829
830 /* Yields the calling core.  Must be called locally (not async) for now.
831  * - If RUNNING_S, you just give up your time slice and will eventually return.
832  * - If RUNNING_M, you give up the current vcore (which never returns), and
833  *   adjust the amount of cores wanted/granted.
834  * - If you have only one vcore, you switch to RUNNABLE_M.  When you run again,
835  *   you'll have one guaranteed core, starting from the entry point.
836  *
837  * If the call is being nice, it means that it is in response to a preemption
838  * (which needs to be checked).  If there is no preemption pending, just return.
839  * No matter what, don't adjust the number of cores wanted.
840  *
841  * This usually does not return (smp_idle()), so it will eat your reference.
842  * Also note that it needs a non-current/edible reference, since it will abandon
843  * and continue to use the *p (current == 0, no cr3, etc).
844  *
845  * We disable interrupts for most of it too, since we need to protect current_tf
846  * and not race with __notify (which doesn't play well with concurrent
847  * yielders). */
848 void proc_yield(struct proc *SAFE p, bool being_nice)
849 {
850         uint32_t vcoreid, pcoreid = core_id();
851         struct vcore *vc;
852         struct preempt_data *vcpd;
853         int8_t state = 0;
854         /* Need to disable before even reading vcoreid, since we could be unmapped
855          * by a __preempt or __death.  _S also needs ints disabled, so we'll just do
856          * it immediately. */
857         disable_irqsave(&state);
858         /* Need to lock before checking the vcoremap to find out who we are, in case
859          * we're getting __preempted and __startcored, from a remote core (in which
860          * case we might have come in thinking we were vcore X, but had X preempted
861          * and Y restarted on this pcore, and we suddenly are the wrong vcore
862          * yielding).  Arguably, this is incredibly rare, since you'd need to
863          * preempt the core, then decide to give it back with another grant in
864          * between. */
865         spin_lock(&p->proc_lock); /* horrible scalability.  =( */
866         switch (p->state) {
867                 case (PROC_RUNNING_S):
868                         __proc_yield_s(p, current_tf);  /* current_tf 0'd in abandon core */
869                         goto out_yield_core;
870                 case (PROC_RUNNING_M):
871                         break;                          /* will handle this stuff below */
872                 case (PROC_DYING):              /* incoming __death */
873                 case (PROC_RUNNABLE_M): /* incoming (bulk) preempt/myield TODO:(BULK) */
874                         goto out_failed;
875                 default:
876                         panic("Weird state(%s) in %s()", procstate2str(p->state),
877                               __FUNCTION__);
878         }
879         /* If we're already unmapped (__preempt or a __death hit us), bail out.
880          * Note that if a __death hit us, we should have bailed when we saw
881          * PROC_DYING. */
882         if (!is_mapped_vcore(p, pcoreid))
883                 goto out_failed;
884         vcoreid = get_vcoreid(p, pcoreid);
885         vc = vcoreid2vcore(p, vcoreid);
886         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
887         /* no reason to be nice, return */
888         if (being_nice && !vc->preempt_pending)
889                 goto out_failed;
890         /* Fate is sealed, return and take the preempt message when we enable_irqs.
891          * Note this keeps us from mucking with our lists, since we were already
892          * removed from the online_list.  We have a similar concern with __death,
893          * but we check for DYING to handle that. */
894         if (vc->preempt_served)
895                 goto out_failed;
896         /* At this point, AFAIK there should be no preempt/death messages on the
897          * way, and we're on the online list.  So we'll go ahead and do the yielding
898          * business. */
899         /* no need to preempt later, since we are yielding (nice or otherwise) */
900         if (vc->preempt_pending)
901                 vc->preempt_pending = 0;
902         /* Don't let them yield if they are missing a notification.  Userspace must
903          * not leave vcore context without dealing with notif_pending.  pop_ros_tf()
904          * handles leaving via uthread context.  This handles leaving via a yield.
905          *
906          * This early check is an optimization.  The real check is below when it
907          * works with the online_vcs list (syncing with event.c and INDIR/IPI
908          * posting). */
909         if (vcpd->notif_pending)
910                 goto out_failed;
911         /* Now we'll actually try to yield */
912         printd("[K] Process %d (%p) is yielding on vcore %d\n", p->pid, p,
913                get_vcoreid(p, coreid));
914         /* Remove from the online list, add to the yielded list, and unmap
915          * the vcore, which gives up the core. */
916         TAILQ_REMOVE(&p->online_vcs, vc, list);
917         /* Now that we're off the online list, check to see if an alert made
918          * it through (event.c sets this) */
919         wrmb(); /* prev write must hit before reading notif_pending */
920         /* Note we need interrupts disabled, since a __notify can come in
921          * and set pending to FALSE */
922         if (vcpd->notif_pending) {
923                 /* We lost, put it back on the list and abort the yield */
924                 TAILQ_INSERT_TAIL(&p->online_vcs, vc, list); /* could go HEAD */
925                 goto out_failed;
926         }
927         /* We won the race with event sending, we can safely yield */
928         TAILQ_INSERT_HEAD(&p->inactive_vcs, vc, list);
929         /* Note this protects stuff userspace should look at, which doesn't
930          * include the TAILQs. */
931         __seq_start_write(&p->procinfo->coremap_seqctr);
932         /* Next time the vcore starts, it starts fresh */
933         vcpd->notif_disabled = FALSE;
934         __unmap_vcore(p, vcoreid);
935         /* Adjust implied resource desires */
936         p->resources[RES_CORES].amt_granted = --(p->procinfo->num_vcores);
937         __seq_end_write(&p->procinfo->coremap_seqctr);
938         /* Hand the now-idle core to the ksched */
939         put_idle_core(pcoreid);
940         /* No more vcores?  Then we wait on an event */
941         if (p->procinfo->num_vcores == 0) {
942                 /* consider a ksched op to tell it about us WAITING */
943                 __proc_set_state(p, PROC_WAITING);
944         }
945         goto out_yield_core;
946 out_failed:
947         /* for some reason we just want to return, either to take a KMSG that cleans
948          * us up, or because we shouldn't yield (ex: notif_pending). */
949         spin_unlock(&p->proc_lock);
950         enable_irqsave(&state);
951         return;
952 out_yield_core:                 /* successfully yielded the core */
953         spin_unlock(&p->proc_lock);
954         proc_decref(p);                 /* need to eat the ref passed in */
955         /* Clean up the core and idle.  Need to do this before enabling interrupts,
956          * since once we put_idle_core() and unlock, we could get a startcore. */
957         clear_owning_proc(pcoreid);     /* so we don't restart */
958         abandon_core();
959         smp_idle();                             /* will reenable interrupts */
960 }
961
962 /* Sends a notification (aka active notification, aka IPI) to p's vcore.  We
963  * only send a notification if one they are enabled.  There's a bunch of weird
964  * cases with this, and how pending / enabled are signals between the user and
965  * kernel - check the documentation.  Note that pending is more about messages.
966  * The process needs to be in vcore_context, and the reason is usually a
967  * message.  We set pending here in case we were called to prod them into vcore
968  * context (like via a sys_self_notify. */
969 void proc_notify(struct proc *p, uint32_t vcoreid)
970 {
971         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
972         vcpd->notif_pending = TRUE;
973         wrmb(); /* must write notif_pending before reading notif_disabled */
974         if (!vcpd->notif_disabled) {
975                 /* GIANT WARNING: we aren't using the proc-lock to protect the
976                  * vcoremap.  We want to be able to use this from interrupt context,
977                  * and don't want the proc_lock to be an irqsave.  Spurious
978                  * __notify() kmsgs are okay (it checks to see if the right receiver
979                  * is current). */
980                 if ((p->state & PROC_RUNNING_M) && // TODO: (VC#) (_S state)
981                               vcore_is_mapped(p, vcoreid)) {
982                         printd("[kernel] sending notif to vcore %d\n", vcoreid);
983                         /* This use of try_get_pcoreid is racy, might be unmapped */
984                         send_kernel_message(try_get_pcoreid(p, vcoreid), __notify, (long)p,
985                                             0, 0, KMSG_IMMEDIATE);
986                 }
987         }
988 }
989
990 /* Hold the lock before calling this.  If the process is WAITING, it will wake
991  * it up and schedule it. */
992 void __proc_wakeup(struct proc *p)
993 {
994         if (p->state != PROC_WAITING)
995                 return;
996         if (__proc_is_mcp(p)) {
997                 /* Need to make sure they want at least 1 vcore, so the ksched gives
998                  * them something.  Might do this via short handler later. */
999                 if (!p->resources[RES_CORES].amt_wanted)
1000                         p->resources[RES_CORES].amt_wanted = 1;
1001                 __proc_set_state(p, PROC_RUNNABLE_M);
1002         } else {
1003                 printk("[kernel] FYI, waking up an _S proc\n");
1004                 __proc_set_state(p, PROC_RUNNABLE_S);
1005                 schedule_scp(p);
1006         }
1007 }
1008
1009 /* Is the process in multi_mode / is an MCP or not?  */
1010 bool __proc_is_mcp(struct proc *p)
1011 {
1012         /* in lieu of using the amount of cores requested, or having a bunch of
1013          * states (like PROC_WAITING_M and _S), I'll just track it with a bool. */
1014         return p->procinfo->is_mcp;
1015 }
1016
1017 /************************  Preemption Functions  ******************************
1018  * Don't rely on these much - I'll be sure to change them up a bit.
1019  *
1020  * Careful about what takes a vcoreid and what takes a pcoreid.  Also, there may
1021  * be weird glitches with setting the state to RUNNABLE_M.  It is somewhat in
1022  * flux.  The num_vcores is changed after take_cores, but some of the messages
1023  * (or local traps) may not yet be ready to handle seeing their future state.
1024  * But they should be, so fix those when they pop up.
1025  *
1026  * Another thing to do would be to make the _core functions take a pcorelist,
1027  * and not just one pcoreid. */
1028
1029 /* Sets a preempt_pending warning for p's vcore, to go off 'when'.  If you care
1030  * about locking, do it before calling.  Takes a vcoreid! */
1031 void __proc_preempt_warn(struct proc *p, uint32_t vcoreid, uint64_t when)
1032 {
1033         struct event_msg local_msg = {0};
1034         /* danger with doing this unlocked: preempt_pending is set, but never 0'd,
1035          * since it is unmapped and not dealt with (TODO)*/
1036         p->procinfo->vcoremap[vcoreid].preempt_pending = when;
1037
1038         /* Send the event (which internally checks to see how they want it) */
1039         local_msg.ev_type = EV_PREEMPT_PENDING;
1040         local_msg.ev_arg1 = vcoreid;
1041         send_kernel_event(p, &local_msg, vcoreid);
1042
1043         /* TODO: consider putting in some lookup place for the alarm to find it.
1044          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1045 }
1046
1047 /* Warns all active vcores of an impending preemption.  Hold the lock if you
1048  * care about the mapping (and you should). */
1049 void __proc_preempt_warnall(struct proc *p, uint64_t when)
1050 {
1051         struct vcore *vc_i;
1052         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1053                 __proc_preempt_warn(p, vcore2vcoreid(p, vc_i), when);
1054         /* TODO: consider putting in some lookup place for the alarm to find it.
1055          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1056 }
1057
1058 // TODO: function to set an alarm, if none is outstanding
1059
1060 /* Raw function to preempt a single core.  If you care about locking, do it
1061  * before calling. */
1062 void __proc_preempt_core(struct proc *p, uint32_t pcoreid)
1063 {
1064         uint32_t vcoreid = get_vcoreid(p, pcoreid);
1065         struct event_msg preempt_msg = {0};
1066         p->procinfo->vcoremap[vcoreid].preempt_served = TRUE;
1067         // expects a pcorelist.  assumes pcore is mapped and running_m
1068         __proc_take_corelist(p, &pcoreid, 1, TRUE);
1069         /* Send a message about the preemption. */
1070         preempt_msg.ev_type = EV_VCORE_PREEMPT;
1071         preempt_msg.ev_arg2 = vcoreid;
1072         send_kernel_event(p, &preempt_msg, 0);
1073 }
1074
1075 /* Raw function to preempt every vcore.  If you care about locking, do it before
1076  * calling. */
1077 void __proc_preempt_all(struct proc *p)
1078 {
1079         /* instead of doing this, we could just preempt_served all possible vcores,
1080          * and not just the active ones.  We would need to sort out a way to deal
1081          * with stale preempt_serveds first.  This might be just as fast anyways. */
1082         struct vcore *vc_i;
1083         /* TODO:(BULK) PREEMPT - don't bother with this, set a proc wide flag, or
1084          * just make us RUNNABLE_M. */
1085         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1086                 vc_i->preempt_served = TRUE;
1087         __proc_take_allcores_dumb(p, TRUE);
1088 }
1089
1090 /* Warns and preempts a vcore from p.  No delaying / alarming, or anything.  The
1091  * warning will be for u usec from now. */
1092 void proc_preempt_core(struct proc *p, uint32_t pcoreid, uint64_t usec)
1093 {
1094         uint64_t warn_time = read_tsc() + usec2tsc(usec);
1095
1096         /* DYING could be okay */
1097         if (p->state != PROC_RUNNING_M) {
1098                 warn("Tried to preempt from a non RUNNING_M proc!");
1099                 return;
1100         }
1101         spin_lock(&p->proc_lock);
1102         if (is_mapped_vcore(p, pcoreid)) {
1103                 __proc_preempt_warn(p, get_vcoreid(p, pcoreid), warn_time);
1104                 __proc_preempt_core(p, pcoreid);
1105                 put_idle_core(pcoreid);
1106         } else {
1107                 warn("Pcore doesn't belong to the process!!");
1108         }
1109         if (!p->procinfo->num_vcores) {
1110                 __proc_set_state(p, PROC_RUNNABLE_M);
1111         }
1112         spin_unlock(&p->proc_lock);
1113 }
1114
1115 /* Warns and preempts all from p.  No delaying / alarming, or anything.  The
1116  * warning will be for u usec from now. */
1117 void proc_preempt_all(struct proc *p, uint64_t usec)
1118 {
1119         uint64_t warn_time = read_tsc() + usec2tsc(usec);
1120
1121         spin_lock(&p->proc_lock);
1122         /* DYING could be okay */
1123         if (p->state != PROC_RUNNING_M) {
1124                 warn("Tried to preempt from a non RUNNING_M proc!");
1125                 spin_unlock(&p->proc_lock);
1126                 return;
1127         }
1128         __proc_preempt_warnall(p, warn_time);
1129         __proc_preempt_all(p);
1130         assert(!p->procinfo->num_vcores);
1131         __proc_set_state(p, PROC_RUNNABLE_M);
1132         spin_unlock(&p->proc_lock);
1133 }
1134
1135 /* Give the specific pcore to proc p.  Lots of assumptions, so don't really use
1136  * this.  The proc needs to be _M and prepared for it.  the pcore needs to be
1137  * free, etc. */
1138 void proc_give(struct proc *p, uint32_t pcoreid)
1139 {
1140         warn("Your idlecoremap is now screwed up");     /* TODO (IDLE) */
1141         spin_lock(&p->proc_lock);
1142         // expects a pcorelist, we give it a list of one
1143         __proc_give_cores(p, &pcoreid, 1);
1144         spin_unlock(&p->proc_lock);
1145 }
1146
1147 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
1148  * out). */
1149 uint32_t proc_get_vcoreid(struct proc *SAFE p, uint32_t pcoreid)
1150 {
1151         uint32_t vcoreid;
1152         // TODO: the code currently doesn't track the vcoreid properly for _S (VC#)
1153         spin_lock(&p->proc_lock);
1154         switch (p->state) {
1155                 case PROC_RUNNING_S:
1156                         spin_unlock(&p->proc_lock);
1157                         return 0; // TODO: here's the ugly part
1158                 case PROC_RUNNING_M:
1159                         vcoreid = get_vcoreid(p, pcoreid);
1160                         spin_unlock(&p->proc_lock);
1161                         return vcoreid;
1162                 case PROC_DYING: // death message is on the way
1163                         spin_unlock(&p->proc_lock);
1164                         return 0;
1165                 default:
1166                         spin_unlock(&p->proc_lock);
1167                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1168                               __FUNCTION__);
1169         }
1170 }
1171
1172 /* TODO: make all of these static inlines when we gut the env crap */
1173 bool vcore_is_mapped(struct proc *p, uint32_t vcoreid)
1174 {
1175         return p->procinfo->vcoremap[vcoreid].valid;
1176 }
1177
1178 /* Can do this, or just create a new field and save it in the vcoremap */
1179 uint32_t vcore2vcoreid(struct proc *p, struct vcore *vc)
1180 {
1181         return (vc - p->procinfo->vcoremap);
1182 }
1183
1184 struct vcore *vcoreid2vcore(struct proc *p, uint32_t vcoreid)
1185 {
1186         return &p->procinfo->vcoremap[vcoreid];
1187 }
1188
1189 /********** Core granting (bulk and single) ***********/
1190
1191 /* Helper: gives pcore to the process, mapping it to the next available vcore
1192  * from list vc_list.  Returns TRUE if we succeeded (non-empty). */
1193 static bool __proc_give_a_pcore(struct proc *p, uint32_t pcore,
1194                                 struct vcore_tailq *vc_list)
1195 {
1196         struct vcore *new_vc;
1197         new_vc = TAILQ_FIRST(vc_list);
1198         if (!new_vc)
1199                 return FALSE;
1200         printd("setting vcore %d to pcore %d\n", vcore2vcoreid(p, new_vc),
1201                pcorelist[i]);
1202         TAILQ_REMOVE(vc_list, new_vc, list);
1203         TAILQ_INSERT_TAIL(&p->online_vcs, new_vc, list);
1204         __map_vcore(p, vcore2vcoreid(p, new_vc), pcore);
1205         return TRUE;
1206 }
1207
1208 static void __proc_give_cores_runnable(struct proc *p, uint32_t *pc_arr,
1209                                        uint32_t num)
1210 {
1211         assert(p->state == PROC_RUNNABLE_M);
1212         assert(num);    /* catch bugs */
1213         /* add new items to the vcoremap */
1214         __seq_start_write(&p->procinfo->coremap_seqctr);/* unncessary if offline */
1215         p->procinfo->num_vcores += num;
1216         for (int i = 0; i < num; i++) {
1217                 /* Try from the bulk list first */
1218                 if (__proc_give_a_pcore(p, pc_arr[i], &p->bulk_preempted_vcs))
1219                         continue;
1220                 /* o/w, try from the inactive list.  at one point, i thought there might
1221                  * be a legit way in which the inactive list could be empty, but that i
1222                  * wanted to catch it via an assert. */
1223                 assert(__proc_give_a_pcore(p, pc_arr[i], &p->inactive_vcs));
1224         }
1225         __seq_end_write(&p->procinfo->coremap_seqctr);
1226 }
1227
1228 static void __proc_give_cores_running(struct proc *p, uint32_t *pc_arr,
1229                                       uint32_t num)
1230 {
1231         /* Up the refcnt, since num cores are going to start using this
1232          * process and have it loaded in their owning_proc and 'current'. */
1233         proc_incref(p, num * 2);        /* keep in sync with __startcore */
1234         __seq_start_write(&p->procinfo->coremap_seqctr);
1235         p->procinfo->num_vcores += num;
1236         assert(TAILQ_EMPTY(&p->bulk_preempted_vcs));
1237         for (int i = 0; i < num; i++) {
1238                 assert(__proc_give_a_pcore(p, pc_arr[i], &p->inactive_vcs));
1239                 send_kernel_message(pc_arr[i], __startcore, (long)p, 0, 0,
1240                                     KMSG_IMMEDIATE);
1241         }
1242         __seq_end_write(&p->procinfo->coremap_seqctr);
1243 }
1244
1245 /* Gives process p the additional num cores listed in pcorelist.  You must be
1246  * RUNNABLE_M or RUNNING_M before calling this.  If you're RUNNING_M, this will
1247  * startup your new cores at the entry point with their virtual IDs (or restore
1248  * a preemption).  If you're RUNNABLE_M, you should call __proc_run_m after this
1249  * so that the process can start to use its cores.
1250  *
1251  * If you're *_S, make sure your core0's TF is set (which is done when coming in
1252  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
1253  * Then call __proc_run_m().
1254  *
1255  * The reason I didn't bring the _S cases from core_request over here is so we
1256  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
1257  * this is called from another core, and to avoid the _S -> _M transition.
1258  *
1259  * WARNING: You must hold the proc_lock before calling this! */
1260 void __proc_give_cores(struct proc *p, uint32_t *pc_arr, uint32_t num)
1261 {
1262         /* should never happen: */
1263         assert(num + p->procinfo->num_vcores <= MAX_NUM_CPUS);
1264         switch (p->state) {
1265                 case (PROC_RUNNABLE_S):
1266                 case (PROC_RUNNING_S):
1267                         panic("Don't give cores to a process in a *_S state!\n");
1268                         break;
1269                 case (PROC_DYING):
1270                 case (PROC_WAITING):
1271                         /* can't accept, give the cores back to the ksched and return */
1272                         for (int i = 0; i < num; i++)
1273                                 put_idle_core(pc_arr[i]);
1274                         return;
1275                 case (PROC_RUNNABLE_M):
1276                         __proc_give_cores_runnable(p, pc_arr, num);
1277                         break;
1278                 case (PROC_RUNNING_M):
1279                         __proc_give_cores_running(p, pc_arr, num);
1280                         break;
1281                 default:
1282                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1283                               __FUNCTION__);
1284         }
1285         p->resources[RES_CORES].amt_granted += num;
1286 }
1287
1288 /********** Core revocation (bulk and single) ***********/
1289
1290 /* Revokes a single vcore from a process (unmaps or sends a KMSG to unmap). */
1291 static void __proc_revoke_core(struct proc *p, uint32_t vcoreid, bool preempt)
1292 {
1293         uint32_t pcoreid = get_pcoreid(p, vcoreid);
1294         struct preempt_data *vcpd;
1295         if (preempt) {
1296                 /* Lock the vcore's state (necessary for preemption recovery) */
1297                 vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1298                 atomic_or(&vcpd->flags, VC_K_LOCK);
1299                 send_kernel_message(pcoreid, __preempt, (long)p, 0, 0, KMSG_IMMEDIATE);
1300         } else {
1301                 send_kernel_message(pcoreid, __death, 0, 0, 0, KMSG_IMMEDIATE);
1302         }
1303 }
1304
1305 /* Revokes all cores from the process (unmaps or sends a KMSGS). */
1306 static void __proc_revoke_allcores(struct proc *p, bool preempt)
1307 {
1308         struct vcore *vc_i;
1309         /* TODO: if we ever get broadcast messaging, use it here (still need to lock
1310          * the vcores' states for preemption) */
1311         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1312                 __proc_revoke_core(p, vcore2vcoreid(p, vc_i), preempt);
1313 }
1314
1315 /* Might be faster to scan the vcoremap than to walk the list... */
1316 static void __proc_unmap_allcores(struct proc *p)
1317 {
1318         struct vcore *vc_i;
1319         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1320                 __unmap_vcore(p, vcore2vcoreid(p, vc_i));
1321 }
1322
1323 /* Takes (revoke via kmsg or unmap) from process p the num cores listed in
1324  * pc_arr.  Will preempt if 'preempt' is set.  o/w, no state will be saved, etc.
1325  * Don't use this for taking all of a process's cores.
1326  *
1327  * Make sure you hold the lock when you call this. */
1328 void __proc_take_corelist(struct proc *p, uint32_t *pc_arr, uint32_t num,
1329                           bool preempt)
1330 {
1331         struct vcore *vc;
1332         uint32_t vcoreid;
1333         __seq_start_write(&p->procinfo->coremap_seqctr);
1334         for (int i = 0; i < num; i++) {
1335                 vcoreid = get_vcoreid(p, pc_arr[i]);
1336                 /* Sanity check */
1337                 assert(pc_arr[i] == get_pcoreid(p, vcoreid));
1338                 /* Revoke / unmap core */
1339                 if (p->state == PROC_RUNNING_M) {
1340                         __proc_revoke_core(p, vcoreid, preempt);
1341                 } else {
1342                         assert(p->state == PROC_RUNNABLE_M);
1343                         __unmap_vcore(p, vcoreid);
1344                 }
1345                 /* Change lists for the vcore.  Note, the messages are already in flight
1346                  * (or the vcore is already unmapped), if applicable.  The only code
1347                  * that looks at the lists without holding the lock is event code, and
1348                  * it doesn't care if the vcore was unmapped (it handles that) */
1349                 vc = vcoreid2vcore(p, vcoreid);
1350                 TAILQ_REMOVE(&p->online_vcs, vc, list);
1351                 /* even for single preempts, we use the inactive list.  bulk preempt is
1352                  * only used for when we take everything. */
1353                 TAILQ_INSERT_HEAD(&p->inactive_vcs, vc, list);
1354         }
1355         p->procinfo->num_vcores -= num;
1356         __seq_end_write(&p->procinfo->coremap_seqctr);
1357         p->resources[RES_CORES].amt_granted -= num;
1358 }
1359
1360 /* Takes all cores from a process (revoke via kmsg or unmap), putting them on
1361  * the appropriate vcore list, and fills pc_arr with the pcores revoked, and
1362  * returns the number of entries in pc_arr.
1363  *
1364  * Make sure pc_arr is big enough to handle num_vcores().
1365  * Make sure you hold the lock when you call this. */
1366 uint32_t __proc_take_allcores(struct proc *p, uint32_t *pc_arr, bool preempt)
1367 {
1368         struct vcore *vc_i, *vc_temp;
1369         uint32_t num = 0;
1370         __seq_start_write(&p->procinfo->coremap_seqctr);
1371         /* Write out which pcores we're going to take */
1372         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1373                 pc_arr[num++] = vc_i->pcoreid;
1374         /* Revoke if they are running, o/w unmap.  Both of these need the online
1375          * list to not be changed yet. */
1376         if (p->state == PROC_RUNNING_M) {
1377                 __proc_revoke_allcores(p, preempt);
1378         } else {
1379                 assert(p->state == PROC_RUNNABLE_M);
1380                 __proc_unmap_allcores(p);
1381         }
1382         /* Move the vcores from online to the head of the appropriate list */
1383         TAILQ_FOREACH_SAFE(vc_i, &p->online_vcs, list, vc_temp) {
1384                 /* TODO: we may want a TAILQ_CONCAT_HEAD, or something that does that */
1385                 TAILQ_REMOVE(&p->online_vcs, vc_i, list);
1386                 /* Put the cores on the appropriate list */
1387                 if (preempt)
1388                         TAILQ_INSERT_HEAD(&p->bulk_preempted_vcs, vc_i, list);
1389                 else
1390                         TAILQ_INSERT_HEAD(&p->inactive_vcs, vc_i, list);
1391         }
1392         assert(TAILQ_EMPTY(&p->online_vcs));
1393         assert(num == p->procinfo->num_vcores);
1394         p->procinfo->num_vcores = 0;
1395         __seq_end_write(&p->procinfo->coremap_seqctr);
1396         p->resources[RES_CORES].amt_granted = 0;
1397         return num;
1398 }
1399
1400 /* Dumb legacy helper, simply takes all cores and just puts them on the idle
1401  * core map (which belongs in the scheduler.
1402  *
1403  * TODO: no one should call this; the ksched should handle this internally */
1404 void __proc_take_allcores_dumb(struct proc *p, bool preempt)
1405 {
1406         uint32_t num_revoked;
1407         uint32_t pc_arr[p->procinfo->num_vcores];
1408         num_revoked = __proc_take_allcores(p, pc_arr, preempt);
1409         for (int i = 0; i < num_revoked; i++)
1410                 put_idle_core(pc_arr[i]);
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->resources[i].amt_wanted, p->resources[i].amt_granted);
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 }