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