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