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