MM populate cleanup
[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 #include <kmalloc.h>
32
33 struct kmem_cache *proc_cache;
34
35 /* Other helpers, implemented later. */
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 static void save_vc_fp_state(struct preempt_data *vcpd);
43 static void restore_vc_fp_state(struct preempt_data *vcpd);
44
45 /* PID management. */
46 #define PID_MAX 32767 // goes from 0 to 32767, with 0 reserved
47 static DECL_BITMASK(pid_bmask, PID_MAX + 1);
48 spinlock_t pid_bmask_lock = SPINLOCK_INITIALIZER;
49 struct hashtable *pid_hash;
50 spinlock_t pid_hash_lock; // initialized in proc_init
51
52 /* Finds the next free entry (zero) entry in the pid_bitmask.  Set means busy.
53  * PID 0 is reserved (in proc_init).  A return value of 0 is a failure (and
54  * you'll also see a warning, for now).  Consider doing this with atomics. */
55 static pid_t get_free_pid(void)
56 {
57         static pid_t next_free_pid = 1;
58         pid_t my_pid = 0;
59
60         spin_lock(&pid_bmask_lock);
61         // atomically (can lock for now, then change to atomic_and_return
62         FOR_CIRC_BUFFER(next_free_pid, PID_MAX + 1, i) {
63                 // always points to the next to test
64                 next_free_pid = (next_free_pid + 1) % (PID_MAX + 1);
65                 if (!GET_BITMASK_BIT(pid_bmask, i)) {
66                         SET_BITMASK_BIT(pid_bmask, i);
67                         my_pid = i;
68                         break;
69                 }
70         }
71         spin_unlock(&pid_bmask_lock);
72         if (!my_pid)
73                 warn("Shazbot!  Unable to find a PID!  You need to deal with this!\n");
74         return my_pid;
75 }
76
77 /* Return a pid to the pid bitmask */
78 static void put_free_pid(pid_t pid)
79 {
80         spin_lock(&pid_bmask_lock);
81         CLR_BITMASK_BIT(pid_bmask, pid);
82         spin_unlock(&pid_bmask_lock);
83 }
84
85 /* While this could be done with just an assignment, this gives us the
86  * opportunity to check for bad transitions.  Might compile these out later, so
87  * we shouldn't rely on them for sanity checking from userspace.  */
88 int __proc_set_state(struct proc *p, uint32_t state)
89 {
90         uint32_t curstate = p->state;
91         /* Valid transitions:
92          * C   -> RBS
93          * C   -> D
94          * RBS -> RGS
95          * RGS -> RBS
96          * RGS -> W
97          * RGM -> W
98          * W   -> RBS
99          * W   -> RGS
100          * W   -> RBM
101          * W   -> D
102          * RGS -> RBM
103          * RBM -> RGM
104          * RGM -> RBM
105          * RGM -> RBS
106          * RGS -> D
107          * RGM -> D
108          *
109          * These ought to be implemented later (allowed, not thought through yet).
110          * RBS -> D
111          * RBM -> D
112          */
113         #if 1 // some sort of correctness flag
114         switch (curstate) {
115                 case PROC_CREATED:
116                         if (!(state & (PROC_RUNNABLE_S | PROC_DYING)))
117                                 panic("Invalid State Transition! PROC_CREATED to %02x", state);
118                         break;
119                 case PROC_RUNNABLE_S:
120                         if (!(state & (PROC_RUNNING_S | PROC_DYING)))
121                                 panic("Invalid State Transition! PROC_RUNNABLE_S to %02x", state);
122                         break;
123                 case PROC_RUNNING_S:
124                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
125                                        PROC_DYING)))
126                                 panic("Invalid State Transition! PROC_RUNNING_S to %02x", state);
127                         break;
128                 case PROC_WAITING:
129                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNING_S | PROC_RUNNABLE_M |
130                                        PROC_DYING)))
131                                 panic("Invalid State Transition! PROC_WAITING to %02x", state);
132                         break;
133                 case PROC_DYING:
134                         if (state != PROC_CREATED) // when it is reused (TODO)
135                                 panic("Invalid State Transition! PROC_DYING to %02x", state);
136                         break;
137                 case PROC_RUNNABLE_M:
138                         if (!(state & (PROC_RUNNING_M | PROC_DYING)))
139                                 panic("Invalid State Transition! PROC_RUNNABLE_M to %02x", state);
140                         break;
141                 case PROC_RUNNING_M:
142                         if (!(state & (PROC_RUNNABLE_S | PROC_RUNNABLE_M | PROC_WAITING |
143                                        PROC_DYING)))
144                                 panic("Invalid State Transition! PROC_RUNNING_M to %02x", state);
145                         break;
146         }
147         #endif
148         p->state = state;
149         return 0;
150 }
151
152 /* Returns a pointer to the proc with the given pid, or 0 if there is none.
153  * This uses get_not_zero, since it is possible the refcnt is 0, which means the
154  * process is dying and we should not have the ref (and thus return 0).  We need
155  * to lock to protect us from getting p, (someone else removes and frees p),
156  * then get_not_zero() on p.
157  * Don't push the locking into the hashtable without dealing with this. */
158 struct proc *pid2proc(pid_t pid)
159 {
160         spin_lock(&pid_hash_lock);
161         struct proc *p = hashtable_search(pid_hash, (void*)(long)pid);
162         if (p)
163                 if (!kref_get_not_zero(&p->p_kref, 1))
164                         p = 0;
165         spin_unlock(&pid_hash_lock);
166         return p;
167 }
168
169 /* Used by devproc for successive reads of the proc table.
170  * Returns a pointer to the nth proc, or 0 if there is none.
171  * This uses get_not_zero, since it is possible the refcnt is 0, which means the
172  * process is dying and we should not have the ref (and thus return 0).  We need
173  * to lock to protect us from getting p, (someone else removes and frees p),
174  * then get_not_zero() on p.
175  * Don't push the locking into the hashtable without dealing with this. */
176 struct proc *pid_nth(unsigned int n)
177 {
178         struct proc *p;
179         spin_lock(&pid_hash_lock);
180         if (!hashtable_count(pid_hash)) {
181                 spin_unlock(&pid_hash_lock);
182                 return NULL;
183         }
184         struct hashtable_itr *iter = hashtable_iterator(pid_hash);
185         p = hashtable_iterator_value(iter);
186
187         while (p) {
188                 /* if this process is not valid, it doesn't count,
189                  * so continue
190                  */
191
192                 if (kref_get_not_zero(&p->p_kref, 1)){
193                         /* this one counts */
194                         if (! n){
195                                 printd("pid_nth: at end, p %p\n", p);
196                                 break;
197                         }
198                         kref_put(&p->p_kref);
199                         n--;
200                 }
201                 if (!hashtable_iterator_advance(iter)){
202                         p = NULL;
203                         break;
204                 }
205                 p = hashtable_iterator_value(iter);
206         }
207
208         spin_unlock(&pid_hash_lock);
209         kfree(iter);
210         return p;
211 }
212
213 /* Performs any initialization related to processes, such as create the proc
214  * cache, prep the scheduler, etc.  When this returns, we should be ready to use
215  * any process related function. */
216 void proc_init(void)
217 {
218         /* Catch issues with the vcoremap and TAILQ_ENTRY sizes */
219         static_assert(sizeof(TAILQ_ENTRY(vcore)) == sizeof(void*) * 2);
220         proc_cache = kmem_cache_create("proc", sizeof(struct proc),
221                      MAX(ARCH_CL_SIZE, __alignof__(struct proc)), 0, 0, 0);
222         /* Init PID mask and hash.  pid 0 is reserved. */
223         SET_BITMASK_BIT(pid_bmask, 0);
224         spinlock_init(&pid_hash_lock);
225         spin_lock(&pid_hash_lock);
226         pid_hash = create_hashtable(100, __generic_hash, __generic_eq);
227         spin_unlock(&pid_hash_lock);
228         schedule_init();
229
230         atomic_init(&num_envs, 0);
231 }
232
233 /* Be sure you init'd the vcore lists before calling this. */
234 static void proc_init_procinfo(struct proc* p)
235 {
236         p->procinfo->pid = p->pid;
237         p->procinfo->ppid = p->ppid;
238         p->procinfo->max_vcores = max_vcores(p);
239         p->procinfo->tsc_freq = system_timing.tsc_freq;
240         p->procinfo->timing_overhead = system_timing.timing_overhead;
241         p->procinfo->heap_bottom = 0;
242         /* 0'ing the arguments.  Some higher function will need to set them */
243         memset(p->procinfo->argp, 0, sizeof(p->procinfo->argp));
244         memset(p->procinfo->argbuf, 0, sizeof(p->procinfo->argbuf));
245         memset(p->procinfo->res_grant, 0, sizeof(p->procinfo->res_grant));
246         /* 0'ing the vcore/pcore map.  Will link the vcores later. */
247         memset(&p->procinfo->vcoremap, 0, sizeof(p->procinfo->vcoremap));
248         memset(&p->procinfo->pcoremap, 0, sizeof(p->procinfo->pcoremap));
249         p->procinfo->num_vcores = 0;
250         p->procinfo->is_mcp = FALSE;
251         p->procinfo->coremap_seqctr = SEQCTR_INITIALIZER;
252         /* For now, we'll go up to the max num_cpus (at runtime).  In the future,
253          * there may be cases where we can have more vcores than num_cpus, but for
254          * now we'll leave it like this. */
255         for (int i = 0; i < num_cpus; i++) {
256                 TAILQ_INSERT_TAIL(&p->inactive_vcs, &p->procinfo->vcoremap[i], list);
257         }
258 }
259
260 static void proc_init_procdata(struct proc *p)
261 {
262         memset(p->procdata, 0, sizeof(struct procdata));
263         /* processes can't go into vc context on vc 0 til they unset this.  This is
264          * for processes that block before initing uthread code (like rtld). */
265         atomic_set(&p->procdata->vcore_preempt_data[0].flags, VC_SCP_NOVCCTX);
266 }
267
268 /* Allocates and initializes a process, with the given parent.  Currently
269  * writes the *p into **pp, and returns 0 on success, < 0 for an error.
270  * Errors include:
271  *  - ENOFREEPID if it can't get a PID
272  *  - ENOMEM on memory exhaustion */
273 error_t proc_alloc(struct proc **pp, struct proc *parent)
274 {
275         error_t r;
276         struct proc *p;
277
278         if (!(p = kmem_cache_alloc(proc_cache, 0)))
279                 return -ENOMEM;
280         /* zero everything by default, other specific items are set below */
281         memset(p, 0, sizeof(struct proc));
282
283         { INITSTRUCT(*p)
284
285         /* only one ref, which we pass back.  the old 'existence' ref is managed by
286          * the ksched */
287         kref_init(&p->p_kref, __proc_free, 1);
288         // Setup the default map of where to get cache colors from
289         p->cache_colors_map = global_cache_colors_map;
290         p->next_cache_color = 0;
291         /* Initialize the address space */
292         if ((r = env_setup_vm(p)) < 0) {
293                 kmem_cache_free(proc_cache, p);
294                 return r;
295         }
296         if (!(p->pid = get_free_pid())) {
297                 kmem_cache_free(proc_cache, p);
298                 return -ENOFREEPID;
299         }
300         /* Set the basic status variables. */
301         spinlock_init(&p->proc_lock);
302         p->exitcode = 1337;     /* so we can see processes killed by the kernel */
303         if (parent) {
304                 p->ppid = parent->pid;
305                 proc_incref(p, 1);      /* storing a ref in the parent */
306                 /* using the CV's lock to protect anything related to child waiting */
307                 cv_lock(&parent->child_wait);
308                 TAILQ_INSERT_TAIL(&parent->children, p, sibling_link);
309                 cv_unlock(&parent->child_wait);
310         } else {
311                 p->ppid = 0;
312         }
313         TAILQ_INIT(&p->children);
314         cv_init(&p->child_wait);
315         p->state = PROC_CREATED; /* shouldn't go through state machine for init */
316         p->env_flags = 0;
317         p->env_entry = 0; // cheating.  this really gets set later
318         p->heap_top = 0;
319         spinlock_init(&p->vmr_lock);
320         spinlock_init(&p->pte_lock);
321         TAILQ_INIT(&p->vm_regions); /* could init this in the slab */
322         p->vmr_history = 0;
323         /* Initialize the vcore lists, we'll build the inactive list so that it
324          * includes all vcores when we initialize procinfo.  Do this before initing
325          * procinfo. */
326         TAILQ_INIT(&p->online_vcs);
327         TAILQ_INIT(&p->bulk_preempted_vcs);
328         TAILQ_INIT(&p->inactive_vcs);
329         /* Init procinfo/procdata.  Procinfo's argp/argb are 0'd */
330         proc_init_procinfo(p);
331         proc_init_procdata(p);
332
333         /* Initialize the generic sysevent ring buffer */
334         SHARED_RING_INIT(&p->procdata->syseventring);
335         /* Initialize the frontend of the sysevent ring buffer */
336         FRONT_RING_INIT(&p->syseventfrontring,
337                         &p->procdata->syseventring,
338                         SYSEVENTRINGSIZE);
339
340         /* Init FS structures TODO: cleanup (might pull this out) */
341         kref_get(&default_ns.kref, 1);
342         p->ns = &default_ns;
343         spinlock_init(&p->fs_env.lock);
344         p->fs_env.umask = parent ? parent->fs_env.umask : S_IWGRP | S_IWOTH;
345         p->fs_env.root = p->ns->root->mnt_root;
346         kref_get(&p->fs_env.root->d_kref, 1);
347         p->fs_env.pwd = parent ? parent->fs_env.pwd : p->fs_env.root;
348         kref_get(&p->fs_env.pwd->d_kref, 1);
349         memset(&p->open_files, 0, sizeof(p->open_files));       /* slightly ghetto */
350         spinlock_init(&p->open_files.lock);
351         p->open_files.max_files = NR_OPEN_FILES_DEFAULT;
352         p->open_files.max_fdset = NR_FILE_DESC_DEFAULT;
353         p->open_files.fd = p->open_files.fd_array;
354         p->open_files.open_fds = (struct fd_set*)&p->open_files.open_fds_init;
355         /* Init the ucq hash lock */
356         p->ucq_hashlock = (struct hashlock*)&p->ucq_hl_noref;
357         hashlock_init_irqsave(p->ucq_hashlock, HASHLOCK_DEFAULT_SZ);
358
359         atomic_inc(&num_envs);
360         frontend_proc_init(p);
361         plan9setup(p, parent);
362         devalarm_init(p);
363         TAILQ_INIT(&p->abortable_sleepers);
364         spinlock_init_irqsave(&p->abort_list_lock);
365         printd("[%08x] new process %08x\n", current ? current->pid : 0, p->pid);
366         } // INIT_STRUCT
367         *pp = p;
368         return 0;
369 }
370
371 /* We have a bunch of different ways to make processes.  Call this once the
372  * process is ready to be used by the rest of the system.  For now, this just
373  * means when it is ready to be named via the pidhash.  In the future, we might
374  * push setting the state to CREATED into here. */
375 void __proc_ready(struct proc *p)
376 {
377         /* Tell the ksched about us.  TODO: do we need to worry about the ksched
378          * doing stuff to us before we're added to the pid_hash? */
379         __sched_proc_register(p);
380         spin_lock(&pid_hash_lock);
381         hashtable_insert(pid_hash, (void*)(long)p->pid, p);
382         spin_unlock(&pid_hash_lock);
383 }
384
385 /* Creates a process from the specified file, argvs, and envps.  Tempted to get
386  * rid of proc_alloc's style, but it is so quaint... */
387 struct proc *proc_create(struct file *prog, char **argv, char **envp)
388 {
389         struct proc *p;
390         error_t r;
391         if ((r = proc_alloc(&p, current)) < 0)
392                 panic("proc_create: %e", r);    /* one of 3 quaint usages of %e */
393         procinfo_pack_args(p->procinfo, argv, envp);
394         assert(load_elf(p, prog) == 0);
395         /* Connect to stdin, stdout, stderr */
396         assert(insert_file(&p->open_files, dev_stdin,  0) == 0);
397         assert(insert_file(&p->open_files, dev_stdout, 0) == 1);
398         assert(insert_file(&p->open_files, dev_stderr, 0) == 2);
399         __proc_ready(p);
400         return p;
401 }
402
403 static int __cb_assert_no_pg(struct proc *p, pte_t *pte, void *va, void *arg)
404 {
405         assert(!*pte);
406         return 0;
407 }
408
409 /* This is called by kref_put(), once the last reference to the process is
410  * gone.  Don't call this otherwise (it will panic).  It will clean up the
411  * address space and deallocate any other used memory. */
412 static void __proc_free(struct kref *kref)
413 {
414         struct proc *p = container_of(kref, struct proc, p_kref);
415         physaddr_t pa;
416
417         printd("[PID %d] freeing proc: %d\n", current ? current->pid : 0, p->pid);
418         // All parts of the kernel should have decref'd before __proc_free is called
419         assert(kref_refcnt(&p->p_kref) == 0);
420         assert(TAILQ_EMPTY(&p->alarmset.list));
421
422         cclose(p->dot);
423         cclose(p->slash);
424         p->dot = p->slash = 0; /* catch bugs */
425         /* can safely free the fgrp, now that no one is accessing it */
426         kfree(p->fgrp->fd);
427         kfree(p->fgrp);
428         kref_put(&p->fs_env.root->d_kref);
429         kref_put(&p->fs_env.pwd->d_kref);
430         /* now we'll finally decref files for the file-backed vmrs */
431         unmap_and_destroy_vmrs(p);
432         frontend_proc_free(p);  /* TODO: please remove me one day */
433         /* Free any colors allocated to this process */
434         if (p->cache_colors_map != global_cache_colors_map) {
435                 for(int i = 0; i < llc_cache->num_colors; i++)
436                         cache_color_free(llc_cache, p->cache_colors_map);
437                 cache_colors_map_free(p->cache_colors_map);
438         }
439         /* Remove us from the pid_hash and give our PID back (in that order). */
440         spin_lock(&pid_hash_lock);
441         if (!hashtable_remove(pid_hash, (void*)(long)p->pid))
442                 panic("Proc not in the pid table in %s", __FUNCTION__);
443         spin_unlock(&pid_hash_lock);
444         put_free_pid(p->pid);
445         /* all memory below UMAPTOP should have been freed via the VMRs.  the stuff
446          * above is the global page and procinfo/procdata */
447         env_user_mem_free(p, (void*)UMAPTOP, UVPT - UMAPTOP); /* 3rd arg = len... */
448         env_user_mem_walk(p, 0, UMAPTOP, __cb_assert_no_pg, 0);
449         /* These need to be freed again, since they were allocated with a refcnt. */
450         free_cont_pages(p->procinfo, LOG2_UP(PROCINFO_NUM_PAGES));
451         free_cont_pages(p->procdata, LOG2_UP(PROCDATA_NUM_PAGES));
452
453         env_pagetable_free(p);
454         p->env_pgdir = 0;
455         p->env_cr3 = 0;
456
457         atomic_dec(&num_envs);
458
459         /* Dealloc the struct proc */
460         kmem_cache_free(proc_cache, p);
461 }
462
463 /* Whether or not actor can control target.  TODO: do something reasonable here.
464  * Just checking for the parent is a bit limiting.  Could walk the parent-child
465  * tree, check user ids, or some combination.  Make sure actors can always
466  * control themselves. */
467 bool proc_controls(struct proc *actor, struct proc *target)
468 {
469         return TRUE;
470         #if 0 /* Example: */
471         return ((actor == target) || (target->ppid == actor->pid));
472         #endif
473 }
474
475 /* Helper to incref by val.  Using the helper to help debug/interpose on proc
476  * ref counting.  Note that pid2proc doesn't use this interface. */
477 void proc_incref(struct proc *p, unsigned int val)
478 {
479         kref_get(&p->p_kref, val);
480 }
481
482 /* Helper to decref for debugging.  Don't directly kref_put() for now. */
483 void proc_decref(struct proc *p)
484 {
485         kref_put(&p->p_kref);
486 }
487
488 /* Helper, makes p the 'current' process, dropping the old current/cr3.  This no
489  * longer assumes the passed in reference already counted 'current'.  It will
490  * incref internally when needed. */
491 static void __set_proc_current(struct proc *p)
492 {
493         /* We use the pcpui to access 'current' to cut down on the core_id() calls,
494          * though who know how expensive/painful they are. */
495         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
496         /* If the process wasn't here, then we need to load its address space. */
497         if (p != pcpui->cur_proc) {
498                 proc_incref(p, 1);
499                 lcr3(p->env_cr3);
500                 /* This is "leaving the process context" of the previous proc.  The
501                  * previous lcr3 unloaded the previous proc's context.  This should
502                  * rarely happen, since we usually proactively leave process context,
503                  * but this is the fallback. */
504                 if (pcpui->cur_proc)
505                         proc_decref(pcpui->cur_proc);
506                 pcpui->cur_proc = p;
507         }
508 }
509
510 /* Flag says if vcore context is not ready, which is set in init_procdata.  The
511  * process must turn off this flag on vcore0 at some point.  It's off by default
512  * on all other vcores. */
513 static bool scp_is_vcctx_ready(struct preempt_data *vcpd)
514 {
515         return !(atomic_read(&vcpd->flags) & VC_SCP_NOVCCTX);
516 }
517
518 /* Dispatches a _S process to run on the current core.  This should never be
519  * called to "restart" a core.   
520  *
521  * This will always return, regardless of whether or not the calling core is
522  * being given to a process. (it used to pop the tf directly, before we had
523  * cur_ctx).
524  *
525  * Since it always returns, it will never "eat" your reference (old
526  * documentation talks about this a bit). */
527 void proc_run_s(struct proc *p)
528 {
529         uint32_t coreid = core_id();
530         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
531         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
532         spin_lock(&p->proc_lock);
533         switch (p->state) {
534                 case (PROC_DYING):
535                         spin_unlock(&p->proc_lock);
536                         printk("[kernel] _S %d not starting due to async death\n", p->pid);
537                         return;
538                 case (PROC_RUNNABLE_S):
539                         __proc_set_state(p, PROC_RUNNING_S);
540                         /* We will want to know where this process is running, even if it is
541                          * only in RUNNING_S.  can use the vcoremap, which makes death easy.
542                          * Also, this is the signal used in trap.c to know to save the tf in
543                          * scp_ctx. */
544                         __seq_start_write(&p->procinfo->coremap_seqctr);
545                         p->procinfo->num_vcores = 0;    /* TODO (VC#) */
546                         /* TODO: For now, we won't count this as an active vcore (on the
547                          * lists).  This gets unmapped in resource.c and yield_s, and needs
548                          * work. */
549                         __map_vcore(p, 0, coreid); /* not treated like a true vcore */
550                         __seq_end_write(&p->procinfo->coremap_seqctr);
551                         /* incref, since we're saving a reference in owning proc later */
552                         proc_incref(p, 1);
553                         /* lock was protecting the state and VC mapping, not pcpui stuff */
554                         spin_unlock(&p->proc_lock);
555                         /* redundant with proc_startcore, might be able to remove that one*/
556                         __set_proc_current(p);
557                         /* set us up as owning_proc.  ksched bug if there is already one,
558                          * for now.  can simply clear_owning if we want to. */
559                         assert(!pcpui->owning_proc);
560                         pcpui->owning_proc = p;
561                         pcpui->owning_vcoreid = 0; /* TODO (VC#) */
562                         restore_vc_fp_state(vcpd);
563                         /* similar to the old __startcore, start them in vcore context if
564                          * they have notifs and aren't already in vcore context.  o/w, start
565                          * them wherever they were before (could be either vc ctx or not) */
566                         if (!vcpd->notif_disabled && vcpd->notif_pending
567                                                   && scp_is_vcctx_ready(vcpd)) {
568                                 vcpd->notif_disabled = TRUE;
569                                 /* save the _S's ctx in the uthread slot, build and pop a new
570                                  * one in actual/cur_ctx. */
571                                 vcpd->uthread_ctx = p->scp_ctx;
572                                 pcpui->cur_ctx = &pcpui->actual_ctx;
573                                 memset(pcpui->cur_ctx, 0, sizeof(struct user_context));
574                                 proc_init_ctx(pcpui->cur_ctx, 0, p->env_entry,
575                                               vcpd->transition_stack, vcpd->vcore_tls_desc);
576                         } else {
577                                 /* If they have no transition stack, then they can't receive
578                                  * events.  The most they are getting is a wakeup from the
579                                  * kernel.  They won't even turn off notif_pending, so we'll do
580                                  * that for them. */
581                                 if (!scp_is_vcctx_ready(vcpd))
582                                         vcpd->notif_pending = FALSE;
583                                 /* this is one of the few times cur_ctx != &actual_ctx */
584                                 pcpui->cur_ctx = &p->scp_ctx;
585                         }
586                         /* When the calling core idles, it'll call restartcore and run the
587                          * _S process's context. */
588                         return;
589                 default:
590                         spin_unlock(&p->proc_lock);
591                         panic("Invalid process state %p in %s()!!", p->state, __FUNCTION__);
592         }
593 }
594
595 /* Helper: sends preempt messages to all vcores on the bulk preempt list, and
596  * moves them to the inactive list. */
597 static void __send_bulkp_events(struct proc *p)
598 {
599         struct vcore *vc_i, *vc_temp;
600         struct event_msg preempt_msg = {0};
601         /* Whenever we send msgs with the proc locked, we need at least 1 online */
602         assert(!TAILQ_EMPTY(&p->online_vcs));
603         /* Send preempt messages for any left on the BP list.  No need to set any
604          * flags, it all was done on the real preempt.  Now we're just telling the
605          * process about any that didn't get restarted and are still preempted. */
606         TAILQ_FOREACH_SAFE(vc_i, &p->bulk_preempted_vcs, list, vc_temp) {
607                 /* Note that if there are no active vcores, send_k_e will post to our
608                  * own vcore, the last of which will be put on the inactive list and be
609                  * the first to be started.  We could have issues with deadlocking,
610                  * since send_k_e() could grab the proclock (if there are no active
611                  * vcores) */
612                 preempt_msg.ev_type = EV_VCORE_PREEMPT;
613                 preempt_msg.ev_arg2 = vcore2vcoreid(p, vc_i);   /* arg2 is 32 bits */
614                 send_kernel_event(p, &preempt_msg, 0);
615                 /* TODO: we may want a TAILQ_CONCAT_HEAD, or something that does that.
616                  * We need a loop for the messages, but not necessarily for the list
617                  * changes.  */
618                 TAILQ_REMOVE(&p->bulk_preempted_vcs, vc_i, list);
619                 TAILQ_INSERT_HEAD(&p->inactive_vcs, vc_i, list);
620         }
621 }
622
623 /* Run an _M.  Can be called safely on one that is already running.  Hold the
624  * lock before calling.  Other than state checks, this just starts up the _M's
625  * vcores, much like the second part of give_cores_running.  More specifically,
626  * give_cores_runnable puts cores on the online list, which this then sends
627  * messages to.  give_cores_running immediately puts them on the list and sends
628  * the message.  the two-step style may go out of fashion soon.
629  *
630  * This expects that the "instructions" for which core(s) to run this on will be
631  * in the vcoremap, which needs to be set externally (give_cores()). */
632 void __proc_run_m(struct proc *p)
633 {
634         struct vcore *vc_i;
635         switch (p->state) {
636                 case (PROC_WAITING):
637                 case (PROC_DYING):
638                         warn("ksched tried to run proc %d in state %s\n", p->pid,
639                              procstate2str(p->state));
640                         return;
641                 case (PROC_RUNNABLE_M):
642                         /* vcoremap[i] holds the coreid of the physical core allocated to
643                          * this process.  It is set outside proc_run. */
644                         if (p->procinfo->num_vcores) {
645                                 __send_bulkp_events(p);
646                                 __proc_set_state(p, PROC_RUNNING_M);
647                                 /* Up the refcnt, to avoid the n refcnt upping on the
648                                  * destination cores.  Keep in sync with __startcore */
649                                 proc_incref(p, p->procinfo->num_vcores * 2);
650                                 /* Send kernel messages to all online vcores (which were added
651                                  * to the list and mapped in __proc_give_cores()), making them
652                                  * turn online */
653                                 TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
654                                         send_kernel_message(vc_i->pcoreid, __startcore, (long)p,
655                                                             (long)vcore2vcoreid(p, vc_i),
656                                                             (long)vc_i->nr_preempts_sent,
657                                                             KMSG_ROUTINE);
658                                 }
659                         } else {
660                                 warn("Tried to proc_run() an _M with no vcores!");
661                         }
662                         /* There a subtle race avoidance here (when we unlock after sending
663                          * the message).  __proc_startcore can handle a death message, but
664                          * we can't have the startcore come after the death message.
665                          * Otherwise, it would look like a new process.  So we hold the lock
666                          * til after we send our message, which prevents a possible death
667                          * message.
668                          * - Note there is no guarantee this core's interrupts were on, so
669                          *   it may not get the message for a while... */
670                         return;
671                 case (PROC_RUNNING_M):
672                         return;
673                 default:
674                         /* unlock just so the monitor can call something that might lock*/
675                         spin_unlock(&p->proc_lock);
676                         panic("Invalid process state %p in %s()!!", p->state, __FUNCTION__);
677         }
678 }
679
680 /* You must disable IRQs and PRKM before calling this.
681  *
682  * Actually runs the given context (trapframe) of process p on the core this
683  * code executes on.  This is called directly by __startcore, which needs to
684  * bypass the routine_kmsg check.  Interrupts should be off when you call this.
685  *
686  * A note on refcnting: this function will not return, and your proc reference
687  * will end up stored in current.  This will make no changes to p's refcnt, so
688  * do your accounting such that there is only the +1 for current.  This means if
689  * it is already in current (like in the trap return path), don't up it.  If
690  * it's already in current and you have another reference (like pid2proc or from
691  * an IPI), then down it (which is what happens in __startcore()).  If it's not
692  * in current and you have one reference, like proc_run(non_current_p), then
693  * also do nothing.  The refcnt for your *p will count for the reference stored
694  * in current. */
695 void __proc_startcore(struct proc *p, struct user_context *ctx)
696 {
697         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
698         assert(!irq_is_enabled());
699         /* Should never have ktask still set.  If we do, future syscalls could try
700          * to block later and lose track of our address space. */
701         assert(!pcpui->cur_kthread->is_ktask);
702         __set_proc_current(p);
703         /* Clear the current_ctx, since it is no longer used */
704         current_ctx = 0;        /* TODO: might not need this... */
705         proc_pop_ctx(ctx);
706 }
707
708 /* Restarts/runs the current_ctx, which must be for the current process, on the
709  * core this code executes on.  Calls an internal function to do the work.
710  *
711  * In case there are pending routine messages, like __death, __preempt, or
712  * __notify, we need to run them.  Alternatively, if there are any, we could
713  * self_ipi, and run the messages immediately after popping back to userspace,
714  * but that would have crappy overhead. */
715 void proc_restartcore(void)
716 {
717         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
718         assert(!pcpui->cur_kthread->sysc);
719         /* TODO: can probably remove this enable_irq.  it was an optimization for
720          * RKMs */
721         /* Try and get any interrupts before we pop back to userspace.  If we didn't
722          * do this, we'd just get them in userspace, but this might save us some
723          * effort/overhead. */
724         enable_irq();
725         /* Need ints disabled when we return from PRKM (race on missing
726          * messages/IPIs) */
727         disable_irq();
728         process_routine_kmsg();
729         /* If there is no owning process, just idle, since we don't know what to do.
730          * This could be because the process had been restarted a long time ago and
731          * has since left the core, or due to a KMSG like __preempt or __death. */
732         if (!pcpui->owning_proc) {
733                 abandon_core();
734                 smp_idle();
735         }
736         assert(pcpui->cur_ctx);
737         __proc_startcore(pcpui->owning_proc, pcpui->cur_ctx);
738 }
739
740 /* Destroys the process.  It will destroy the process and return any cores
741  * to the ksched via the __sched_proc_destroy() CB.
742  *
743  * Here's the way process death works:
744  * 0. grab the lock (protects state transition and core map)
745  * 1. set state to dying.  that keeps the kernel from doing anything for the
746  * process (like proc_running it).
747  * 2. figure out where the process is running (cross-core/async or RUNNING_M)
748  * 3. IPI to clean up those cores (decref, etc).
749  * 4. Unlock
750  * 5. Clean up your core, if applicable
751  * (Last core/kernel thread to decref cleans up and deallocates resources.)
752  *
753  * Note that some cores can be processing async calls, but will eventually
754  * decref.  Should think about this more, like some sort of callback/revocation.
755  *
756  * This function will now always return (it used to not return if the calling
757  * core was dying).  However, when it returns, a kernel message will eventually
758  * come in, making you abandon_core, as if you weren't running.  It may be that
759  * the only reference to p is the one you passed in, and when you decref, it'll
760  * get __proc_free()d. */
761 void proc_destroy(struct proc *p)
762 {
763         uint32_t nr_cores_revoked = 0;
764         struct kthread *sleeper;
765         struct proc *child_i, *temp;
766         /* Can't spin on the proc lock with irq disabled.  This is a problem for all
767          * places where we grab the lock, but it is particularly bad for destroy,
768          * since we tend to call this from trap and irq handlers */
769         assert(irq_is_enabled());
770         spin_lock(&p->proc_lock);
771         /* storage for pc_arr is alloced at decl, which is after grabbing the lock*/
772         uint32_t pc_arr[p->procinfo->num_vcores];
773         switch (p->state) {
774                 case PROC_DYING: /* someone else killed this already. */
775                         spin_unlock(&p->proc_lock);
776                         return;
777                 case PROC_CREATED:
778                 case PROC_RUNNABLE_S:
779                 case PROC_WAITING:
780                         break;
781                 case PROC_RUNNABLE_M:
782                 case PROC_RUNNING_M:
783                         /* Need to reclaim any cores this proc might have, even if it's not
784                          * running yet.  Those running will receive a __death */
785                         nr_cores_revoked = __proc_take_allcores(p, pc_arr, FALSE);
786                         break;
787                 case PROC_RUNNING_S:
788                         #if 0
789                         // here's how to do it manually
790                         if (current == p) {
791                                 lcr3(boot_cr3);
792                                 proc_decref(p);         /* this decref is for the cr3 */
793                                 current = NULL;
794                         }
795                         #endif
796                         send_kernel_message(get_pcoreid(p, 0), __death, 0, 0, 0,
797                                             KMSG_ROUTINE);
798                         __seq_start_write(&p->procinfo->coremap_seqctr);
799                         // TODO: might need to sort num_vcores too later (VC#)
800                         /* vcore is unmapped on the receive side */
801                         __seq_end_write(&p->procinfo->coremap_seqctr);
802                         /* If we ever have RUNNING_S run on non-mgmt cores, we'll need to
803                          * tell the ksched about this now-idle core (after unlocking) */
804                         break;
805                 default:
806                         warn("Weird state(%s) in %s()", procstate2str(p->state),
807                              __FUNCTION__);
808                         spin_unlock(&p->proc_lock);
809                         return;
810         }
811         /* At this point, a death IPI should be on its way, either from the
812          * RUNNING_S one, or from proc_take_cores with a __death.  in general,
813          * interrupts should be on when you call proc_destroy locally, but currently
814          * aren't for all things (like traphandlers). */
815         __proc_set_state(p, PROC_DYING);
816         /* Disown any children.  If we want to have init inherit or something,
817          * change __disown to set the ppid accordingly and concat this with init's
818          * list (instead of emptying it like disown does).  Careful of lock ordering
819          * between procs (need to lock to protect lists) */
820         TAILQ_FOREACH_SAFE(child_i, &p->children, sibling_link, temp) {
821                 int ret = __proc_disown_child(p, child_i);
822                 /* should never fail, lock should cover the race.  invariant: any child
823                  * on the list should have us as a parent */
824                 assert(!ret);
825         }
826         spin_unlock(&p->proc_lock);
827         /* Wake any of our kthreads waiting on children, so they can abort */
828         cv_broadcast(&p->child_wait);
829         /* Abort any abortable syscalls.  This won't catch every sleeper, but future
830          * abortable sleepers are already prevented via the DYING state.  (signalled
831          * DYING, no new sleepers will block, and now we wake all old sleepers). */
832         abort_all_sysc(p);
833         /* we need to close files here, and not in free, since we could have a
834          * refcnt indirectly related to one of our files.  specifically, if we have
835          * a parent sleeping on our pipe, that parent won't wake up to decref until
836          * the pipe closes.  And if the parent doesnt decref, we don't free.
837          * alternatively, we could send a SIGCHILD to the parent, but that would
838          * require parent's to never ignore that signal (or risk never reaping).
839          *
840          * Also note that any mmap'd files will still be mmapped.  You can close the
841          * file after mmapping, with no effect. */
842         close_9ns_files(p, FALSE);
843         close_all_files(&p->open_files, FALSE);
844         /* Tell the ksched about our death, and which cores we freed up */
845         __sched_proc_destroy(p, pc_arr, nr_cores_revoked);
846         /* Tell our parent about our state change (to DYING) */
847         proc_signal_parent(p);
848 }
849
850 /* Can use this to signal anything that might cause a parent to wait on the
851  * child, such as termination, or (in the future) signals.  Change the state or
852  * whatever before calling. */
853 void proc_signal_parent(struct proc *child)
854 {
855         struct kthread *sleeper;
856         struct proc *parent = pid2proc(child->ppid);
857         if (!parent)
858                 return;
859         /* there could be multiple kthreads sleeping for various reasons.  even an
860          * SCP could have multiple async syscalls. */
861         cv_broadcast(&parent->child_wait);
862         /* if the parent was waiting, there's a __launch kthread KMSG out there */
863         proc_decref(parent);
864 }
865
866 /* Called when a parent is done with its child, and no longer wants to track the
867  * child, nor to allow the child to track it.  Call with a lock (cv) held.
868  * Returns 0 if we disowned, -1 on failure. */
869 int __proc_disown_child(struct proc *parent, struct proc *child)
870 {
871         /* Bail out if the child has already been reaped */
872         if (!child->ppid)
873                 return -1;
874         assert(child->ppid == parent->pid);
875         /* lock protects from concurrent inserts / removals from the list */
876         TAILQ_REMOVE(&parent->children, child, sibling_link);
877         /* After this, the child won't be able to get more refs to us, but it may
878          * still have some references in running code. */
879         child->ppid = 0;
880         proc_decref(child);     /* ref that was keeping the child alive on the list */
881         return 0;
882 }
883
884 /* Turns *p into an MCP.  Needs to be called from a local syscall of a RUNNING_S
885  * process.  Returns 0 if it succeeded, an error code otherwise. */
886 int proc_change_to_m(struct proc *p)
887 {
888         int retval = 0;
889         spin_lock(&p->proc_lock);
890         /* in case userspace erroneously tries to change more than once */
891         if (__proc_is_mcp(p))
892                 goto error_out;
893         switch (p->state) {
894                 case (PROC_RUNNING_S):
895                         /* issue with if we're async or not (need to preempt it)
896                          * either of these should trip it. TODO: (ACR) async core req
897                          * TODO: relies on vcore0 being the caller (VC#) */
898                         if ((current != p) || (get_pcoreid(p, 0) != core_id()))
899                                 panic("We don't handle async RUNNING_S core requests yet.");
900                         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
901                         assert(current_ctx);
902                         /* Copy uthread0's context to VC 0's uthread slot */
903                         vcpd->uthread_ctx = *current_ctx;
904                         clear_owning_proc(core_id());   /* so we don't restart */
905                         save_vc_fp_state(vcpd);
906                         /* Userspace needs to not fuck with notif_disabled before
907                          * transitioning to _M. */
908                         if (vcpd->notif_disabled) {
909                                 printk("[kernel] user bug: notifs disabled for vcore 0\n");
910                                 vcpd->notif_disabled = FALSE;
911                         }
912                         /* in the async case, we'll need to remotely stop and bundle
913                          * vcore0's TF.  this is already done for the sync case (local
914                          * syscall). */
915                         /* this process no longer runs on its old location (which is
916                          * this core, for now, since we don't handle async calls) */
917                         __seq_start_write(&p->procinfo->coremap_seqctr);
918                         // TODO: (VC#) might need to adjust num_vcores
919                         // TODO: (ACR) will need to unmap remotely (receive-side)
920                         __unmap_vcore(p, 0);    /* VC# keep in sync with proc_run_s */
921                         __seq_end_write(&p->procinfo->coremap_seqctr);
922                         /* change to runnable_m (it's TF is already saved) */
923                         __proc_set_state(p, PROC_RUNNABLE_M);
924                         p->procinfo->is_mcp = TRUE;
925                         spin_unlock(&p->proc_lock);
926                         /* Tell the ksched that we're a real MCP now! */
927                         __sched_proc_change_to_m(p);
928                         return 0;
929                 case (PROC_RUNNABLE_S):
930                         /* Issues: being on the runnable_list, proc_set_state not liking
931                          * it, and not clearly thinking through how this would happen.
932                          * Perhaps an async call that gets serviced after you're
933                          * descheduled? */
934                         warn("Not supporting RUNNABLE_S -> RUNNABLE_M yet.\n");
935                         goto error_out;
936                 case (PROC_DYING):
937                         warn("Dying, core request coming from %d\n", core_id());
938                         goto error_out;
939                 default:
940                         goto error_out;
941         }
942 error_out:
943         spin_unlock(&p->proc_lock);
944         return -EINVAL;
945 }
946
947 /* Old code to turn a RUNNING_M to a RUNNING_S, with the calling context
948  * becoming the new 'thread0'.  Don't use this.  Caller needs to send in a
949  * pc_arr big enough for all vcores.  Will return the number of cores given up
950  * by the proc. */
951 uint32_t __proc_change_to_s(struct proc *p, uint32_t *pc_arr)
952 {
953         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
954         uint32_t num_revoked;
955         printk("[kernel] trying to transition _M -> _S (deprecated)!\n");
956         assert(p->state == PROC_RUNNING_M); // TODO: (ACR) async core req
957         /* save the context, to be restarted in _S mode */
958         assert(current_ctx);
959         p->scp_ctx = *current_ctx;
960         clear_owning_proc(core_id());   /* so we don't restart */
961         save_vc_fp_state(vcpd);
962         /* sending death, since it's not our job to save contexts or anything in
963          * this case. */
964         num_revoked = __proc_take_allcores(p, pc_arr, FALSE);
965         __proc_set_state(p, PROC_RUNNABLE_S);
966         return num_revoked;
967 }
968
969 /* Helper function.  Is the given pcore a mapped vcore?  No locking involved, be
970  * careful. */
971 static bool is_mapped_vcore(struct proc *p, uint32_t pcoreid)
972 {
973         return p->procinfo->pcoremap[pcoreid].valid;
974 }
975
976 /* Helper function.  Find the vcoreid for a given physical core id for proc p.
977  * No locking involved, be careful.  Panics on failure. */
978 static uint32_t get_vcoreid(struct proc *p, uint32_t pcoreid)
979 {
980         assert(is_mapped_vcore(p, pcoreid));
981         return p->procinfo->pcoremap[pcoreid].vcoreid;
982 }
983
984 /* Helper function.  Try to find the pcoreid for a given virtual core id for
985  * proc p.  No locking involved, be careful.  Use this when you can tolerate a
986  * stale or otherwise 'wrong' answer. */
987 static uint32_t try_get_pcoreid(struct proc *p, uint32_t vcoreid)
988 {
989         return p->procinfo->vcoremap[vcoreid].pcoreid;
990 }
991
992 /* Helper function.  Find the pcoreid for a given virtual core id for proc p.
993  * No locking involved, be careful.  Panics on failure. */
994 static uint32_t get_pcoreid(struct proc *p, uint32_t vcoreid)
995 {
996         assert(vcore_is_mapped(p, vcoreid));
997         return try_get_pcoreid(p, vcoreid);
998 }
999
1000 /* Saves the FP state of the calling core into VCPD.  Pairs with
1001  * restore_vc_fp_state().  On x86, the best case overhead of the flags:
1002  *              FNINIT: 36 ns
1003  *              FXSAVE: 46 ns
1004  *              FXRSTR: 42 ns
1005  *              Flagged FXSAVE: 50 ns
1006  *              Flagged FXRSTR: 66 ns
1007  *              Excess flagged FXRSTR: 42 ns
1008  * If we don't do it, we'll need to initialize every VCPD at process creation
1009  * time with a good FPU state (x86 control words are initialized as 0s, like the
1010  * rest of VCPD). */
1011 static void save_vc_fp_state(struct preempt_data *vcpd)
1012 {
1013         save_fp_state(&vcpd->preempt_anc);
1014         vcpd->rflags |= VC_FPU_SAVED;
1015 }
1016
1017 /* Conditionally restores the FP state from VCPD.  If the state was not valid,
1018  * we don't bother restoring and just initialize the FPU. */
1019 static void restore_vc_fp_state(struct preempt_data *vcpd)
1020 {
1021         if (vcpd->rflags & VC_FPU_SAVED) {
1022                 restore_fp_state(&vcpd->preempt_anc);
1023                 vcpd->rflags &= ~VC_FPU_SAVED;
1024         } else {
1025                 init_fp_state();
1026         }
1027 }
1028
1029 /* Helper for SCPs, saves the core's FPU state into the VCPD vc0 slot */
1030 void __proc_save_fpu_s(struct proc *p)
1031 {
1032         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
1033         save_vc_fp_state(vcpd);
1034 }
1035
1036 /* Helper: saves the SCP's GP tf state and unmaps vcore 0.  This does *not* save
1037  * the FPU state.
1038  *
1039  * In the future, we'll probably use vc0's space for scp_ctx and the silly
1040  * state.  If we ever do that, we'll need to stop using scp_ctx (soon to be in
1041  * VCPD) as a location for pcpui->cur_ctx to point (dangerous) */
1042 void __proc_save_context_s(struct proc *p, struct user_context *ctx)
1043 {
1044         p->scp_ctx = *ctx;
1045         __unmap_vcore(p, 0);    /* VC# keep in sync with proc_run_s */
1046 }
1047
1048 /* Yields the calling core.  Must be called locally (not async) for now.
1049  * - If RUNNING_S, you just give up your time slice and will eventually return,
1050  *   possibly after WAITING on an event.
1051  * - If RUNNING_M, you give up the current vcore (which never returns), and
1052  *   adjust the amount of cores wanted/granted.
1053  * - If you have only one vcore, you switch to WAITING.  There's no 'classic
1054  *   yield' for MCPs (at least not now).  When you run again, you'll have one
1055  *   guaranteed core, starting from the entry point.
1056  *
1057  * If the call is being nice, it means different things for SCPs and MCPs.  For
1058  * MCPs, it means that it is in response to a preemption (which needs to be
1059  * checked).  If there is no preemption pending, just return.  For SCPs, it
1060  * means the proc wants to give up the core, but still has work to do.  If not,
1061  * the proc is trying to wait on an event.  It's not being nice to others, it
1062  * just has no work to do.
1063  *
1064  * This usually does not return (smp_idle()), so it will eat your reference.
1065  * Also note that it needs a non-current/edible reference, since it will abandon
1066  * and continue to use the *p (current == 0, no cr3, etc).
1067  *
1068  * We disable interrupts for most of it too, since we need to protect
1069  * current_ctx and not race with __notify (which doesn't play well with
1070  * concurrent yielders). */
1071 void proc_yield(struct proc *SAFE p, bool being_nice)
1072 {
1073         uint32_t vcoreid, pcoreid = core_id();
1074         struct per_cpu_info *pcpui = &per_cpu_info[pcoreid];
1075         struct vcore *vc;
1076         struct preempt_data *vcpd;
1077         /* Need to lock to prevent concurrent vcore changes (online, inactive, the
1078          * mapping, etc).  This plus checking the nr_preempts is enough to tell if
1079          * our vcoreid and cur_ctx ought to be here still or if we should abort */
1080         spin_lock(&p->proc_lock); /* horrible scalability.  =( */
1081         switch (p->state) {
1082                 case (PROC_RUNNING_S):
1083                         if (!being_nice) {
1084                                 /* waiting for an event to unblock us */
1085                                 vcpd = &p->procdata->vcore_preempt_data[0];
1086                                 /* syncing with event's SCP code.  we set waiting, then check
1087                                  * pending.  they set pending, then check waiting.  it's not
1088                                  * possible for us to miss the notif *and* for them to miss
1089                                  * WAITING.  one (or both) of us will see and make sure the proc
1090                                  * wakes up.  */
1091                                 __proc_set_state(p, PROC_WAITING);
1092                                 wrmb(); /* don't let the state write pass the notif read */ 
1093                                 if (vcpd->notif_pending) {
1094                                         __proc_set_state(p, PROC_RUNNING_S);
1095                                         /* they can't handle events, just need to prevent a yield.
1096                                          * (note the notif_pendings are collapsed). */
1097                                         if (!scp_is_vcctx_ready(vcpd))
1098                                                 vcpd->notif_pending = FALSE;
1099                                         goto out_failed;
1100                                 }
1101                                 /* if we're here, we want to sleep.  a concurrent event that
1102                                  * hasn't already written notif_pending will have seen WAITING,
1103                                  * and will be spinning while we do this. */
1104                                 __proc_save_context_s(p, current_ctx);
1105                                 spin_unlock(&p->proc_lock);
1106                         } else {
1107                                 /* yielding to allow other processes to run.  we're briefly
1108                                  * WAITING, til we are woken up */
1109                                 __proc_set_state(p, PROC_WAITING);
1110                                 __proc_save_context_s(p, current_ctx);
1111                                 spin_unlock(&p->proc_lock);
1112                                 /* immediately wake up the proc (makes it runnable) */
1113                                 proc_wakeup(p);
1114                         }
1115                         goto out_yield_core;
1116                 case (PROC_RUNNING_M):
1117                         break;                          /* will handle this stuff below */
1118                 case (PROC_DYING):              /* incoming __death */
1119                 case (PROC_RUNNABLE_M): /* incoming (bulk) preempt/myield TODO:(BULK) */
1120                         goto out_failed;
1121                 default:
1122                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1123                               __FUNCTION__);
1124         }
1125         /* This is which vcore this pcore thinks it is, regardless of any unmappings
1126          * that may have happened remotely (with __PRs waiting to run) */
1127         vcoreid = pcpui->owning_vcoreid;
1128         vc = vcoreid2vcore(p, vcoreid);
1129         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1130         /* This is how we detect whether or not a __PR happened. */
1131         if (vc->nr_preempts_sent != vc->nr_preempts_done)
1132                 goto out_failed;
1133         /* Sanity checks.  If we were preempted or are dying, we should have noticed
1134          * by now. */
1135         assert(is_mapped_vcore(p, pcoreid));
1136         assert(vcoreid == get_vcoreid(p, pcoreid));
1137         /* no reason to be nice, return */
1138         if (being_nice && !vc->preempt_pending)
1139                 goto out_failed;
1140         /* At this point, AFAIK there should be no preempt/death messages on the
1141          * way, and we're on the online list.  So we'll go ahead and do the yielding
1142          * business. */
1143         /* If there's a preempt pending, we don't need to preempt later since we are
1144          * yielding (nice or otherwise).  If not, this is just a regular yield. */
1145         if (vc->preempt_pending) {
1146                 vc->preempt_pending = 0;
1147         } else {
1148                 /* Optional: on a normal yield, check to see if we are putting them
1149                  * below amt_wanted (help with user races) and bail. */
1150                 if (p->procdata->res_req[RES_CORES].amt_wanted >=
1151                                        p->procinfo->num_vcores)
1152                         goto out_failed;
1153         }
1154         /* Don't let them yield if they are missing a notification.  Userspace must
1155          * not leave vcore context without dealing with notif_pending.
1156          * pop_user_ctx() handles leaving via uthread context.  This handles leaving
1157          * via a yield.
1158          *
1159          * This early check is an optimization.  The real check is below when it
1160          * works with the online_vcs list (syncing with event.c and INDIR/IPI
1161          * posting). */
1162         if (vcpd->notif_pending)
1163                 goto out_failed;
1164         /* Now we'll actually try to yield */
1165         printd("[K] Process %d (%p) is yielding on vcore %d\n", p->pid, p,
1166                get_vcoreid(p, pcoreid));
1167         /* Remove from the online list, add to the yielded list, and unmap
1168          * the vcore, which gives up the core. */
1169         TAILQ_REMOVE(&p->online_vcs, vc, list);
1170         /* Now that we're off the online list, check to see if an alert made
1171          * it through (event.c sets this) */
1172         wrmb(); /* prev write must hit before reading notif_pending */
1173         /* Note we need interrupts disabled, since a __notify can come in
1174          * and set pending to FALSE */
1175         if (vcpd->notif_pending) {
1176                 /* We lost, put it back on the list and abort the yield.  If we ever
1177                  * build an myield, we'll need a way to deal with this for all vcores */
1178                 TAILQ_INSERT_TAIL(&p->online_vcs, vc, list); /* could go HEAD */
1179                 goto out_failed;
1180         }
1181         /* Not really a kmsg, but it acts like one w.r.t. proc mgmt */
1182         pcpui_trace_kmsg(pcpui, (uintptr_t)proc_yield);
1183         /* We won the race with event sending, we can safely yield */
1184         TAILQ_INSERT_HEAD(&p->inactive_vcs, vc, list);
1185         /* Note this protects stuff userspace should look at, which doesn't
1186          * include the TAILQs. */
1187         __seq_start_write(&p->procinfo->coremap_seqctr);
1188         /* Next time the vcore starts, it starts fresh */
1189         vcpd->notif_disabled = FALSE;
1190         __unmap_vcore(p, vcoreid);
1191         p->procinfo->num_vcores--;
1192         p->procinfo->res_grant[RES_CORES] = p->procinfo->num_vcores;
1193         __seq_end_write(&p->procinfo->coremap_seqctr);
1194         /* No more vcores?  Then we wait on an event */
1195         if (p->procinfo->num_vcores == 0) {
1196                 /* consider a ksched op to tell it about us WAITING */
1197                 __proc_set_state(p, PROC_WAITING);
1198         }
1199         spin_unlock(&p->proc_lock);
1200         /* Hand the now-idle core to the ksched */
1201         __sched_put_idle_core(p, pcoreid);
1202         goto out_yield_core;
1203 out_failed:
1204         /* for some reason we just want to return, either to take a KMSG that cleans
1205          * us up, or because we shouldn't yield (ex: notif_pending). */
1206         spin_unlock(&p->proc_lock);
1207         return;
1208 out_yield_core:                         /* successfully yielded the core */
1209         proc_decref(p);                 /* need to eat the ref passed in */
1210         /* Clean up the core and idle. */
1211         clear_owning_proc(pcoreid);     /* so we don't restart */
1212         abandon_core();
1213         smp_idle();
1214 }
1215
1216 /* Sends a notification (aka active notification, aka IPI) to p's vcore.  We
1217  * only send a notification if one they are enabled.  There's a bunch of weird
1218  * cases with this, and how pending / enabled are signals between the user and
1219  * kernel - check the documentation.  Note that pending is more about messages.
1220  * The process needs to be in vcore_context, and the reason is usually a
1221  * message.  We set pending here in case we were called to prod them into vcore
1222  * context (like via a sys_self_notify).  Also note that this works for _S
1223  * procs, if you send to vcore 0 (and the proc is running). */
1224 void proc_notify(struct proc *p, uint32_t vcoreid)
1225 {
1226         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1227         vcpd->notif_pending = TRUE;
1228         wrmb(); /* must write notif_pending before reading notif_disabled */
1229         if (!vcpd->notif_disabled) {
1230                 /* GIANT WARNING: we aren't using the proc-lock to protect the
1231                  * vcoremap.  We want to be able to use this from interrupt context,
1232                  * and don't want the proc_lock to be an irqsave.  Spurious
1233                  * __notify() kmsgs are okay (it checks to see if the right receiver
1234                  * is current). */
1235                 if (vcore_is_mapped(p, vcoreid)) {
1236                         printd("[kernel] sending notif to vcore %d\n", vcoreid);
1237                         /* This use of try_get_pcoreid is racy, might be unmapped */
1238                         send_kernel_message(try_get_pcoreid(p, vcoreid), __notify, (long)p,
1239                                             0, 0, KMSG_ROUTINE);
1240                 }
1241         }
1242 }
1243
1244 /* Makes sure p is runnable.  Callers may spam this, so it needs to handle
1245  * repeated calls for the same event.  Callers include event delivery, SCP
1246  * yield, and new SCPs.  Will trigger __sched_.cp_wakeup() CBs.  Will only
1247  * trigger the CB once, regardless of how many times we are called, *until* the
1248  * proc becomes WAITING again, presumably because of something the ksched did.*/
1249 void proc_wakeup(struct proc *p)
1250 {
1251         spin_lock(&p->proc_lock);
1252         if (__proc_is_mcp(p)) {
1253                 /* we only wake up WAITING mcps */
1254                 if (p->state != PROC_WAITING) {
1255                         spin_unlock(&p->proc_lock);
1256                         return;
1257                 }
1258                 __proc_set_state(p, PROC_RUNNABLE_M);
1259                 spin_unlock(&p->proc_lock);
1260                 __sched_mcp_wakeup(p);
1261                 return;
1262         } else {
1263                 /* SCPs can wake up for a variety of reasons.  the only times we need
1264                  * to do something is if it was waiting or just created.  other cases
1265                  * are either benign (just go out), or potential bugs (_Ms) */
1266                 switch (p->state) {
1267                         case (PROC_CREATED):
1268                         case (PROC_WAITING):
1269                                 __proc_set_state(p, PROC_RUNNABLE_S);
1270                                 break;
1271                         case (PROC_RUNNABLE_S):
1272                         case (PROC_RUNNING_S):
1273                         case (PROC_DYING):
1274                                 spin_unlock(&p->proc_lock);
1275                                 return;
1276                         case (PROC_RUNNABLE_M):
1277                         case (PROC_RUNNING_M):
1278                                 warn("Weird state(%s) in %s()", procstate2str(p->state),
1279                                      __FUNCTION__);
1280                                 spin_unlock(&p->proc_lock);
1281                                 return;
1282                 }
1283                 printd("[kernel] FYI, waking up an _S proc\n"); /* thanks, past brho! */
1284                 spin_unlock(&p->proc_lock);
1285                 __sched_scp_wakeup(p);
1286         }
1287 }
1288
1289 /* Is the process in multi_mode / is an MCP or not?  */
1290 bool __proc_is_mcp(struct proc *p)
1291 {
1292         /* in lieu of using the amount of cores requested, or having a bunch of
1293          * states (like PROC_WAITING_M and _S), I'll just track it with a bool. */
1294         return p->procinfo->is_mcp;
1295 }
1296
1297 /************************  Preemption Functions  ******************************
1298  * Don't rely on these much - I'll be sure to change them up a bit.
1299  *
1300  * Careful about what takes a vcoreid and what takes a pcoreid.  Also, there may
1301  * be weird glitches with setting the state to RUNNABLE_M.  It is somewhat in
1302  * flux.  The num_vcores is changed after take_cores, but some of the messages
1303  * (or local traps) may not yet be ready to handle seeing their future state.
1304  * But they should be, so fix those when they pop up.
1305  *
1306  * Another thing to do would be to make the _core functions take a pcorelist,
1307  * and not just one pcoreid. */
1308
1309 /* Sets a preempt_pending warning for p's vcore, to go off 'when'.  If you care
1310  * about locking, do it before calling.  Takes a vcoreid! */
1311 void __proc_preempt_warn(struct proc *p, uint32_t vcoreid, uint64_t when)
1312 {
1313         struct event_msg local_msg = {0};
1314         /* danger with doing this unlocked: preempt_pending is set, but never 0'd,
1315          * since it is unmapped and not dealt with (TODO)*/
1316         p->procinfo->vcoremap[vcoreid].preempt_pending = when;
1317
1318         /* Send the event (which internally checks to see how they want it) */
1319         local_msg.ev_type = EV_PREEMPT_PENDING;
1320         local_msg.ev_arg1 = vcoreid;
1321         /* Whenever we send msgs with the proc locked, we need at least 1 online.
1322          * Caller needs to make sure the core was online/mapped. */
1323         assert(!TAILQ_EMPTY(&p->online_vcs));
1324         send_kernel_event(p, &local_msg, vcoreid);
1325
1326         /* TODO: consider putting in some lookup place for the alarm to find it.
1327          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1328 }
1329
1330 /* Warns all active vcores of an impending preemption.  Hold the lock if you
1331  * care about the mapping (and you should). */
1332 void __proc_preempt_warnall(struct proc *p, uint64_t when)
1333 {
1334         struct vcore *vc_i;
1335         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1336                 __proc_preempt_warn(p, vcore2vcoreid(p, vc_i), when);
1337         /* TODO: consider putting in some lookup place for the alarm to find it.
1338          * til then, it'll have to scan the vcoremap (O(n) instead of O(m)) */
1339 }
1340
1341 // TODO: function to set an alarm, if none is outstanding
1342
1343 /* Raw function to preempt a single core.  If you care about locking, do it
1344  * before calling. */
1345 void __proc_preempt_core(struct proc *p, uint32_t pcoreid)
1346 {
1347         uint32_t vcoreid = get_vcoreid(p, pcoreid);
1348         struct event_msg preempt_msg = {0};
1349         /* works with nr_preempts_done to signal completion of a preemption */
1350         p->procinfo->vcoremap[vcoreid].nr_preempts_sent++;
1351         // expects a pcorelist.  assumes pcore is mapped and running_m
1352         __proc_take_corelist(p, &pcoreid, 1, TRUE);
1353         /* Only send the message if we have an online core.  o/w, it would fuck
1354          * us up (deadlock), and hey don't need a message.  the core we just took
1355          * will be the first one to be restarted.  It will look like a notif.  in
1356          * the future, we could send the event if we want, but the caller needs to
1357          * do that (after unlocking). */
1358         if (!TAILQ_EMPTY(&p->online_vcs)) {
1359                 preempt_msg.ev_type = EV_VCORE_PREEMPT;
1360                 preempt_msg.ev_arg2 = vcoreid;
1361                 send_kernel_event(p, &preempt_msg, 0);
1362         }
1363 }
1364
1365 /* Raw function to preempt every vcore.  If you care about locking, do it before
1366  * calling. */
1367 uint32_t __proc_preempt_all(struct proc *p, uint32_t *pc_arr)
1368 {
1369         struct vcore *vc_i;
1370         /* TODO:(BULK) PREEMPT - don't bother with this, set a proc wide flag, or
1371          * just make us RUNNABLE_M.  Note this is also used by __map_vcore. */
1372         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1373                 vc_i->nr_preempts_sent++;
1374         return __proc_take_allcores(p, pc_arr, TRUE);
1375 }
1376
1377 /* Warns and preempts a vcore from p.  No delaying / alarming, or anything.  The
1378  * warning will be for u usec from now.  Returns TRUE if the core belonged to
1379  * the proc (and thus preempted), False if the proc no longer has the core. */
1380 bool proc_preempt_core(struct proc *p, uint32_t pcoreid, uint64_t usec)
1381 {
1382         uint64_t warn_time = read_tsc() + usec2tsc(usec);
1383         bool retval = FALSE;
1384         if (p->state != PROC_RUNNING_M) {
1385                 /* more of an FYI for brho.  should be harmless to just return. */
1386                 warn("Tried to preempt from a non RUNNING_M proc!");
1387                 return FALSE;
1388         }
1389         spin_lock(&p->proc_lock);
1390         if (is_mapped_vcore(p, pcoreid)) {
1391                 __proc_preempt_warn(p, get_vcoreid(p, pcoreid), warn_time);
1392                 __proc_preempt_core(p, pcoreid);
1393                 /* we might have taken the last core */
1394                 if (!p->procinfo->num_vcores)
1395                         __proc_set_state(p, PROC_RUNNABLE_M);
1396                 retval = TRUE;
1397         }
1398         spin_unlock(&p->proc_lock);
1399         return retval;
1400 }
1401
1402 /* Warns and preempts all from p.  No delaying / alarming, or anything.  The
1403  * warning will be for u usec from now. */
1404 void proc_preempt_all(struct proc *p, uint64_t usec)
1405 {
1406         uint64_t warn_time = read_tsc() + usec2tsc(usec);
1407         uint32_t num_revoked = 0;
1408         spin_lock(&p->proc_lock);
1409         /* storage for pc_arr is alloced at decl, which is after grabbing the lock*/
1410         uint32_t pc_arr[p->procinfo->num_vcores];
1411         /* DYING could be okay */
1412         if (p->state != PROC_RUNNING_M) {
1413                 warn("Tried to preempt from a non RUNNING_M proc!");
1414                 spin_unlock(&p->proc_lock);
1415                 return;
1416         }
1417         __proc_preempt_warnall(p, warn_time);
1418         num_revoked = __proc_preempt_all(p, pc_arr);
1419         assert(!p->procinfo->num_vcores);
1420         __proc_set_state(p, PROC_RUNNABLE_M);
1421         spin_unlock(&p->proc_lock);
1422         /* TODO: when we revise this func, look at __put_idle */
1423         /* Return the cores to the ksched */
1424         if (num_revoked)
1425                 __sched_put_idle_cores(p, pc_arr, num_revoked);
1426 }
1427
1428 /* Give the specific pcore to proc p.  Lots of assumptions, so don't really use
1429  * this.  The proc needs to be _M and prepared for it.  the pcore needs to be
1430  * free, etc. */
1431 void proc_give(struct proc *p, uint32_t pcoreid)
1432 {
1433         warn("Your idlecoremap is now screwed up");     /* TODO (IDLE) */
1434         spin_lock(&p->proc_lock);
1435         // expects a pcorelist, we give it a list of one
1436         __proc_give_cores(p, &pcoreid, 1);
1437         spin_unlock(&p->proc_lock);
1438 }
1439
1440 /* Global version of the helper, for sys_get_vcoreid (might phase that syscall
1441  * out). */
1442 uint32_t proc_get_vcoreid(struct proc *p)
1443 {
1444         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1445         if (pcpui->owning_proc == p) {
1446                 return pcpui->owning_vcoreid;
1447         } else {
1448                 warn("Asked for vcoreid for %p, but %p is pwns", p, pcpui->owning_proc);
1449                 return (uint32_t)-1;
1450         }
1451 }
1452
1453 /* TODO: make all of these static inlines when we gut the env crap */
1454 bool vcore_is_mapped(struct proc *p, uint32_t vcoreid)
1455 {
1456         return p->procinfo->vcoremap[vcoreid].valid;
1457 }
1458
1459 /* Can do this, or just create a new field and save it in the vcoremap */
1460 uint32_t vcore2vcoreid(struct proc *p, struct vcore *vc)
1461 {
1462         return (vc - p->procinfo->vcoremap);
1463 }
1464
1465 struct vcore *vcoreid2vcore(struct proc *p, uint32_t vcoreid)
1466 {
1467         return &p->procinfo->vcoremap[vcoreid];
1468 }
1469
1470 /********** Core granting (bulk and single) ***********/
1471
1472 /* Helper: gives pcore to the process, mapping it to the next available vcore
1473  * from list vc_list.  Returns TRUE if we succeeded (non-empty).  If you pass in
1474  * **vc, we'll tell you which vcore it was. */
1475 static bool __proc_give_a_pcore(struct proc *p, uint32_t pcore,
1476                                 struct vcore_tailq *vc_list, struct vcore **vc)
1477 {
1478         struct vcore *new_vc;
1479         new_vc = TAILQ_FIRST(vc_list);
1480         if (!new_vc)
1481                 return FALSE;
1482         printd("setting vcore %d to pcore %d\n", vcore2vcoreid(p, new_vc),
1483                pcore);
1484         TAILQ_REMOVE(vc_list, new_vc, list);
1485         TAILQ_INSERT_TAIL(&p->online_vcs, new_vc, list);
1486         __map_vcore(p, vcore2vcoreid(p, new_vc), pcore);
1487         if (vc)
1488                 *vc = new_vc;
1489         return TRUE;
1490 }
1491
1492 static void __proc_give_cores_runnable(struct proc *p, uint32_t *pc_arr,
1493                                        uint32_t num)
1494 {
1495         assert(p->state == PROC_RUNNABLE_M);
1496         assert(num);    /* catch bugs */
1497         /* add new items to the vcoremap */
1498         __seq_start_write(&p->procinfo->coremap_seqctr);/* unncessary if offline */
1499         p->procinfo->num_vcores += num;
1500         for (int i = 0; i < num; i++) {
1501                 /* Try from the bulk list first */
1502                 if (__proc_give_a_pcore(p, pc_arr[i], &p->bulk_preempted_vcs, 0))
1503                         continue;
1504                 /* o/w, try from the inactive list.  at one point, i thought there might
1505                  * be a legit way in which the inactive list could be empty, but that i
1506                  * wanted to catch it via an assert. */
1507                 assert(__proc_give_a_pcore(p, pc_arr[i], &p->inactive_vcs, 0));
1508         }
1509         __seq_end_write(&p->procinfo->coremap_seqctr);
1510 }
1511
1512 static void __proc_give_cores_running(struct proc *p, uint32_t *pc_arr,
1513                                       uint32_t num)
1514 {
1515         struct vcore *vc_i;
1516         /* Up the refcnt, since num cores are going to start using this
1517          * process and have it loaded in their owning_proc and 'current'. */
1518         proc_incref(p, num * 2);        /* keep in sync with __startcore */
1519         __seq_start_write(&p->procinfo->coremap_seqctr);
1520         p->procinfo->num_vcores += num;
1521         assert(TAILQ_EMPTY(&p->bulk_preempted_vcs));
1522         for (int i = 0; i < num; i++) {
1523                 assert(__proc_give_a_pcore(p, pc_arr[i], &p->inactive_vcs, &vc_i));
1524                 send_kernel_message(pc_arr[i], __startcore, (long)p,
1525                                     (long)vcore2vcoreid(p, vc_i), 
1526                                     (long)vc_i->nr_preempts_sent, KMSG_ROUTINE);
1527         }
1528         __seq_end_write(&p->procinfo->coremap_seqctr);
1529 }
1530
1531 /* Gives process p the additional num cores listed in pcorelist.  If the proc is
1532  * not RUNNABLE_M or RUNNING_M, this will fail and allocate none of the core
1533  * (and return -1).  If you're RUNNING_M, this will startup your new cores at
1534  * the entry point with their virtual IDs (or restore a preemption).  If you're
1535  * RUNNABLE_M, you should call __proc_run_m after this so that the process can
1536  * start to use its cores.  In either case, this returns 0.
1537  *
1538  * If you're *_S, make sure your core0's TF is set (which is done when coming in
1539  * via arch/trap.c and we are RUNNING_S), change your state, then call this.
1540  * Then call __proc_run_m().
1541  *
1542  * The reason I didn't bring the _S cases from core_request over here is so we
1543  * can keep this family of calls dealing with only *_Ms, to avoiding caring if
1544  * this is called from another core, and to avoid the _S -> _M transition.
1545  *
1546  * WARNING: You must hold the proc_lock before calling this! */
1547 int __proc_give_cores(struct proc *p, uint32_t *pc_arr, uint32_t num)
1548 {
1549         /* should never happen: */
1550         assert(num + p->procinfo->num_vcores <= MAX_NUM_CPUS);
1551         switch (p->state) {
1552                 case (PROC_RUNNABLE_S):
1553                 case (PROC_RUNNING_S):
1554                         warn("Don't give cores to a process in a *_S state!\n");
1555                         return -1;
1556                 case (PROC_DYING):
1557                 case (PROC_WAITING):
1558                         /* can't accept, just fail */
1559                         return -1;
1560                 case (PROC_RUNNABLE_M):
1561                         __proc_give_cores_runnable(p, pc_arr, num);
1562                         break;
1563                 case (PROC_RUNNING_M):
1564                         __proc_give_cores_running(p, pc_arr, num);
1565                         break;
1566                 default:
1567                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1568                               __FUNCTION__);
1569         }
1570         /* TODO: considering moving to the ksched (hard, due to yield) */
1571         p->procinfo->res_grant[RES_CORES] += num;
1572         return 0;
1573 }
1574
1575 /********** Core revocation (bulk and single) ***********/
1576
1577 /* Revokes a single vcore from a process (unmaps or sends a KMSG to unmap). */
1578 static void __proc_revoke_core(struct proc *p, uint32_t vcoreid, bool preempt)
1579 {
1580         uint32_t pcoreid = get_pcoreid(p, vcoreid);
1581         struct preempt_data *vcpd;
1582         if (preempt) {
1583                 /* Lock the vcore's state (necessary for preemption recovery) */
1584                 vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1585                 atomic_or(&vcpd->flags, VC_K_LOCK);
1586                 send_kernel_message(pcoreid, __preempt, (long)p, 0, 0, KMSG_ROUTINE);
1587         } else {
1588                 send_kernel_message(pcoreid, __death, 0, 0, 0, KMSG_ROUTINE);
1589         }
1590 }
1591
1592 /* Revokes all cores from the process (unmaps or sends a KMSGS). */
1593 static void __proc_revoke_allcores(struct proc *p, bool preempt)
1594 {
1595         struct vcore *vc_i;
1596         /* TODO: if we ever get broadcast messaging, use it here (still need to lock
1597          * the vcores' states for preemption) */
1598         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1599                 __proc_revoke_core(p, vcore2vcoreid(p, vc_i), preempt);
1600 }
1601
1602 /* Might be faster to scan the vcoremap than to walk the list... */
1603 static void __proc_unmap_allcores(struct proc *p)
1604 {
1605         struct vcore *vc_i;
1606         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1607                 __unmap_vcore(p, vcore2vcoreid(p, vc_i));
1608 }
1609
1610 /* Takes (revoke via kmsg or unmap) from process p the num cores listed in
1611  * pc_arr.  Will preempt if 'preempt' is set.  o/w, no state will be saved, etc.
1612  * Don't use this for taking all of a process's cores.
1613  *
1614  * Make sure you hold the lock when you call this, and make sure that the pcore
1615  * actually belongs to the proc, non-trivial due to other __preempt messages. */
1616 void __proc_take_corelist(struct proc *p, uint32_t *pc_arr, uint32_t num,
1617                           bool preempt)
1618 {
1619         struct vcore *vc;
1620         uint32_t vcoreid;
1621         assert(p->state & (PROC_RUNNING_M | PROC_RUNNABLE_M));
1622         __seq_start_write(&p->procinfo->coremap_seqctr);
1623         for (int i = 0; i < num; i++) {
1624                 vcoreid = get_vcoreid(p, pc_arr[i]);
1625                 /* Sanity check */
1626                 assert(pc_arr[i] == get_pcoreid(p, vcoreid));
1627                 /* Revoke / unmap core */
1628                 if (p->state == PROC_RUNNING_M)
1629                         __proc_revoke_core(p, vcoreid, preempt);
1630                 __unmap_vcore(p, vcoreid);
1631                 /* Change lists for the vcore.  Note, the vcore is already unmapped
1632                  * and/or the messages are already in flight.  The only code that looks
1633                  * at the lists without holding the lock is event code. */
1634                 vc = vcoreid2vcore(p, vcoreid);
1635                 TAILQ_REMOVE(&p->online_vcs, vc, list);
1636                 /* even for single preempts, we use the inactive list.  bulk preempt is
1637                  * only used for when we take everything. */
1638                 TAILQ_INSERT_HEAD(&p->inactive_vcs, vc, list);
1639         }
1640         p->procinfo->num_vcores -= num;
1641         __seq_end_write(&p->procinfo->coremap_seqctr);
1642         p->procinfo->res_grant[RES_CORES] -= num;
1643 }
1644
1645 /* Takes all cores from a process (revoke via kmsg or unmap), putting them on
1646  * the appropriate vcore list, and fills pc_arr with the pcores revoked, and
1647  * returns the number of entries in pc_arr.
1648  *
1649  * Make sure pc_arr is big enough to handle num_vcores().
1650  * Make sure you hold the lock when you call this. */
1651 uint32_t __proc_take_allcores(struct proc *p, uint32_t *pc_arr, bool preempt)
1652 {
1653         struct vcore *vc_i, *vc_temp;
1654         uint32_t num = 0;
1655         assert(p->state & (PROC_RUNNING_M | PROC_RUNNABLE_M));
1656         __seq_start_write(&p->procinfo->coremap_seqctr);
1657         /* Write out which pcores we're going to take */
1658         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
1659                 pc_arr[num++] = vc_i->pcoreid;
1660         /* Revoke if they are running, and unmap.  Both of these need the online
1661          * list to not be changed yet. */
1662         if (p->state == PROC_RUNNING_M)
1663                 __proc_revoke_allcores(p, preempt);
1664         __proc_unmap_allcores(p);
1665         /* Move the vcores from online to the head of the appropriate list */
1666         TAILQ_FOREACH_SAFE(vc_i, &p->online_vcs, list, vc_temp) {
1667                 /* TODO: we may want a TAILQ_CONCAT_HEAD, or something that does that */
1668                 TAILQ_REMOVE(&p->online_vcs, vc_i, list);
1669                 /* Put the cores on the appropriate list */
1670                 if (preempt)
1671                         TAILQ_INSERT_HEAD(&p->bulk_preempted_vcs, vc_i, list);
1672                 else
1673                         TAILQ_INSERT_HEAD(&p->inactive_vcs, vc_i, list);
1674         }
1675         assert(TAILQ_EMPTY(&p->online_vcs));
1676         assert(num == p->procinfo->num_vcores);
1677         p->procinfo->num_vcores = 0;
1678         __seq_end_write(&p->procinfo->coremap_seqctr);
1679         p->procinfo->res_grant[RES_CORES] = 0;
1680         return num;
1681 }
1682
1683 /* Helper to do the vcore->pcore and inverse mapping.  Hold the lock when
1684  * calling. */
1685 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid)
1686 {
1687         p->procinfo->vcoremap[vcoreid].pcoreid = pcoreid;
1688         p->procinfo->vcoremap[vcoreid].valid = TRUE;
1689         p->procinfo->pcoremap[pcoreid].vcoreid = vcoreid;
1690         p->procinfo->pcoremap[pcoreid].valid = TRUE;
1691 }
1692
1693 /* Helper to unmap the vcore->pcore and inverse mapping.  Hold the lock when
1694  * calling. */
1695 void __unmap_vcore(struct proc *p, uint32_t vcoreid)
1696 {
1697         p->procinfo->pcoremap[p->procinfo->vcoremap[vcoreid].pcoreid].valid = FALSE;
1698         p->procinfo->vcoremap[vcoreid].valid = FALSE;
1699 }
1700
1701 /* Stop running whatever context is on this core and load a known-good cr3.
1702  * Note this leaves no trace of what was running. This "leaves the process's
1703  * context.
1704  *
1705  * This does not clear the owning proc.  Use the other helper for that. */
1706 void abandon_core(void)
1707 {
1708         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1709         /* Syscalls that don't return will ultimately call abadon_core(), so we need
1710          * to make sure we don't think we are still working on a syscall. */
1711         pcpui->cur_kthread->sysc = 0;
1712         pcpui->cur_kthread->errbuf = 0; /* just in case */
1713         if (pcpui->cur_proc)
1714                 __abandon_core();
1715 }
1716
1717 /* Helper to clear the core's owning processor and manage refcnting.  Pass in
1718  * core_id() to save a couple core_id() calls. */
1719 void clear_owning_proc(uint32_t coreid)
1720 {
1721         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
1722         struct proc *p = pcpui->owning_proc;
1723         pcpui->owning_proc = 0;
1724         pcpui->owning_vcoreid = 0xdeadbeef;
1725         pcpui->cur_ctx = 0;                     /* catch bugs for now (may go away) */
1726         if (p)
1727                 proc_decref(p);
1728 }
1729
1730 /* Switches to the address space/context of new_p, doing nothing if we are
1731  * already in new_p.  This won't add extra refcnts or anything, and needs to be
1732  * paired with switch_back() at the end of whatever function you are in.  Don't
1733  * migrate cores in the middle of a pair.  Specifically, the uncounted refs are
1734  * one for the old_proc, which is passed back to the caller, and new_p is
1735  * getting placed in cur_proc. */
1736 struct proc *switch_to(struct proc *new_p)
1737 {
1738         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1739         struct proc *old_proc;
1740         old_proc = pcpui->cur_proc;                                     /* uncounted ref */
1741         /* If we aren't the proc already, then switch to it */
1742         if (old_proc != new_p) {
1743                 pcpui->cur_proc = new_p;                                /* uncounted ref */
1744                 if (new_p)
1745                         lcr3(new_p->env_cr3);
1746                 else
1747                         lcr3(boot_cr3);
1748         }
1749         return old_proc;
1750 }
1751
1752 /* This switches back to old_proc from new_p.  Pair it with switch_to(), and
1753  * pass in its return value for old_proc. */
1754 void switch_back(struct proc *new_p, struct proc *old_proc)
1755 {
1756         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1757         if (old_proc != new_p) {
1758                 pcpui->cur_proc = old_proc;
1759                 if (old_proc)
1760                         lcr3(old_proc->env_cr3);
1761                 else
1762                         lcr3(boot_cr3);
1763         }
1764 }
1765
1766 /* Will send a TLB shootdown message to every vcore in the main address space
1767  * (aka, all vcores for now).  The message will take the start and end virtual
1768  * addresses as well, in case we want to be more clever about how much we
1769  * shootdown and batching our messages.  Should do the sanity about rounding up
1770  * and down in this function too.
1771  *
1772  * Would be nice to have a broadcast kmsg at this point.  Note this may send a
1773  * message to the calling core (interrupting it, possibly while holding the
1774  * proc_lock).  We don't need to process routine messages since it's an
1775  * immediate message. */
1776 void proc_tlbshootdown(struct proc *p, uintptr_t start, uintptr_t end)
1777 {
1778         /* TODO: need a better way to find cores running our address space.  we can
1779          * have kthreads running syscalls, async calls, processes being created. */
1780         struct vcore *vc_i;
1781         /* TODO: we might be able to avoid locking here in the future (we must hit
1782          * all online, and we can check __mapped).  it'll be complicated. */
1783         spin_lock(&p->proc_lock);
1784         switch (p->state) {
1785                 case (PROC_RUNNING_S):
1786                         tlbflush();
1787                         break;
1788                 case (PROC_RUNNING_M):
1789                         /* TODO: (TLB) sanity checks and rounding on the ranges */
1790                         TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
1791                                 send_kernel_message(vc_i->pcoreid, __tlbshootdown, start, end,
1792                                                     0, KMSG_IMMEDIATE);
1793                         }
1794                         break;
1795                 default:
1796                         /* TODO: til we fix shootdowns, there are some odd cases where we
1797                          * have the address space loaded, but the state is in transition. */
1798                         if (p == current)
1799                                 tlbflush();
1800         }
1801         spin_unlock(&p->proc_lock);
1802 }
1803
1804 /* Helper, used by __startcore and __set_curctx, which sets up cur_ctx to run a
1805  * given process's vcore.  Caller needs to set up things like owning_proc and
1806  * whatnot.  Note that we might not have p loaded as current. */
1807 static void __set_curctx_to_vcoreid(struct proc *p, uint32_t vcoreid,
1808                                     uint32_t old_nr_preempts_sent)
1809 {
1810         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
1811         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1812         struct vcore *vc = vcoreid2vcore(p, vcoreid);
1813         /* Spin until our vcore's old preemption is done.  When __SC was sent, we
1814          * were told what the nr_preempts_sent was at that time.  Once that many are
1815          * done, it is time for us to run.  This forces a 'happens-before' ordering
1816          * on a __PR of our VC before this __SC of the VC.  Note the nr_done should
1817          * not exceed old_nr_sent, since further __PR are behind this __SC in the
1818          * KMSG queue. */
1819         while (old_nr_preempts_sent != vc->nr_preempts_done)
1820                 cpu_relax();
1821         cmb();  /* read nr_done before any other rd or wr.  CPU mb in the atomic. */
1822         /* Mark that this vcore as no longer preempted.  No danger of clobbering
1823          * other writes, since this would get turned on in __preempt (which can't be
1824          * concurrent with this function on this core), and the atomic is just
1825          * toggling the one bit (a concurrent VC_K_LOCK will work) */
1826         atomic_and(&vcpd->flags, ~VC_PREEMPTED);
1827         /* Once the VC is no longer preempted, we allow it to receive msgs.  We
1828          * could let userspace do it, but handling it here makes it easier for them
1829          * to handle_indirs (when they turn this flag off).  Note the atomics
1830          * provide the needed barriers (cmb and mb on flags). */
1831         atomic_or(&vcpd->flags, VC_CAN_RCV_MSG);
1832         printd("[kernel] startcore on physical core %d for process %d's vcore %d\n",
1833                core_id(), p->pid, vcoreid);
1834         /* If notifs are disabled, the vcore was in vcore context and we need to
1835          * restart the vcore_ctx.  o/w, we give them a fresh vcore (which is also
1836          * what happens the first time a vcore comes online).  No matter what,
1837          * they'll restart in vcore context.  It's just a matter of whether or not
1838          * it is the old, interrupted vcore context. */
1839         if (vcpd->notif_disabled) {
1840                 /* copy-in the tf we'll pop, then set all security-related fields */
1841                 pcpui->actual_ctx = vcpd->vcore_ctx;
1842                 proc_secure_ctx(&pcpui->actual_ctx);
1843         } else { /* not restarting from a preemption, use a fresh vcore */
1844                 assert(vcpd->transition_stack);
1845                 proc_init_ctx(&pcpui->actual_ctx, vcoreid, p->env_entry,
1846                               vcpd->transition_stack, vcpd->vcore_tls_desc);
1847                 /* Disable/mask active notifications for fresh vcores */
1848                 vcpd->notif_disabled = TRUE;
1849         }
1850         /* Regardless of whether or not we have a 'fresh' VC, we need to restore the
1851          * FPU state for the VC according to VCPD (which means either a saved FPU
1852          * state or a brand new init).  Starting a fresh VC is just referring to the
1853          * GP context we run.  The vcore itself needs to have the FPU state loaded
1854          * from when it previously ran and was saved (or a fresh FPU if it wasn't
1855          * saved).  For fresh FPUs, the main purpose is for limiting info leakage.
1856          * I think VCs that don't need FPU state for some reason (like having a
1857          * current_uthread) can handle any sort of FPU state, since it gets sorted
1858          * when they pop their next uthread.
1859          *
1860          * Note this can cause a GP fault on x86 if the state is corrupt.  In lieu
1861          * of reading in the huge FP state and mucking with mxcsr_mask, we should
1862          * handle this like a KPF on user code. */
1863         restore_vc_fp_state(vcpd);
1864         /* cur_ctx was built above (in actual_ctx), now use it */
1865         pcpui->cur_ctx = &pcpui->actual_ctx;
1866         /* this cur_ctx will get run when the kernel returns / idles */
1867 }
1868
1869 /* Changes calling vcore to be vcoreid.  enable_my_notif tells us about how the
1870  * state calling vcore wants to be left in.  It will look like caller_vcoreid
1871  * was preempted.  Note we don't care about notif_pending.
1872  *
1873  * Will return:
1874  *              0 if we successfully changed to the target vcore.
1875  *              -EBUSY if the target vcore is already mapped (a good kind of failure)
1876  *              -EAGAIN if we failed for some other reason and need to try again.  For
1877  *              example, the caller could be preempted, and we never even attempted to
1878  *              change.
1879  *              -EINVAL some userspace bug */
1880 int proc_change_to_vcore(struct proc *p, uint32_t new_vcoreid,
1881                          bool enable_my_notif)
1882 {
1883         uint32_t caller_vcoreid, pcoreid = core_id();
1884         struct per_cpu_info *pcpui = &per_cpu_info[pcoreid];
1885         struct preempt_data *caller_vcpd;
1886         struct vcore *caller_vc, *new_vc;
1887         struct event_msg preempt_msg = {0};
1888         int retval = -EAGAIN;   /* by default, try again */
1889         /* Need to not reach outside the vcoremap, which might be smaller in the
1890          * future, but should always be as big as max_vcores */
1891         if (new_vcoreid >= p->procinfo->max_vcores)
1892                 return -EINVAL;
1893         /* Need to lock to prevent concurrent vcore changes, like in yield. */
1894         spin_lock(&p->proc_lock);
1895         /* new_vcoreid is already runing, abort */
1896         if (vcore_is_mapped(p, new_vcoreid)) {
1897                 retval = -EBUSY;
1898                 goto out_locked;
1899         }
1900         /* Need to make sure our vcore is allowed to switch.  We might have a
1901          * __preempt, __death, etc, coming in.  Similar to yield. */
1902         switch (p->state) {
1903                 case (PROC_RUNNING_M):
1904                         break;                          /* the only case we can proceed */
1905                 case (PROC_RUNNING_S):  /* user bug, just return */
1906                 case (PROC_DYING):              /* incoming __death */
1907                 case (PROC_RUNNABLE_M): /* incoming (bulk) preempt/myield TODO:(BULK) */
1908                         goto out_locked;
1909                 default:
1910                         panic("Weird state(%s) in %s()", procstate2str(p->state),
1911                               __FUNCTION__);
1912         }
1913         /* This is which vcore this pcore thinks it is, regardless of any unmappings
1914          * that may have happened remotely (with __PRs waiting to run) */
1915         caller_vcoreid = pcpui->owning_vcoreid;
1916         caller_vc = vcoreid2vcore(p, caller_vcoreid);
1917         caller_vcpd = &p->procdata->vcore_preempt_data[caller_vcoreid];
1918         /* This is how we detect whether or not a __PR happened.  If it did, just
1919          * abort and handle the kmsg.  No new __PRs are coming since we hold the
1920          * lock.  This also detects a __PR followed by a __SC for the same VC. */
1921         if (caller_vc->nr_preempts_sent != caller_vc->nr_preempts_done)
1922                 goto out_locked;
1923         /* Sanity checks.  If we were preempted or are dying, we should have noticed
1924          * by now. */
1925         assert(is_mapped_vcore(p, pcoreid));
1926         assert(caller_vcoreid == get_vcoreid(p, pcoreid));
1927         /* Should only call from vcore context */
1928         if (!caller_vcpd->notif_disabled) {
1929                 retval = -EINVAL;
1930                 printk("[kernel] You tried to change vcores from uthread ctx\n");
1931                 goto out_locked;
1932         }
1933         /* Ok, we're clear to do the switch.  Lets figure out who the new one is */
1934         new_vc = vcoreid2vcore(p, new_vcoreid);
1935         printd("[kernel] changing vcore %d to vcore %d\n", caller_vcoreid,
1936                new_vcoreid);
1937         /* enable_my_notif signals how we'll be restarted */
1938         if (enable_my_notif) {
1939                 /* if they set this flag, then the vcore can just restart from scratch,
1940                  * and we don't care about either the uthread_ctx or the vcore_ctx. */
1941                 caller_vcpd->notif_disabled = FALSE;
1942                 /* Don't need to save the FPU.  There should be no uthread or other
1943                  * reason to return to the FPU state. */
1944         } else {
1945                 /* need to set up the calling vcore's ctx so that it'll get restarted by
1946                  * __startcore, to make the caller look like it was preempted. */
1947                 caller_vcpd->vcore_ctx = *current_ctx;
1948                 save_vc_fp_state(caller_vcpd);
1949                 /* Mark our core as preempted (for userspace recovery). */
1950                 atomic_or(&caller_vcpd->flags, VC_PREEMPTED);
1951         }
1952         /* Either way, unmap and offline our current vcore */
1953         /* Move the caller from online to inactive */
1954         TAILQ_REMOVE(&p->online_vcs, caller_vc, list);
1955         /* We don't bother with the notif_pending race.  note that notif_pending
1956          * could still be set.  this was a preempted vcore, and userspace will need
1957          * to deal with missed messages (preempt_recover() will handle that) */
1958         TAILQ_INSERT_HEAD(&p->inactive_vcs, caller_vc, list);
1959         /* Move the new one from inactive to online */
1960         TAILQ_REMOVE(&p->inactive_vcs, new_vc, list);
1961         TAILQ_INSERT_TAIL(&p->online_vcs, new_vc, list);
1962         /* Change the vcore map */
1963         __seq_start_write(&p->procinfo->coremap_seqctr);
1964         __unmap_vcore(p, caller_vcoreid);
1965         __map_vcore(p, new_vcoreid, pcoreid);
1966         __seq_end_write(&p->procinfo->coremap_seqctr);
1967         /* Send either a PREEMPT msg or a CHECK_MSGS msg.  If they said to
1968          * enable_my_notif, then all userspace needs is to check messages, not a
1969          * full preemption recovery. */
1970         preempt_msg.ev_type = (enable_my_notif ? EV_CHECK_MSGS : EV_VCORE_PREEMPT);
1971         preempt_msg.ev_arg2 = caller_vcoreid;   /* arg2 is 32 bits */
1972         /* Whenever we send msgs with the proc locked, we need at least 1 online.
1973          * In this case, it's the one we just changed to. */
1974         assert(!TAILQ_EMPTY(&p->online_vcs));
1975         send_kernel_event(p, &preempt_msg, new_vcoreid);
1976         /* So this core knows which vcore is here. (cur_proc and owning_proc are
1977          * already correct): */
1978         pcpui->owning_vcoreid = new_vcoreid;
1979         /* Until we set_curctx, we don't really have a valid current tf.  The stuff
1980          * in that old one is from our previous vcore, not the current
1981          * owning_vcoreid.  This matters for other KMSGS that will run before
1982          * __set_curctx (like __notify). */
1983         pcpui->cur_ctx = 0;
1984         /* Need to send a kmsg to finish.  We can't set_curctx til the __PR is done,
1985          * but we can't spin right here while holding the lock (can't spin while
1986          * waiting on a message, roughly) */
1987         send_kernel_message(pcoreid, __set_curctx, (long)p, (long)new_vcoreid,
1988                             (long)new_vc->nr_preempts_sent, KMSG_ROUTINE);
1989         retval = 0;
1990         /* Fall through to exit */
1991 out_locked:
1992         spin_unlock(&p->proc_lock);
1993         return retval;
1994 }
1995
1996 /* Kernel message handler to start a process's context on this core, when the
1997  * core next considers running a process.  Tightly coupled with __proc_run_m().
1998  * Interrupts are disabled. */
1999 void __startcore(uint32_t srcid, long a0, long a1, long a2)
2000 {
2001         uint32_t vcoreid = (uint32_t)a1;
2002         uint32_t coreid = core_id();
2003         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
2004         struct proc *p_to_run = (struct proc *CT(1))a0;
2005         uint32_t old_nr_preempts_sent = (uint32_t)a2;
2006
2007         assert(p_to_run);
2008         /* Can not be any TF from a process here already */
2009         assert(!pcpui->owning_proc);
2010         /* the sender of the kmsg increfed already for this saved ref to p_to_run */
2011         pcpui->owning_proc = p_to_run;
2012         pcpui->owning_vcoreid = vcoreid;
2013         /* sender increfed again, assuming we'd install to cur_proc.  only do this
2014          * if no one else is there.  this is an optimization, since we expect to
2015          * send these __startcores to idles cores, and this saves a scramble to
2016          * incref when all of the cores restartcore/startcore later.  Keep in sync
2017          * with __proc_give_cores() and __proc_run_m(). */
2018         if (!pcpui->cur_proc) {
2019                 pcpui->cur_proc = p_to_run;     /* install the ref to cur_proc */
2020                 lcr3(p_to_run->env_cr3);        /* load the page tables to match cur_proc */
2021         } else {
2022                 proc_decref(p_to_run);          /* can't install, decref the extra one */
2023         }
2024         /* Note we are not necessarily in the cr3 of p_to_run */
2025         /* Now that we sorted refcnts and know p / which vcore it should be, set up
2026          * pcpui->cur_ctx so that it will run that particular vcore */
2027         __set_curctx_to_vcoreid(p_to_run, vcoreid, old_nr_preempts_sent);
2028 }
2029
2030 /* Kernel message handler to load a proc's vcore context on this core.  Similar
2031  * to __startcore, except it is used when p already controls the core (e.g.
2032  * change_to).  Since the core is already controlled, pcpui such as owning proc,
2033  * vcoreid, and cur_proc are all already set. */
2034 void __set_curctx(uint32_t srcid, long a0, long a1, long a2)
2035 {
2036         struct proc *p = (struct proc*)a0;
2037         uint32_t vcoreid = (uint32_t)a1;
2038         uint32_t old_nr_preempts_sent = (uint32_t)a2;
2039         __set_curctx_to_vcoreid(p, vcoreid, old_nr_preempts_sent);
2040 }
2041
2042 /* Bail out if it's the wrong process, or if they no longer want a notif.  Try
2043  * not to grab locks or write access to anything that isn't per-core in here. */
2044 void __notify(uint32_t srcid, long a0, long a1, long a2)
2045 {
2046         uint32_t vcoreid, coreid = core_id();
2047         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
2048         struct preempt_data *vcpd;
2049         struct proc *p = (struct proc*)a0;
2050
2051         /* Not the right proc */
2052         if (p != pcpui->owning_proc)
2053                 return;
2054         /* the core might be owned, but not have a valid cur_ctx (if we're in the
2055          * process of changing */
2056         if (!pcpui->cur_ctx)
2057                 return;
2058         /* Common cur_ctx sanity checks.  Note cur_ctx could be an _S's scp_ctx */
2059         vcoreid = pcpui->owning_vcoreid;
2060         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
2061         /* for SCPs that haven't (and might never) call vc_event_init, like rtld.
2062          * this is harmless for MCPS to check this */
2063         if (!scp_is_vcctx_ready(vcpd))
2064                 return;
2065         printd("received active notification for proc %d's vcore %d on pcore %d\n",
2066                p->procinfo->pid, vcoreid, coreid);
2067         /* sort signals.  notifs are now masked, like an interrupt gate */
2068         if (vcpd->notif_disabled)
2069                 return;
2070         vcpd->notif_disabled = TRUE;
2071         /* save the old ctx in the uthread slot, build and pop a new one.  Note that
2072          * silly state isn't our business for a notification. */
2073         vcpd->uthread_ctx = *pcpui->cur_ctx;
2074         memset(pcpui->cur_ctx, 0, sizeof(struct user_context));
2075         proc_init_ctx(pcpui->cur_ctx, vcoreid, p->env_entry,
2076                       vcpd->transition_stack, vcpd->vcore_tls_desc);
2077         /* this cur_ctx will get run when the kernel returns / idles */
2078 }
2079
2080 void __preempt(uint32_t srcid, long a0, long a1, long a2)
2081 {
2082         uint32_t vcoreid, coreid = core_id();
2083         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
2084         struct preempt_data *vcpd;
2085         struct proc *p = (struct proc*)a0;
2086
2087         assert(p);
2088         if (p != pcpui->owning_proc) {
2089                 panic("__preempt arrived for a process (%p) that was not owning (%p)!",
2090                       p, pcpui->owning_proc);
2091         }
2092         /* Common cur_ctx sanity checks */
2093         assert(pcpui->cur_ctx);
2094         assert(pcpui->cur_ctx == &pcpui->actual_ctx);
2095         vcoreid = pcpui->owning_vcoreid;
2096         vcpd = &p->procdata->vcore_preempt_data[vcoreid];
2097         printd("[kernel] received __preempt for proc %d's vcore %d on pcore %d\n",
2098                p->procinfo->pid, vcoreid, coreid);
2099         /* if notifs are disabled, the vcore is in vcore context (as far as we're
2100          * concerned), and we save it in the vcore slot. o/w, we save the process's
2101          * cur_ctx in the uthread slot, and it'll appear to the vcore when it comes
2102          * back up the uthread just took a notification. */
2103         if (vcpd->notif_disabled)
2104                 vcpd->vcore_ctx = *pcpui->cur_ctx;
2105         else
2106                 vcpd->uthread_ctx = *pcpui->cur_ctx;
2107         /* Userspace in a preemption handler on another core might be copying FP
2108          * state from memory (VCPD) at the moment, and if so we don't want to
2109          * clobber it.  In this rare case, our current core's FPU state should be
2110          * the same as whatever is in VCPD, so this shouldn't be necessary, but the
2111          * arch-specific save function might do something other than write out
2112          * bit-for-bit the exact same data.  Checking STEALING suffices, since we
2113          * hold the K_LOCK (preventing userspace from starting a fresh STEALING
2114          * phase concurrently). */
2115         if (!(atomic_read(&vcpd->flags) & VC_UTHREAD_STEALING))
2116                 save_vc_fp_state(vcpd);
2117         /* Mark the vcore as preempted and unlock (was locked by the sender). */
2118         atomic_or(&vcpd->flags, VC_PREEMPTED);
2119         atomic_and(&vcpd->flags, ~VC_K_LOCK);
2120         /* either __preempt or proc_yield() ends the preempt phase. */
2121         p->procinfo->vcoremap[vcoreid].preempt_pending = 0;
2122         wmb();  /* make sure everything else hits before we finish the preempt */
2123         /* up the nr_done, which signals the next __startcore for this vc */
2124         p->procinfo->vcoremap[vcoreid].nr_preempts_done++;
2125         /* We won't restart the process later.  current gets cleared later when we
2126          * notice there is no owning_proc and we have nothing to do (smp_idle,
2127          * restartcore, etc) */
2128         clear_owning_proc(coreid);
2129 }
2130
2131 /* Kernel message handler to clean up the core when a process is dying.
2132  * Note this leaves no trace of what was running.
2133  * It's okay if death comes to a core that's already idling and has no current.
2134  * It could happen if a process decref'd before __proc_startcore could incref. */
2135 void __death(uint32_t srcid, long a0, long a1, long a2)
2136 {
2137         uint32_t vcoreid, coreid = core_id();
2138         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
2139         struct proc *p = pcpui->owning_proc;
2140         if (p) {
2141                 vcoreid = pcpui->owning_vcoreid;
2142                 printd("[kernel] death on physical core %d for process %d's vcore %d\n",
2143                        coreid, p->pid, vcoreid);
2144                 /* We won't restart the process later.  current gets cleared later when
2145                  * we notice there is no owning_proc and we have nothing to do
2146                  * (smp_idle, restartcore, etc) */
2147                 clear_owning_proc(coreid);
2148         }
2149 }
2150
2151 /* Kernel message handler, usually sent IMMEDIATE, to shoot down virtual
2152  * addresses from a0 to a1. */
2153 void __tlbshootdown(uint32_t srcid, long a0, long a1, long a2)
2154 {
2155         /* TODO: (TLB) something more intelligent with the range */
2156         tlbflush();
2157 }
2158
2159 void print_allpids(void)
2160 {
2161         void print_proc_state(void *item)
2162         {
2163                 struct proc *p = (struct proc*)item;
2164                 assert(p);
2165                 printk("%8d %-10s %6d\n", p->pid, procstate2str(p->state), p->ppid);
2166         }
2167         printk("     PID STATE      Parent    \n");
2168         printk("------------------------------\n");
2169         spin_lock(&pid_hash_lock);
2170         hash_for_each(pid_hash, print_proc_state);
2171         spin_unlock(&pid_hash_lock);
2172 }
2173
2174 void print_proc_info(pid_t pid)
2175 {
2176         int j = 0;
2177         struct proc *child, *p = pid2proc(pid);
2178         struct vcore *vc_i;
2179         if (!p) {
2180                 printk("Bad PID.\n");
2181                 return;
2182         }
2183         spinlock_debug(&p->proc_lock);
2184         //spin_lock(&p->proc_lock); // No locking!!
2185         printk("struct proc: %p\n", p);
2186         printk("PID: %d\n", p->pid);
2187         printk("PPID: %d\n", p->ppid);
2188         printk("State: %s (%p)\n", procstate2str(p->state), p->state);
2189         printk("Refcnt: %d\n", atomic_read(&p->p_kref.refcount) - 1);
2190         printk("Flags: 0x%08x\n", p->env_flags);
2191         printk("CR3(phys): %p\n", p->env_cr3);
2192         printk("Num Vcores: %d\n", p->procinfo->num_vcores);
2193         printk("Vcore Lists (may be in flux w/o locking):\n----------------------\n");
2194         printk("Online:\n");
2195         TAILQ_FOREACH(vc_i, &p->online_vcs, list)
2196                 printk("\tVcore %d -> Pcore %d\n", vcore2vcoreid(p, vc_i), vc_i->pcoreid);
2197         printk("Bulk Preempted:\n");
2198         TAILQ_FOREACH(vc_i, &p->bulk_preempted_vcs, list)
2199                 printk("\tVcore %d\n", vcore2vcoreid(p, vc_i));
2200         printk("Inactive / Yielded:\n");
2201         TAILQ_FOREACH(vc_i, &p->inactive_vcs, list)
2202                 printk("\tVcore %d\n", vcore2vcoreid(p, vc_i));
2203         printk("Resources:\n------------------------\n");
2204         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
2205                 printk("\tRes type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
2206                        p->procdata->res_req[i].amt_wanted, p->procinfo->res_grant[i]);
2207         printk("Open Files:\n");
2208         struct files_struct *files = &p->open_files;
2209         spin_lock(&files->lock);
2210         for (int i = 0; i < files->max_files; i++)
2211                 if (files->fd[i].fd_file) {
2212                         printk("\tFD: %02d, File: %p, File name: %s\n", i,
2213                                files->fd[i].fd_file, file_name(files->fd[i].fd_file));
2214                 }
2215         spin_unlock(&files->lock);
2216         print_9ns_files(p);
2217         printk("Children: (PID (struct proc *))\n");
2218         TAILQ_FOREACH(child, &p->children, sibling_link)
2219                 printk("\t%d (%p)\n", child->pid, child);
2220         /* no locking / unlocking or refcnting */
2221         // spin_unlock(&p->proc_lock);
2222         proc_decref(p);
2223 }
2224
2225 /* Debugging function, checks what (process, vcore) is supposed to run on this
2226  * pcore.  Meant to be called from smp_idle() before halting. */
2227 void check_my_owner(void)
2228 {
2229         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
2230         void shazbot(void *item)
2231         {
2232                 struct proc *p = (struct proc*)item;
2233                 struct vcore *vc_i;
2234                 assert(p);
2235                 spin_lock(&p->proc_lock);
2236                 TAILQ_FOREACH(vc_i, &p->online_vcs, list) {
2237                         /* this isn't true, a __startcore could be on the way and we're
2238                          * already "online" */
2239                         if (vc_i->pcoreid == core_id()) {
2240                                 /* Immediate message was sent, we should get it when we enable
2241                                  * interrupts, which should cause us to skip cpu_halt() */
2242                                 if (!STAILQ_EMPTY(&pcpui->immed_amsgs))
2243                                         continue;
2244                                 printk("Owned pcore (%d) has no owner, by %p, vc %d!\n",
2245                                        core_id(), p, vcore2vcoreid(p, vc_i));
2246                                 spin_unlock(&p->proc_lock);
2247                                 spin_unlock(&pid_hash_lock);
2248                                 monitor(0);
2249                         }
2250                 }
2251                 spin_unlock(&p->proc_lock);
2252         }
2253         assert(!irq_is_enabled());
2254         extern int booting;
2255         if (!booting && !pcpui->owning_proc) {
2256                 spin_lock(&pid_hash_lock);
2257                 hash_for_each(pid_hash, shazbot);
2258                 spin_unlock(&pid_hash_lock);
2259         }
2260 }
2261
2262 /* Use this via kfunc */
2263 void print_9ns(void)
2264 {
2265         void print_proc_9ns(void *item)
2266         {
2267                 struct proc *p = (struct proc*)item;
2268                 print_9ns_files(p);
2269         }
2270         spin_lock(&pid_hash_lock);
2271         hash_for_each(pid_hash, print_proc_9ns);
2272         spin_unlock(&pid_hash_lock);
2273 }