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