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