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