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