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