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