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