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