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