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