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