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