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