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