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