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