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