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