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