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