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