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