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