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