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