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